1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
/**
* 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.
* <p>
* Using centralized quirk identifier enables us to
* locate code dealing w/ it and hence eases it's maintenance.
* </p>
* <p>
* <i>Some</i> <code>GL_VENDOR</code> and <code>GL_RENDERER</code> strings are
* listed here <http://feedback.wildfiregames.com/report/opengl/feature/GL_VENDOR>.
* </p>
*/
public class GLRendererQuirks {
/**
* Crashes XServer when using double buffered PBuffer with GL_RENDERER:
* <ul>
* <li>Mesa DRI Intel(R) Sandybridge Desktop</li>
* <li>Mesa DRI Intel(R) Ivybridge Mobile - 3.0 Mesa 8.0.4</li>
* <li>Gallium 0.4 on AMD CYPRESS</li>
* </ul>
* 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 <code>discard</code> command leads to undefined behavior or won't get compiled if being used. Appears to <i>have</i> 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.
* <p>
* 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.
* </p>
* The above has been confirmed for the following Mesa 9.* GL_RENDERER strings:
* <ul>
* <li>Mesa .* Intel(R) Sandybridge Desktop</li>
* <li>Gallium 0.4 on AMD RS880</li>
* </ul>
* </p>
* <p>
* 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 <code>glFlush()</code> before releasing it, otherwise driver may freeze:
* <ul>
* <li>OSX < 10.7.3 - NVidia Driver. Bug 533 and Bug 548 @ https://jogamp.org/bugzilla/.</li>
* </ul>
*/
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.
* <p>
* 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.
* </p>
* <p>
* Drivers known exposing such bug:
* <ul>
* <li>Mesa < 8.0 _with_ X11 software renderer <code>Mesa X11</code>, not with GLX/DRI renderer.</li>
* <li>ATI proprietary Catalyst X11 driver versions:
* <ul>
* <li>8.78.6</li>
* <li>8.881</li>
* <li>8.911</li>
* <li>9.01.8</li>
* </ul></li>
* </ul>
* </p>
* <p>
* See Bug 515 - https://jogamp.org/bugzilla/show_bug.cgi?id=515
* and {@link jogamp.nativewindow.x11.X11Util#ATI_HAS_XCLOSEDISPLAY_BUG}.
* </p>
* <p>
* See Bug 705 - https://jogamp.org/bugzilla/show_bug.cgi?id=705
* </p>
*/
public static final int DontCloseX11Display = 8;
/**
* Need current GL Context when calling new ARB <i>pixel format query</i> functions,
* otherwise driver crashes the VM.
* <p>
* Drivers known exposing such bug:
* <ul>
* <li>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.</li>
* </ul>
* <p>
* See Bug 480 - https://jogamp.org/bugzilla/show_bug.cgi?id=480
* </p>
*/
public static final int NeedCurrCtx4ARBPixFmtQueries = 9;
/**
* Need current GL Context when calling new ARB <i>CreateContext</i> function,
* otherwise driver crashes the VM.
* <p>
* Drivers known exposing such bug:
* <ul>
* <li>ATI proprietary Catalyst Windows driver on laptops with a driver version as reported in <i>GL_VERSION</i>:
* <ul>
* <li> <i>null</i> </li>
* <li> < <code>12.102.3.0</code> ( <i>amd_catalyst_13.5_mobility_beta2</i> ) </li>
* </ul></li>
* </ul>
* </p>
* <p>
* See Bug 706 - https://jogamp.org/bugzilla/show_bug.cgi?id=706<br/>
* See Bug 520 - https://jogamp.org/bugzilla/show_bug.cgi?id=520
* </p>
*/
public static final int NeedCurrCtx4ARBCreateContext = 10;
/**
* No full FBO support, i.e. not compliant w/
* <ul>
* <li>GL_ARB_framebuffer_object</li>
* <li>EXT_framebuffer_object</li>
* <li>EXT_framebuffer_multisample</li>
* <li>EXT_framebuffer_blit</li>
* <li>EXT_packed_depth_stencil</li>
* </ul>.
* Drivers known exposing such bug:
* <ul>
* <li>Mesa <i>7.12-devel</i> on Windows with VMware <i>SVGA3D</i> renderer:
* <ul>
* <li>GL_VERSION: <i>2.1 Mesa 7.12-devel (git-d6c318e)</i> </li>
* <li>GL_RENDERER: <i>Gallium 0.4 on SVGA3D; build: RELEASE;</i> </li>
* </ul></li>
* </ul>
* Quirk can also be enabled via property: <code>jogl.fbo.force.min</code>.
*/
public static final int NoFullFBOSupport = 11;
/**
* GLSL is not compliant or even not stable (crash)
* <ul>
* <li>OSX < 10.7.0 (?) - NVidia Driver. Bug 818 @ https://jogamp.org/bugzilla/.</li>
* </ul>
*/
public static final int GLSLNonCompliant = 12;
/** Number of quirks known. */
public static final int COUNT = 13;
private static final String[] _names = new String[] { "NoDoubleBufferedPBuffer", "NoDoubleBufferedBitmap", "NoSetSwapInterval",
"NoOffscreenBitmap", "NoSetSwapIntervalPostRetarget", "GLSLBuggyDiscard",
"GLNonCompliant", "GLFlushBeforeRelease", "DontCloseX11Display",
"NeedCurrCtx4ARBPixFmtQueries", "NeedCurrCtx4ARBCreateContext",
"NoFullFBOSupport", "GLSLNonCompliant"
};
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<offset+len; i++) {
final int quirk = quirks[i];
validateQuirk(quirk);
bitmask |= 1 << quirk;
}
_bitmask = bitmask;
}
/**
* @param quirks a list of valid quirks
* @throws IllegalArgumentException if one of the quirks is out of range
*/
public GLRendererQuirks(List<Integer> quirks) throws IllegalArgumentException {
int bitmask = 0;
for(int i=0; i<quirks.size(); i++) {
final int quirk = quirks.get(i);
validateQuirk(quirk);
bitmask |= 1 << quirk;
}
_bitmask = bitmask;
}
/**
* @param quirk the quirk to be tested
* @return true if quirk exist, otherwise false
* @throws IllegalArgumentException if quirk is out of range
*/
public final boolean exist(int quirk) throws IllegalArgumentException {
validateQuirk(quirk);
return 0 != ( ( 1 << quirk ) & _bitmask );
}
public final StringBuilder toString(StringBuilder sb) {
if(null == sb) {
sb = new StringBuilder();
}
sb.append("[");
boolean first=true;
for(int i=0; i<COUNT; i++) {
final int testmask = 1 << i;
if( 0 != ( _bitmask & testmask ) ) {
if(!first) { sb.append(", "); }
sb.append(toString(i));
first=false;
}
}
sb.append("]");
return sb;
}
public final String toString() {
return toString(null).toString();
}
/**
* @param quirk the quirk to be validated, i.e. whether it is out of range
* @throws IllegalArgumentException if quirk is out of range
*/
public static void validateQuirk(int quirk) throws IllegalArgumentException {
if( !( 0 <= quirk && quirk < COUNT ) ) {
throw new IllegalArgumentException("Quirks must be in range [0.."+COUNT+"[, but quirk: "+quirk);
}
}
/**
* @param quirk the quirk to be converted to String
* @return the String equivalent of this quirk
* @throws IllegalArgumentException if quirk is out of range
*/
public static final String toString(int quirk) throws IllegalArgumentException {
validateQuirk(quirk);
return _names[quirk];
}
}
|