com.jogamp.opengl.GLRendererQuirks Maven / Gradle / Ivy
Show all versions of jogl-all Show documentation
/**
* Copyright 2012 JogAmp Community. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are those of the
* authors and should not be interpreted as representing official policies, either expressed
* or implied, of JogAmp Community.
*/
package com.jogamp.opengl;
import java.util.List;
/**
* GLRendererQuirks contains information of known bugs of various GL renderer.
* This information allows us to workaround them.
*
* Using centralized quirk identifier enables us to
* locate code dealing w/ it and hence eases it's maintenance.
*
*
* Some GL_VENDOR and GL_RENDERER strings are
* listed here .
*
*/
public class GLRendererQuirks {
/**
* Crashes XServer when using double buffered PBuffer with GL_RENDERER:
*
* - Mesa DRI Intel(R) Sandybridge Desktop
* - Mesa DRI Intel(R) Ivybridge Mobile - 3.0 Mesa 8.0.4
* - Gallium 0.4 on AMD CYPRESS
*
* For now, it is safe to disable it w/ hw-acceleration.
*/
public static final int NoDoubleBufferedPBuffer = 0;
/** On Windows no double buffered bitmaps are guaranteed to be available. */
public static final int NoDoubleBufferedBitmap = 1;
/** Crashes application when trying to set EGL swap interval on Android 4.0.3 / Pandaboard ES / PowerVR SGX 540 */
public static final int NoSetSwapInterval = 2;
/** No offscreen bitmap available, currently true for JOGL's OSX implementation. */
public static final int NoOffscreenBitmap = 3;
/** SIGSEGV on setSwapInterval() after changing the context's drawable w/ 'Mesa 8.0.4' dri2SetSwapInterval/DRI2 (soft & intel) */
public static final int NoSetSwapIntervalPostRetarget = 4;
/** GLSL discard command leads to undefined behavior or won't get compiled if being used. Appears to have happened on Nvidia Tegra2, but seems to be fine now. FIXME: Constrain version. */
public static final int GLSLBuggyDiscard = 5;
/**
* Non compliant GL context due to a buggy implementation not suitable for use.
*
* Currently, Mesa >= 9.1.3 (may extend back as far as 9.0) OpenGL 3.1 compatibility
* context is not compliant. Most programs will give completely broken output (or no
* output at all. For now, this context is not trusted.
*
* The above has been confirmed for the following Mesa 9.* GL_RENDERER strings:
*
* - Mesa .* Intel(R) Sandybridge Desktop
* - Gallium 0.4 on AMD RS880
*
*
*
* It still has to be verified whether the AMD OpenGL 3.1 core driver is compliant enought.
*/
public static final int GLNonCompliant = 6;
/**
* The OpenGL Context needs a glFlush() before releasing it, otherwise driver may freeze:
*
* - OSX < 10.7.3 - NVidia Driver. Bug 533 and Bug 548 @ https://jogamp.org/bugzilla/.
*
*/
public static final int GLFlushBeforeRelease = 7;
/**
* Closing X11 displays may cause JVM crashes or X11 errors with some buggy drivers
* while being used in concert w/ OpenGL.
*
* Some drivers may require X11 displays to be closed in the same order as they were created,
* some may not allow them to be closed at all while resources are being used somehow.
*
*
* Drivers known exposing such bug:
*
* - Mesa < 8.0 _with_ X11 software renderer
Mesa X11, not with GLX/DRI renderer.
* - ATI proprietary Catalyst X11 driver versions:
*
* - 8.78.6
* - 8.881
* - 8.911
* - 9.01.8
*
*
*
*
* See Bug 515 - https://jogamp.org/bugzilla/show_bug.cgi?id=515
* and {@link jogamp.nativewindow.x11.X11Util#ATI_HAS_XCLOSEDISPLAY_BUG}.
*
*
* See Bug 705 - https://jogamp.org/bugzilla/show_bug.cgi?id=705
*
*/
public static final int DontCloseX11Display = 8;
/**
* Need current GL Context when calling new ARB pixel format query functions,
* otherwise driver crashes the VM.
*
* Drivers known exposing such bug:
*
* - ATI proprietary Catalyst driver on Windows version ≤ XP.
* TODO: Validate if bug actually relates to 'old' ATI Windows drivers for old GPU's like X300
* regardless of the Windows version.
*
*
* See Bug 480 - https://jogamp.org/bugzilla/show_bug.cgi?id=480
*
*/
public static final int NeedCurrCtx4ARBPixFmtQueries = 9;
/**
* Need current GL Context when calling new ARB CreateContext function,
* otherwise driver crashes the VM.
*
* Drivers known exposing such bug:
*
* - ATI proprietary Catalyst Windows driver on laptops with a driver version as reported in GL_VERSION:
*
* - null
* - <
12.102.3.0 ( amd_catalyst_13.5_mobility_beta2 )
*
*
*
*
* See Bug 706 - https://jogamp.org/bugzilla/show_bug.cgi?id=706
* See Bug 520 - https://jogamp.org/bugzilla/show_bug.cgi?id=520
*
*/
public static final int NeedCurrCtx4ARBCreateContext = 10;
/**
* No full FBO support, i.e. not compliant w/
*
* - GL_ARB_framebuffer_object
* - EXT_framebuffer_object
* - EXT_framebuffer_multisample
* - EXT_framebuffer_blit
* - EXT_packed_depth_stencil
*
.
* Drivers known exposing such bug:
*
* - Mesa 7.12-devel on Windows with VMware SVGA3D renderer:
*
* - GL_VERSION: 2.1 Mesa 7.12-devel (git-d6c318e)
* - GL_RENDERER: Gallium 0.4 on SVGA3D; build: RELEASE;
*
*
* Quirk can also be enabled via property: jogl.fbo.force.min.
*/
public static final int NoFullFBOSupport = 11;
/** Number of quirks known. */
public static final int COUNT = 12;
private static final String[] _names = new String[] { "NoDoubleBufferedPBuffer", "NoDoubleBufferedBitmap", "NoSetSwapInterval",
"NoOffscreenBitmap", "NoSetSwapIntervalPostRetarget", "GLSLBuggyDiscard",
"GLNonCompliant", "GLFlushBeforeRelease", "DontCloseX11Display",
"NeedCurrCtx4ARBPixFmtQueries", "NeedCurrCtx4ARBCreateContext",
"NoFullFBOSupport"
};
private final int _bitmask;
/**
* @param quirks an array of valid quirks
* @param offset offset in quirks array to start reading
* @param len number of quirks to read from offset within quirks array
* @throws IllegalArgumentException if one of the quirks is out of range
*/
public GLRendererQuirks(int[] quirks, int offset, int len) throws IllegalArgumentException {
int bitmask = 0;
if( !( 0 <= offset + len && offset + len < quirks.length ) ) {
throw new IllegalArgumentException("offset and len out of bounds: offset "+offset+", len "+len+", array-len "+quirks.length);
}
for(int i=offset; i quirks) throws IllegalArgumentException {
int bitmask = 0;
for(int i=0; i