|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GLAutoDrawable
A higher-level abstraction than 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 NativeWindow
is become visible.
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 NativeWindow
.
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 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 choosen 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.
However, to not introduce to much 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
Field Summary | |
---|---|
static boolean |
SCREEN_CHANGE_ACTION_ENABLED
Flag reflecting wheather the drawable reconfiguration will be issued in case a screen device change occured, e.g. |
Method Summary | |
---|---|
void |
addGLEventListener(GLEventListener listener)
Adds a GLEventListener to this drawable. |
void |
destroy()
Destroys all resources associated with this GLAutoDrawable, inclusive the GLContext. |
void |
display()
Causes OpenGL rendering to be performed for this GLAutoDrawable by calling display(..) for all
registered GLEventListener s. |
boolean |
getAutoSwapBufferMode()
Indicates whether automatic buffer swapping is enabled for this drawable. |
GLContext |
getContext()
Returns the context associated with this drawable. |
GL |
getGL()
Returns the GL pipeline object this GLAutoDrawable uses. |
void |
removeGLEventListener(GLEventListener listener)
Removes a GLEventListener from this drawable. |
void |
setAutoSwapBufferMode(boolean onOrOff)
Enables or disables automatic buffer swapping for this drawable. |
void |
setContext(GLContext context)
Associate a new context to this drawable. |
GL |
setGL(GL gl)
Sets the GL pipeline object this GLAutoDrawable uses. |
Methods inherited from interface javax.media.opengl.GLDrawable |
---|
createContext, getChosenGLCapabilities, getFactory, getGLProfile, getHeight, getNativeWindow, getWidth, setRealized, swapBuffers, toString |
Field Detail |
---|
static final boolean SCREEN_CHANGE_ACTION_ENABLED
Method Detail |
---|
GLContext getContext()
void setContext(GLContext context)
void addGLEventListener(GLEventListener listener)
GLEventListener
to this drawable. If multiple
listeners are added to a given drawable, they are notified of
events in an arbitrary order.
void 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.
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()
display(..)
for all
registered GLEventListener
s. Called automatically by the
window system toolkit upon receiving a repaint() request. this
routine may 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 onOrOff)
GLDrawable.swapBuffers(..)
manually.
boolean getAutoSwapBufferMode()
setAutoSwapBufferMode(boolean)
.
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |