/* * 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 * MICROSYSTEMS, 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 javax.media.opengl; // FIXME: We need some way to tell when the device upon which the canvas is // being displayed has changed (e.g., the user drags the canvas's parent // window from one screen on multi-screen environment to another, when the // user changes the display bit depth or screen resolution, etc). When this // occurs, we need the canvas to reset the gl function pointer tables for the // canvas, because the new device may have different capabilities (e.g., // doesn't support as many opengl extensions) from the original device. This // hook would also be useful in other GLDrawables (for example, offscreen // buffers such as pbuffers, whose contents may or may not be invalidated when // the display mode changes, depending on the vendor's GL implementation). // // Right now I'm not sure how hook into when this change occurs. There isn't // any AWT event corresponding to a device change (as far as I can // tell). We could constantly check the GraphicsConfiguration of the canvas's top-level // parent to see if it has changed, but this would be very slow (we'd have to // do it every time the context is made current). There has got to be a better // solution, but I'm not sure what it is. // FIXME: Subclasses need to call resetGLFunctionAvailability() on their // context whenever the displayChanged() function is called on our // GLEventListeners /** An abstraction for an OpenGL rendering target. A GLDrawable's primary functionality is to create OpenGL contexts which can be used to perform rendering. A GLDrawable does not automatically create an OpenGL context, but all implementations of {@link GLAutoDrawable} do so upon creation. */ public interface GLDrawable { /** * Creates a new context for drawing to this drawable that will * optionally share display lists and other server-side OpenGL * objects with the specified GLContext.
*
* The GLContext share
need not be associated with this
* GLDrawable and may be null if sharing of display lists and other
* objects is not desired. See the note in the overview
* documentation on
* context sharing.
*/
public GLContext createContext(GLContext shareWith);
/**
* Indicates to on-screen GLDrawable implementations whether the
* underlying window has been created and can be drawn into. This
* method must be called from GLDrawables obtained from the
* GLDrawableFactory via the {@link GLDrawableFactory#getGLDrawable
* GLDrawableFactory.getGLDrawable()} method. It must typically be
* called with an argument of true
in the
* addNotify
method of components performing OpenGL
* rendering and with an argument of false
in the
* removeNotify
method. Calling this method has no
* other effects. For example, if removeNotify
is
* called on a Canvas implementation for which a GLDrawable has been
* created, it is also necessary to destroy all OpenGL contexts
* associated with that GLDrawable. This is not done automatically
* by the implementation. It is not necessary to call
* setRealized
on a GLCanvas, a GLJPanel, or a
* GLPbuffer, as these perform the appropriate calls on their
* underlying GLDrawables internally..
*/
public void setRealized(boolean realized);
/** Requests a new width and height for this GLDrawable. Not all
drawables are able to respond to this request and may silently
ignore it. */
public void setSize(int width, int height);
/** Returns the current width of this GLDrawable. */
public int getWidth();
/** Returns the current height of this GLDrawable. */
public int getHeight();
/** Swaps the front and back buffers of this drawable. For {@link
GLAutoDrawable} implementations, when automatic buffer swapping
is enabled (as is the default), this method is called
automatically and should not be called by the end user. */
public void swapBuffers() throws GLException;
/** Fetches the {@link GLCapabilities} corresponding to the chosen
OpenGL capabilities (pixel format / visual) for this drawable.
Some drawables, in particular on-screen drawables, may be
created lazily; null is returned if the drawable is not
currently created or if its pixel format has not been set yet.
On some platforms, the pixel format is not directly associated
with the drawable; a best attempt is made to return a reasonable
value in this case. */
public GLCapabilities getChosenGLCapabilities();
}
href='#n63'>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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
<?xml version="1.0" encoding="UTF-8"?>
<project name="JOGLTest" basedir="." default="all">
<description>JUNIT Tests JOGL</description>
<import file="build-common.xml"/>
<taskdef resource="net/sf/antcontrib/antlib.xml">
<classpath> <pathelement location="${ant-contrib.jar}"/> </classpath>
</taskdef>
<!-- ================================================================== -->
<!--
- Declare all paths and user defined variables.
-->
<target name="declare.common" description="Declare properties" depends="common.init">
<property name="rootrel.src.test" value="src/test" />
<property name="src.test" value="${project.root}/${rootrel.src.test}" />
<property name="classes" value="${build.test}/classes" />
<property name="classes.path" location="${classes}"/> <!-- absolute path -->
<property name="java.part.test" value="com/jogamp/** jogamp/**"/>
<property name="java.dir.test" value="com/jogamp/opengl/test"/>
<property name="java.dir.junit" value="${java.dir.test}/junit"/>
<property name="java.dir.bugs" value="${java.dir.test}/bugs"/>
<property name="test.archive.name" value="${archive.name}-test-results-${build.node.name}"/>
<condition property="jvmarg.mainthrd" value="-XstartOnFirstThread"><isset property="isOSX"/></condition>
<condition property="jvmarg.mainthrd" value="-Ddummy"><not><isset property="isOSX"/></not></condition>
<condition property="jvmarg.headless" value="-XstartOnFirstThread -Djava.awt.headless=true"><isset property="isOSX"/></condition>
<condition property="jvmarg.headless" value="-Djava.awt.headless=true"><not><isset property="isOSX"/></not></condition>
<property name="batchtest.timeout" value="1800000"/> <!-- 30 min -->
</target>
<!-- ================================================================== -->
<!--
- Clean up all that is built.
-->
<target name="clean" description="Remove all build products" depends="declare.common">
<delete includeEmptyDirs="true" quiet="true">
<fileset dir="${build.test}" />
<fileset dir="." includes="*.tga" />
<fileset file="${jogl.test.jar}" />
</delete>
</target>
<!-- ================================================================== -->
<!--
- Build/run tests/junit.
-->
<target name="test.compile.check" depends="declare.common">
<!-- Create the required output directories. -->
<mkdir dir="${obj.test}" />
<mkdir dir="${classes}" />
<property name="jogl.test.jar.path" location="${jogl.test.jar}"/> <!-- absolute path -->
<echo message="jogl.test.jar ${jogl.test.jar.path}"/>
<uptodate property="test.compile.skip">
<srcfiles dir= "." includes="*.xml"/>
<srcfiles dir= "${src.test}" includes="**"/>
<srcfiles file="${gluegen.jar}" />
<srcfiles dir="${src}/nativewindow" />
<srcfiles dir="${src}/jogl" />
<srcfiles dir="${src}/newt" />
<mapper type="merge" to="${jogl.test.jar.path}"/>
</uptodate>
</target>
<target name="test.compile" depends="test.compile.check" unless="test.compile.skip">
<!-- Perform the junit pass Java compile -->
<javac destdir="${classes}"
source="${host.sourcelevel}"
fork="yes"
memoryMaximumSize="${javac.memorymax}"
includeAntRuntime="false"
debug="${javacdebug}" debuglevel="${javacdebuglevel}">
<classpath refid="junit_jogl_newt_android.compile.classpath"/>
<src path="${src.test}" />
</javac>
<!-- include any resource files that tests may require -->
<copy todir="${classes}">
<fileset dir="${src.test}">
<exclude name="**/*.java"/>
</fileset>
</copy>
<jar destfile="${jogl.test.jar}" filesonly="true">
<!-- get all class files, but skip any resource files that external tools
might have copied into the class directory (otherwise, it's possible
to get the same resource file twice in the jar) -->
<fileset dir="${classes}"
includes="${java.part.test}"/>
</jar>
</target>
<target name="test.manual.run" depends="test.compile">
<for param="test.class.path.m" keepgoing="true">
<!-- results in absolute path -->
<fileset dir="${classes}">
<include name="${java.dir.bugs}/**/*Test*"/>
<exclude name="**/*$$*"/>
</fileset>
<sequential>
<var name="test.class.path" unset="true"/>
<property name="test.class.path" basedir="${classes}" relative="true" location="@{test.class.path.m}"/>
<var name="test.class.fqn" unset="true"/>
<pathconvert property="test.class.fqn">
<fileset file="${classes}${file.separator}${test.class.path}"/>
<chainedmapper>
<globmapper from="${classes.path}${file.separator}*" to="*"/> <!-- rel. -->
<packagemapper from="*.class" to="*"/> <!-- FQCN -->
</chainedmapper>
</pathconvert>
<var name="test.class.result.file" value="${results.test}/TEST-${test.class.fqn}.log"/>
<echo message="Testing ${test.class.fqn} -- ${test.class.result.file}"/>
<apply dir="." executable="${java.home}/bin/java"
parallel="false"
timeout="${batchtest.timeout}"
vmlauncher="false"
relative="true"
failonerror="false"
output="${test.class.result.file}">
<env key="${system.env.library.path}" path="${obj.all.paths}"/>
<env key="CLASSPATH" value="${junit_jogl_awt.run.jars}"/>
<arg line="${jvmDataModel.arg}"/>
<arg value="-Djava.library.path=${obj.all.paths}"/>
<!--
<arg line="-Dnewt.debug.EDT"/>
-->
<srcfile/>
<mappedresources>
<fileset dir="${classes}" includes="${test.class.path}"/>
<packagemapper from="*.class" to="*"/>
</mappedresources>
</apply>
</sequential>
</for>
<antcall target="test-zip-archive" inheritRefs="true" inheritAll="true"/>
</target>
<target name="junit.run.noui" depends="test.compile">
<!-- Test*NOUI* -->
<junit forkmode="perTest" showoutput="true" fork="true" haltonerror="off" timeout="${batchtest.timeout}">
<env key="${system.env.library.path}" path="${obj.all.paths}"/>
<jvmarg value="${jvmDataModel.arg}"/>
<jvmarg value="-Djava.library.path=${obj.all.paths}"/>
<!--
<jvmarg value="-Djogl.debug=all"/>
<jvmarg value="-Dgluegen.debug.NativeLibrary=true"/>
<jvmarg value="-Dgluegen.debug.ProcAddressHelper=true"/>
<jvmarg value="-Djogl.debug.GLSLState"/>
<jvmarg value="-Dnativewindow.debug=all"/>
<jvmarg value="-verbose:jni"/>
<jvmarg value="-client"/>
<jvmarg value="-d32"/>
-->
<formatter usefile="false" type="plain"/>
<formatter usefile="true" type="xml"/>
<classpath refid="junit_jogl_awt.run.classpath"/>
<batchtest todir="${results.test}">
<fileset dir="${classes}">
<include name="${java.dir.junit}/**/Test*NOUI*"/>
<exclude name="**/*$$*"/>
</fileset>
<formatter usefile="false" type="brief"/>
<formatter usefile="true" type="xml"/>
</batchtest>
</junit>
</target>
<target name="junit.run.newt.headless" depends="test.compile">
<!-- Test*NEWT*
Emulation of junit task,
due to the fact that we have to place invoke our MainThread class first (-> MacOSX).
Utilizing Ant-1.8.0 and ant-contrib-1.0b3 (loops, mutable properties).
-->
<for param="test.class.path.m" keepgoing="true">
<!-- results in absolute path -->
<fileset dir="${classes}">
<include name="${java.dir.junit}/**/Test*NEWT*"/>
<exclude name="**/*$$*"/>
</fileset>
<sequential>
<var name="test.class.path" unset="true"/>
<property name="test.class.path" basedir="${classes}" relative="true" location="@{test.class.path.m}"/>
<var name="test.class.fqn" unset="true"/>
<pathconvert property="test.class.fqn">
<fileset file="${classes}${file.separator}${test.class.path}"/>
<chainedmapper>
<globmapper from="${classes.path}${file.separator}*" to="*"/> <!-- rel. -->
<packagemapper from="*.class" to="*"/> <!-- FQCN -->
</chainedmapper>
</pathconvert>
<var name="test.class.result.file" value="${results.test}/TEST-${test.class.fqn}.xml"/>
<echo message="Testing ${test.class.fqn} -- ${test.class.result.file}"/>
<apply dir="." executable="${java.home}/bin/java"
parallel="false"
timeout="${batchtest.timeout}"
vmlauncher="false"
relative="true"
failonerror="false">
<env key="${system.env.library.path}" path="${obj.all.paths}"/>
<env key="CLASSPATH" value="${junit_jogl_noawt.run.jars}"/>
<arg line="${jvmDataModel.arg}"/>
<arg value="-Djava.library.path=${obj.all.paths}"/>
<arg line="${jvmarg.headless}"/>
<!--
<arg line="-Dnewt.debug.EDT"/>
-->
<arg line="com.jogamp.newt.util.MainThread"/>
<arg line="org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner"/>
<srcfile/>
<arg line="filtertrace=true"/>
<arg line="haltOnError=false"/>
<arg line="haltOnFailure=false"/>
<arg line="showoutput=true"/>
<arg line="outputtoformatters=true"/>
<arg line="logfailedtests=true"/>
<arg line="logtestlistenerevents=true"/>
<arg line="formatter=org.apache.tools.ant.taskdefs.optional.junit.PlainJUnitResultFormatter"/>
<arg line="formatter=org.apache.tools.ant.taskdefs.optional.junit.XMLJUnitResultFormatter,${test.class.result.file}"/>
<mappedresources>
<fileset dir="${classes}" includes="${test.class.path}"/>
<packagemapper from="*.class" to="*"/>
</mappedresources>
</apply>
</sequential>
</for>
</target>
<!-- junit.run.newt is covered by junit.run.newt.headless, disable it for now, but may be checked manually.
This test target would also overwrite the test result XML files, we would also need a solution here for hudson,
if run in parallel.
-->
<target name="junit.run.newt" depends="test.compile">
<!-- Test*NEWT* -->
<junit forkmode="perTest" showoutput="true" fork="true" haltonerror="off" timeout="${batchtest.timeout}">
<env key="${system.env.library.path}" path="${obj.all.paths}"/>
<jvmarg value="${jvmDataModel.arg}"/>
<jvmarg value="-Djava.library.path=${obj.all.paths}"/>
<!--
<jvmarg value="-Dnewt.debug.EDT"/>
<jvmarg value="-Djogl.debug=all"/>
<jvmarg value="-Dgluegen.debug.NativeLibrary=true"/>
<jvmarg value="-Dgluegen.debug.ProcAddressHelper=true"/>
<jvmarg value="-Djogl.debug.GLSLState"/>
<jvmarg value="-Dnativewindow.debug=all"/>
<jvmarg value="-Dnewt.debug=all"/>
<jvmarg value="-verbose:jni"/>
<jvmarg value="-client"/>
<jvmarg value="-d32"/>
-->
<formatter usefile="false" type="plain"/>
<formatter usefile="true" type="xml"/>
<classpath refid="junit_jogl_noawt.run.classpath"/>
<batchtest todir="${results.test}">
<fileset dir="${classes}">
<include name="${java.dir.junit}/**/Test*NEWT*"/>
<exclude name="**/*$$*"/>
</fileset>
<formatter usefile="false" type="brief"/>
<formatter usefile="true" type="xml"/>
</batchtest>
</junit>
</target>
<target name="junit.run.awt" depends="test.compile">
<!-- Test*AWT* -->
<junit forkmode="perTest" showoutput="true" fork="true" haltonerror="off" timeout="${batchtest.timeout}">
<env key="${system.env.library.path}" path="${obj.all.paths}"/>
<jvmarg value="${jvmDataModel.arg}"/>
<jvmarg value="-Djava.library.path=${obj.all.paths}"/>
<!--
<jvmarg value="-Djogl.debug=all"/>
<jvmarg value="-Dgluegen.debug.NativeLibrary=true"/>
<jvmarg value="-Dgluegen.debug.ProcAddressHelper=true"/>
<jvmarg value="-Djogl.debug.GLSLState"/>
<jvmarg value="-Dnativewindow.debug=all"/>
<jvmarg value="-verbose:jni"/>
<jvmarg value="-client"/>
<jvmarg value="-d32"/>
-->
<formatter usefile="false" type="plain"/>
<formatter usefile="true" type="xml"/>
<classpath refid="junit_jogl_awt.run.classpath"/>
<batchtest todir="${results.test}">
<fileset dir="${classes}">
<include name="${java.dir.junit}/**/Test*AWT*"/>
<exclude name="**/*$$*"/>
<exclude name="**/*SWT*"/>
<exclude name="**/newt/**"/>
</fileset>
<formatter usefile="false" type="brief"/>
<formatter usefile="true" type="xml"/>
</batchtest>
</junit>
</target>
<target name="junit.run.awt.singletest" depends="test.compile">
<!-- Test*AWT* -->
<junit forkmode="perTest" showoutput="true" fork="true" haltonerror="off" timeout="${batchtest.timeout}">
<env key="${system.env.library.path}" path="${obj.all.paths}"/>
<jvmarg value="${jvmDataModel.arg}"/>
<jvmarg value="-Djava.library.path=${obj.all.paths}"/>
<!--
<jvmarg value="-Djogl.debug=all"/>
<jvmarg value="-Dgluegen.debug.NativeLibrary=true"/>
<jvmarg value="-Dgluegen.debug.ProcAddressHelper=true"/>
<jvmarg value="-Djogl.debug.GLSLState"/>
<jvmarg value="-Dnativewindow.debug=all"/>
<jvmarg value="-verbose:jni"/>
<jvmarg value="-client"/>
<jvmarg value="-d32"/>
-->
<formatter usefile="false" type="plain"/>
<formatter usefile="true" type="xml"/>
<classpath refid="junit_jogl_awt.run.classpath"/>
<test name="${testclass}"/>
</junit>
</target>
<target name="junit.run.swt.headless" depends="test.compile" description="Runs all pure SWT tests." if="isSWTRuntimeAvailable">
<!-- Test*SWT*