public interface GLAutoDrawable extends GLDrawable
GLDrawable
which supplies
an event based mechanism (GLEventListener
) for performing
OpenGL rendering. A GLAutoDrawable automatically creates a primary
rendering context which is associated with the GLAutoDrawable for
the lifetime of the object. This context has the synchronized
property enabled so that
calls to makeCurrent
will block if
the context is current on another thread. This allows the internal
GLContext for the GLAutoDrawable to be used both by the event
based rendering mechanism as well by end users directly.
The implementation shall initialize itself as soon as possible,
ie if the attached NativeSurface
becomes visible/realized.
The following protocol shall be satisfied:
GLDrawable
with the requested GLCapabilities
GLDrawable
to validate the GLCapabilities
by calling setRealized(true)
.GLContext
.init(..)
for all
registered GLEventListener
s. This can be done immediatly, or with the followup display(..)
call.reshape(..)
for all
registered GLEventListener
s. This shall be done after the init(..)
calls.
Another implementation detail is the drawable reconfiguration. One use case is where a window is being
dragged to another screen with a different pixel configuration, ie GLCapabilities
. The implementation
shall be able to detect such cases in conjunction with the associated NativeSurface
.
For example, AWT's Canvas
's getGraphicsConfiguration()
is capable to determine a display device change. This is demonstrated within GLCanvas
's
and NEWT's AWTCanvas
getGraphicsConfiguration()
specialization. Another demonstration is NEWT's NativeWindow
implementation on the Windows platform, which utilizes the native platform's MonitorFromWindow(HWND) function.
All OpenGL resources shall be regenerated, while the drawable's GLCapabilities
has
to be chosen again. The following protocol shall be satisfied.
dispose(..)
for all
registered GLEventListener
s.GLContext
.GLDrawable
of the invalid state by calling setRealized(false)
.GLDrawable
with the requested GLCapabilities
GLDrawable
to revalidate the GLCapabilities
by calling setRealized(true)
.GLContext
.init(..)
for all
registered GLEventListener
s. This can be done immediatly, or with the followup display(..)
call.reshape(..)
for all
registered GLEventListener
s. This shall be done after the init(..)
calls.
Avoiding breakage with older applications and because of the situation
mentioned above, the boolean
system property jogl.screenchange.action
will control the
screen change action as follows:
-Djogl.screenchange.action=false Disable the drawable reconfiguration (the default) -Djogl.screenchange.action=true Enable the drawable reconfiguration
Modifier and Type | Field and Description |
---|---|
static boolean |
SCREEN_CHANGE_ACTION_ENABLED
Flag reflecting wheather the drawable reconfiguration will be issued in
case a screen device change occured, e.g.
|
Modifier and Type | Method and Description |
---|---|
void |
addGLEventListener(GLEventListener listener)
Adds a
GLEventListener to the end of this drawable queue. |
void |
addGLEventListener(int index,
GLEventListener listener)
Adds a
GLEventListener at the given index of this drawable queue. |
GLContext |
createContext(GLContext shareWith)
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.
|
void |
destroy()
Destroys all resources associated with this GLAutoDrawable,
inclusive the GLContext.
|
void |
display()
Causes OpenGL rendering to be performed for this GLAutoDrawable
in the following order:
Calling
display(..) for all
registered GLEventListener s. |
GLAnimatorControl |
getAnimator() |
boolean |
getAutoSwapBufferMode()
Indicates whether automatic buffer swapping is enabled for this
drawable.
|
GLContext |
getContext()
Returns the context associated with this drawable.
|
int |
getContextCreationFlags() |
GL |
getGL()
Returns the
GL pipeline object this GLAutoDrawable uses. |
Object |
getUpstreamWidget()
Method may return the upstream UI toolkit object
holding this
GLAutoDrawable instance, if exist. |
boolean |
invoke(boolean wait,
GLRunnable glRunnable)
Enqueues a one-shot
GLRunnable ,
which will be executed within the next display() call
after all registered GLEventListener s
display(GLAutoDrawable)
methods has been called. |
void |
removeGLEventListener(GLEventListener listener)
Removes a
GLEventListener from this drawable. |
GLEventListener |
removeGLEventListener(int index)
Removes a
GLEventListener at the given index from this drawable. |
void |
setAnimator(GLAnimatorControl animatorControl)
Registers the usage of an animator, an
GLAnimatorControl implementation. |
void |
setAutoSwapBufferMode(boolean enable)
Enables or disables automatic buffer swapping for this drawable.
|
GLContext |
setContext(GLContext newCtx)
Associate a new context to this drawable and also propagates the context/drawable switch by
calling
newCtx.setGLDrawable(drawable, true); . |
void |
setContextCreationFlags(int flags) |
GL |
setGL(GL gl)
Sets the
GL pipeline object this GLAutoDrawable uses. |
getChosenGLCapabilities, getFactory, getGLProfile, getHandle, getHeight, getNativeSurface, getWidth, isRealized, setRealized, swapBuffers, toString
static final boolean SCREEN_CHANGE_ACTION_ENABLED
GLContext getContext()
GLContext setContext(GLContext newCtx)
newCtx.setGLDrawable(drawable, true);
.
drawable
might be an inner GLDrawable instance if using such a delegation pattern,
or this GLAutoDrawable itself.
If the old context's drawable was an GLAutoDrawable
, it's reference to the given drawable
is being cleared by calling
((GLAutoDrawable)oldCtx.getGLDrawable()).setContext(null)
.
If the old or new context was current on this thread, it is being released before switching the drawable. The new context will be made current afterwards, if it was current before. However the user shall take extra care that not other thread attempts to make this context current. Otherwise a race condition may happen.
Disclaimer: Even though the API may allows this functionality in theory, your mileage may vary switching the drawable of an already established GLContext, i.e. which is already made current once. FIXME: Validate functionality!
newCtx
- the new contextnull
GLContext.setGLDrawable(GLDrawable, boolean)
,
GLContext.setGLReadDrawable(GLDrawable)
,
GLDrawableHelper.switchContext(GLDrawable, GLContext, GLContext, int)
void addGLEventListener(GLEventListener listener)
GLEventListener
to the end of this drawable queue.
The listeners are notified of events in the order of the queue.void addGLEventListener(int index, GLEventListener listener) throws IndexOutOfBoundsException
GLEventListener
at the given index of this drawable queue.
The listeners are notified of events in the order of the queue.index
- Position where the listener will be inserted.
Should be within (0 <= index && index <= size()).
An index value of -1 is interpreted as the end of the list, size().listener
- The GLEventListener object to be insertedIndexOutOfBoundsException
- If the index is not within (0 <= index && index <= size()), or -1void removeGLEventListener(GLEventListener listener)
GLEventListener
from this drawable.
Note that if this is done from within a particular drawable's
GLEventListener
handler (reshape, display, etc.) that it is not
guaranteed that all other listeners will be evaluated properly
during this update cycle.listener
- The GLEventListener object to be removedGLEventListener removeGLEventListener(int index) throws IndexOutOfBoundsException
GLEventListener
at the given index from this drawable.
Note that if this is done from within a particular drawable's
GLEventListener
handler (reshape, display, etc.) that it is not
guaranteed that all other listeners will be evaluated properly
during this update cycle.index
- Position of the listener to be removed.
Should be within (0 <= index && index < size()).
An index value of -1 is interpreted as last listener, size()-1.IndexOutOfBoundsException
- If the index is not within (0 <= index && index < size()), or -1void setAnimator(GLAnimatorControl animatorControl) throws GLException
Registers the usage of an animator, an GLAnimatorControl
implementation.
The animator will be queried whether it's animating, ie periodically issuing display()
calls or not.
This method shall be called by an animator implementation only,
e.g. AnimatorBase.add(javax.media.opengl.GLAutoDrawable)
, passing it's control implementation,
and AnimatorBase.remove(javax.media.opengl.GLAutoDrawable)
, passing null
.
Impacts display()
and invoke(boolean, GLRunnable)
semantics.
animator
- null
reference indicates no animator is using
this GLAutoDrawable
,GLAutoDrawable
.GLException
- if an animator is already registered.display()
,
invoke(boolean, GLRunnable)
,
GLAnimatorControl
GLAnimatorControl getAnimator()
GLAnimatorControl
implementation, using this GLAutoDrawable
.setAnimator(javax.media.opengl.GLAnimatorControl)
,
GLAnimatorControl
boolean invoke(boolean wait, GLRunnable glRunnable)
Enqueues a one-shot GLRunnable
,
which will be executed within the next display()
call
after all registered GLEventListener
s
display(GLAutoDrawable)
methods has been called.
If no GLAnimatorControl
is animating (default),
or if the current thread is the animator thread,
a display()
call is issued after enqueue the GLRunnable
.
No extra synchronization is performed in case wait
is true, since it is executed in the current thread.
If an GLAnimatorControl
is animating,
no display()
call is issued, since the animator thread performs it.
If wait
is true
the call blocks until the glRunnable
has been executed.
If wait
is true
and
GLDrawable.isRealized()
returns false
or getContext()
returns null
,
the call is ignored and returns false
.
This helps avoiding deadlocking the caller.
The internal queue of GLRunnable
's is being flushed with destroy()
where all blocked callers are being notified.
wait
- if true
block until execution of glRunnable
is finished, otherwise return immediatly w/o waitingglRunnable
- the GLRunnable
to execute within display()
true
if the GLRunnable
has been processed or queued, otherwise false
.setAnimator(GLAnimatorControl)
,
display()
,
GLRunnable
void destroy()
dispose(..)
for all
registered GLEventListener
s. Called automatically by the
window system toolkit upon receiving a destroy notification. This
routine may be called manually.void display()
Causes OpenGL rendering to be performed for this GLAutoDrawable in the following order:
display(..)
for all
registered GLEventListener
s. GLRunnable
,
enqueued via invoke(boolean, GLRunnable)
.
May be called periodically by a running GLAnimatorControl
implementation,
which must register itself with setAnimator(javax.media.opengl.GLAnimatorControl)
.
Called automatically by the window system toolkit upon receiving a repaint() request,
except an GLAnimatorControl
implementation GLAnimatorControl.isAnimating()
.
This routine may also be called manually for better control over the
rendering process. It is legal to call another GLAutoDrawable's
display method from within the display(..)
callback.
In case of a new generated OpenGL context,
the implementation shall call init(..)
for all
registered GLEventListener
s before making the
actual display(..)
calls,
in case this has not been done yet.
void setAutoSwapBufferMode(boolean enable)
GLDrawable.swapBuffers(..)
manually.boolean getAutoSwapBufferMode()
setAutoSwapBufferMode(boolean)
.void setContextCreationFlags(int flags)
flags
- Additional context creation flags.GLContext.setContextCreationFlags(int)
,
GLContext.enableGLDebugMessage(boolean)
int getContextCreationFlags()
GLContext createContext(GLContext shareWith)
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.
This GLAutoDrawable implementation holds it's own GLContext reference,
thus created a GLContext using this methods won't replace it implicitly.
To replace or set this GLAutoDrawable's GLContext you need to call setContext(GLContext)
.
The GLAutoDrawable implementation shall also set the
context creation flags as customized w/ setContextCreationFlags(int)
.
createContext
in interface GLDrawable
GL getGL()
GL
pipeline object this GLAutoDrawable uses.
If this method is called outside of the GLEventListener
's callback methods (init, display, etc.) it may
return null. Users should not rely on the identity of the
returned GL object; for example, users should not maintain a
hash table with the GL object as the key. Additionally, the GL
object should not be cached in client code, but should be
re-fetched from the GLAutoDrawable at the beginning of each call
to init, display, etc.GL setGL(GL gl)
GL
pipeline object this GLAutoDrawable uses.
This should only be called from within the GLEventListener's
callback methods, and usually only from within the init()
method, in order to install a composable pipeline. See the JOGL
demos for examples.Object getUpstreamWidget()
GLAutoDrawable
instance, if exist.
Currently known Java UI toolkits and it's known return types are:
Toolkit | GLAutoDrawable Implementation | ~ | Return Type of getUpstreamWidget() |
NEWT | GLWindow | has a | Window |
SWT | GLCanvas | is a | Canvas |
AWT | GLCanvas | is a | Canvas |
AWT | GLJPanel | is a | JPanel |
This method may also return null
if no UI toolkit is being used,
as common for offscreen rendering.
Copyright 2010 JogAmp Community.