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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
|
/*
* Copyright (c) 2003 Sun Microsystems, Inc. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* - Redistribution of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistribution 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.
*
* Neither the name of Sun Microsystems, Inc. or the names of
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* This software is provided "AS IS," without a warranty of any kind. ALL
* EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
* INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
* PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
* MIDROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
* ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
* DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
* ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
* DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
* DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
* ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
* SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
*
* You acknowledge that this software is not designed or intended for use
* in the design, construction, operation or maintenance of any nuclear
* facility.
*
* Sun gratefully acknowledges that this software was originally authored
* and developed by Kenneth Bradley Russell and Christopher John Kline.
*/
package net.java.games.jogl.impl.x11;
import java.awt.Component;
import java.util.*;
import net.java.games.gluegen.runtime.*; // for PROCADDRESS_VAR_PREFIX
import net.java.games.jogl.*;
import net.java.games.jogl.impl.*;
public abstract class X11GLContext extends GLContext {
private static JAWT jawt;
protected long display;
protected long drawable;
protected long visualID;
protected long context;
private boolean glXQueryExtensionsStringInitialized;
private boolean glXQueryExtensionsStringAvailable;
private static final Map/*<String, String>*/ functionNameMap;
private boolean isGLX13;
// Table that holds the addresses of the native C-language entry points for
// OpenGL functions.
private GLProcAddressTable glProcAddressTable;
private static boolean haveResetGLXProcAddressTable;
// Cache the most recent value of the "display" variable (which we
// only guarantee to be valid in between makeCurrent / free pairs)
// so that we can implement displayImpl() (which must be done when
// the context is not current)
protected long mostRecentDisplay;
static {
functionNameMap = new HashMap();
functionNameMap.put("glAllocateMemoryNV", "glXAllocateMemoryNV");
functionNameMap.put("glFreeMemoryNV", "glXFreeMemoryNV");
}
public X11GLContext(Component component,
GLCapabilities capabilities,
GLCapabilitiesChooser chooser,
GLContext shareWith) {
super(component, capabilities, chooser, shareWith);
}
protected GL createGL()
{
return new X11GLImpl(this);
}
protected String mapToRealGLFunctionName(String glFunctionName) {
String lookup = (String) functionNameMap.get(glFunctionName);
if (lookup != null) {
return lookup;
}
return glFunctionName;
}
protected String mapToRealGLExtensionName(String glExtensionName) {
return glExtensionName;
}
protected abstract boolean isOffscreen();
public abstract int getOffscreenContextBufferedImageType();
public int getOffscreenContextWidth() {
throw new GLException("Should not call this");
}
public int getOffscreenContextHeight() {
throw new GLException("Should not call this");
}
public int getOffscreenContextPixelDataType() {
throw new GLException("Should not call this");
}
public abstract int getOffscreenContextReadBuffer();
public abstract boolean offscreenImageNeedsVerticalFlip();
public synchronized void setRenderingThread(Thread currentThreadOrNull, Runnable initAction) {
this.willSetRenderingThread = false;
// FIXME: the JAWT on X11 grabs the AWT lock while the
// DrawingSurface is locked, which means that no other events can
// be processed. Currently we handle this by preventing the
// effects of setRenderingThread. We should figure out a better
// solution that is reasonably robust. Must file a bug to be fixed
// in the 1.5 JAWT.
}
/**
* Creates and initializes an appropriate OpenGl context. Should only be
* called by {@link makeCurrent(Runnable)}.
*/
protected abstract void create();
public boolean isExtensionAvailable(String glExtensionName) {
if (glExtensionName.equals("GL_ARB_pbuffer") ||
glExtensionName.equals("GL_ARB_pixel_format")) {
return isGLX13;
}
return super.isExtensionAvailable(glExtensionName);
}
protected synchronized boolean makeCurrent(Runnable initAction) throws GLException {
boolean created = false;
if (context == 0) {
create();
if (DEBUG) {
System.err.println("!!! Created GL context for " + getClass().getName());
}
created = true;
}
if (drawable == 0) {
throw new GLException("Unable to make context current; drawable was null");
}
// FIXME: this cast to int would be wrong on 64-bit platforms
// where the argument type to glXMakeCurrent would change (should
// probably make GLXDrawable, and maybe XID, Opaque as long)
if (!GLX.glXMakeCurrent(display, (int) drawable, context)) {
throw new GLException("Error making context current");
}
if (created) {
resetGLFunctionAvailability();
initAction.run();
}
return true;
}
protected synchronized void free() throws GLException {
if (!GLX.glXMakeCurrent(display, 0, 0)) {
throw new GLException("Error freeing OpenGL context");
}
}
protected void destroyImpl() throws GLException {
if (context != 0) {
GLX.glXDestroyContext(mostRecentDisplay, context);
if (DEBUG) {
System.err.println("!!! Destroyed OpenGL context " + context);
}
context = 0;
}
}
public abstract void swapBuffers() throws GLException;
protected long dynamicLookupFunction(String glFuncName) {
long res = GLX.glXGetProcAddressARB(glFuncName);
if (res == 0) {
// GLU routines aren't known to the OpenGL function lookup
res = GLX.dlsym(glFuncName);
}
return res;
}
public boolean isCreated() {
return (context != 0);
}
protected void resetGLFunctionAvailability() {
super.resetGLFunctionAvailability();
if (DEBUG) {
System.err.println("!!! Initializing OpenGL extension address table");
}
resetProcAddressTable(getGLProcAddressTable());
if (!haveResetGLXProcAddressTable) {
resetProcAddressTable(GLX.getGLXProcAddressTable());
}
// Figure out whether we are running GLX version 1.3 or above and
// therefore have pbuffer support
if (display == 0) {
throw new GLException("Expected non-null DISPLAY for querying GLX version");
}
int[] major = new int[1];
int[] minor = new int[1];
if (!GLX.glXQueryVersion(display, major, minor)) {
throw new GLException("glXQueryVersion failed");
}
isGLX13 = ((major[0] > 1) || (minor[0] > 2));
}
public GLProcAddressTable getGLProcAddressTable() {
if (glProcAddressTable == null) {
// FIXME: cache ProcAddressTables by capability bits so we can
// share them among contexts with the same capabilities
glProcAddressTable = new GLProcAddressTable();
}
return glProcAddressTable;
}
public synchronized String getPlatformExtensionsString() {
if (display == 0) {
throw new GLException("Context not current");
}
if (!glXQueryExtensionsStringInitialized) {
glXQueryExtensionsStringAvailable = (GLX.glXGetProcAddressARB("glXQueryExtensionsString") != 0);
glXQueryExtensionsStringInitialized = true;
}
if (glXQueryExtensionsStringAvailable) {
return GLX.glXQueryExtensionsString(display, GLX.DefaultScreen(display));
} else {
return "";
}
}
protected boolean isFunctionAvailable(String glFunctionName)
{
boolean available = super.isFunctionAvailable(glFunctionName);
// Sanity check for implementations that use proc addresses for run-time
// linking: if the function IS available, then make sure there's a proc
// address for it if it's an extension or not part of the OpenGL 1.1 core
// (post GL 1.1 functions are run-time linked on windows).
assert(!available ||
(getGLProcAddressTable().getAddressFor(mapToRealGLFunctionName(glFunctionName)) != 0 ||
FunctionAvailabilityCache.isPartOfGLCore("1.1", mapToRealGLFunctionName(glFunctionName)))
);
return available;
}
//----------------------------------------------------------------------
// Internals only below this point
//
protected JAWT getJAWT() {
if (jawt == null) {
JAWT j = new JAWT();
j.version(JAWTFactory.JAWT_VERSION_1_4);
if (!JAWTFactory.JAWT_GetAWT(j)) {
throw new RuntimeException("Unable to initialize JAWT");
}
jawt = j;
}
return jawt;
}
protected XVisualInfo chooseVisual() {
if (!isOffscreen()) {
// The visual has already been chosen by the time we get here;
// it's specified by the GraphicsConfiguration of the
// GLCanvas. Fortunately, the JAWT supplies the visual ID for
// the component in a portable fashion, so all we have to do is
// use XGetVisualInfo with a VisualIDMask to get the
// corresponding XVisualInfo to pass into glXChooseVisual.
int[] count = new int[1];
XVisualInfo template = new XVisualInfo();
// FIXME: probably not 64-bit clean
template.visualid((int) visualID);
XVisualInfo[] infos = GLX.XGetVisualInfo(display, GLX.VisualIDMask, template, count);
if (infos == null || infos.length == 0) {
throw new GLException("Error while getting XVisualInfo for visual ID " + visualID);
}
// FIXME: the storage for the infos array is leaked (should
// clean it up somehow when we're done with the visual we're
// returning)
return infos[0];
} else {
// It isn't clear to me whether we need this much code to handle
// the offscreen case, where we're creating a pixmap into which
// to render...this is what we (incorrectly) used to do for the
// onscreen case
int screen = 0; // FIXME: provide way to specify this?
XVisualInfo vis = null;
int[] count = new int[1];
XVisualInfo template = new XVisualInfo();
template.screen(screen);
XVisualInfo[] infos = GLX.XGetVisualInfo(display, GLX.VisualScreenMask, template, count);
if (infos == null) {
throw new GLException("Error while enumerating available XVisualInfos");
}
GLCapabilities[] caps = new GLCapabilities[infos.length];
for (int i = 0; i < infos.length; i++) {
caps[i] = X11GLContextFactory.xvi2GLCapabilities(display, infos[i]);
}
int chosen = chooser.chooseCapabilities(capabilities, caps, -1);
if (chosen < 0 || chosen >= caps.length) {
throw new GLException("GLCapabilitiesChooser specified invalid index (expected 0.." + (caps.length - 1) + ")");
}
if (DEBUG) {
System.err.println("Chosen visual (" + chosen + "):");
System.err.println(caps[chosen]);
}
vis = infos[chosen];
if (vis == null) {
throw new GLException("GLCapabilitiesChooser chose an invalid visual");
}
// FIXME: the storage for the infos array is leaked (should
// clean it up somehow when we're done with the visual we're
// returning)
return vis;
}
}
protected long createContext(XVisualInfo vis, boolean onscreen) {
X11GLContext other = (X11GLContext) GLContextShareSet.getShareContext(this);
long share = 0;
if (other != null) {
share = other.getContext();
if (share == 0) {
throw new GLException("GLContextShareSet returned an invalid OpenGL context");
}
}
long res = GLX.glXCreateContext(display, vis, share, onscreen);
if (res != 0) {
GLContextShareSet.contextCreated(this);
}
return res;
}
// Helper routine for the overridden create() to call
protected void chooseVisualAndCreateContext(boolean onscreen) {
XVisualInfo vis = chooseVisual();
context = createContext(vis, onscreen);
if (context == 0) {
throw new GLException("Unable to create OpenGL context");
}
}
protected long getContext() {
return context;
}
}
|