Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
Canvas
net.java.games.jogl.GLCanvas
GLDrawable
;
GLJPanel
is provided for compatibility with Swing user
interfaces when adding a heavyweight doesn't work either because
of Z-ordering or LayoutManager problems. This class can not be
instantiated directly; use GLDrawableFactory
to construct
them. Field Summary | |
protected static boolean |
Method Summary | |
void |
|
void |
|
boolean |
|
GLPbuffer |
|
void |
|
boolean |
|
GL | |
GLU | |
boolean |
|
Thread |
|
void | |
void |
|
void |
|
void |
|
void |
|
void | |
void | |
void |
|
void |
|
void |
|
void |
|
public void addGLEventListener(GLEventListener listener)
Adds aGLEventListener
to this drawable. If multiple listeners are added to a given drawable, they are notified of events in an arbitrary order.
- Specified by:
- addGLEventListener in interface GLDrawable
public void addNotify()
Overridden from Canvas; used to indicate when it's safe to create an OpenGL context for the component.
public boolean canCreateOffscreenDrawable()
Indicates whether this drawable is capable of fabricating a subordinate offscreen drawable for advanced rendering techniques which require offscreen hardware-accelerated surfaces. Note that this method is only guaranteed to return a correct result once your GLEventListener's init() method has been called.
- Specified by:
- canCreateOffscreenDrawable in interface GLDrawable
public GLPbuffer createOffscreenDrawable(GLCapabilities capabilities, int initialWidth, int initialHeight)
Creates a subordinate offscreen drawable (pbuffer) for this drawable. This routine should only be called ifGLDrawable.canCreateOffscreenDrawable()
returns true. The passed capabilities are matched according to the platform-dependent pbuffer format selection algorithm, which currently can not be overridden.
- Specified by:
- createOffscreenDrawable in interface GLDrawable
public void display()
Causes OpenGL rendering to be performed for this GLDrawable by callingGLEventListener.display(GLDrawable)
for all registeredGLEventListener
s. Called automatically by the window system toolkit upon receiving a repaint() request. When used in conjunction withGLDrawable.setRenderingThread(Thread)
, this routine may be called manually by the application's main loop for higher performance and better control over the rendering process. It is legal to call another GLDrawable's display method from withinGLEventListener.display(GLDrawable)
.
- Specified by:
- display in interface GLDrawable
public boolean getAutoSwapBufferMode()
Indicates whether automatic buffer swapping is enabled for this drawable. SeeGLDrawable.setAutoSwapBufferMode(boolean)
.
- Specified by:
- getAutoSwapBufferMode in interface GLDrawable
public GL getGL()
Returns theGL
pipeline object this GLDrawable uses. If this method is called outside of theGLEventListener
'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 GLDrawable at the beginning of each call to init, display, etc.
- Specified by:
- getGL in interface GLDrawable
public GLU getGLU()
Returns theGLU
pipeline object this GLDrawable uses.
- Specified by:
- getGLU in interface GLDrawable
public boolean getNoAutoRedrawMode()
Returns whether automatic redraws are disabled for this drawable. Defaults to false.
- Specified by:
- getNoAutoRedrawMode in interface GLDrawable
public Thread getRenderingThread()
Returns the rendering thread for this drawable, or null if none has been set.
- Specified by:
- getRenderingThread in interface GLDrawable
public void paint(Graphics g)
Overridden from Canvas; callsdisplay()
. Should not be invoked by applications directly.
public void removeGLEventListener(GLEventListener listener)
Removes aGLEventListener
from this drawable. Note that if this is done from within a particular drawable'sGLEventListener
handler (reshape, display, etc.) that it is not guaranteed that all other listeners will be evaluated properly during this update cycle.
- Specified by:
- removeGLEventListener in interface GLDrawable
public void removeNotify()
Overridden from Canvas; used to indicate that it's no longer safe to have an OpenGL context for the component.
public void reshape(int x, int y, int width, int height)
Overridden from Canvas; causesGLDrawableHelper.reshape(GLDrawable,int,int,int,int)
to be called on all registeredGLEventListener
s. Called automatically by the AWT; should not be invoked by applications directly.
public void setAutoSwapBufferMode(boolean onOrOff)
Enables or disables automatic buffer swapping for this drawable. By default this property is set to true; when true, after all GLEventListeners have been called for a display() event, the front and back buffers are swapped, displaying the results of the render. When disabled, the user is responsible for callingGLDrawable.swapBuffers()
manually.
- Specified by:
- setAutoSwapBufferMode in interface GLDrawable
public void setGL(GL gl)
Sets theGL
pipeline object this GLDrawable 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.
- Specified by:
- setGL in interface GLDrawable
public void setGLU(GLU glu)
Sets theGLU
pipeline object this GLDrawable uses.
- Specified by:
- setGLU in interface GLDrawable
public void setNoAutoRedrawMode(boolean noAutoRedraw)
Disables automatic redraws of this drawable if possible. This is provided as an overriding mechanism for applications which perform animation on the drawable and for which the (currently advisory)GLDrawable.setRenderingThread(Thread)
does not provide strict enough guarantees. Its sole purpose is to avoid deadlocks that are unfortunately all too easy to run into when both animating a drawable from a given thread as well as having updates performed by the AWT event thread (repaints, etc.). When it is enabled, repaint requests driven by the AWT will not result in the OpenGL event listeners' display methods being called from the AWT thread, unless (as with GLJPanel) this is the only mechanism by which repaints are done. The necessity of this API may be rethought in a future release. Defaults to false.
- Specified by:
- setNoAutoRedrawMode in interface GLDrawable
public void setRenderingThread(Thread currentThreadOrNull) throws GLException
Changes this GLDrawable to allow OpenGL rendering only from the supplied thread, which must either be the current thread or null. Attempts by other threads to perform OpenGL operations like rendering or resizing the window will be ignored as long as the thread is set. Setting up the rendering thread is not required but enables the system to perform additional optimizations, in particular when the application requires control over the rendering loop. Before exiting,setRenderingThread(null)
must be called or other threads will be unable to perform OpenGL rendering to this drawable. ThrowsGLException
if the rendering thread for this drawable has been set and attempts are made to set or clear the rendering thread from another thread, or if the passed thread is not equal to the current thread or null. Also throwsGLException
if the current thread attempts to callsetRenderingThread
on more than one drawable. NOTE: Currently this routine is only advisory, which means that on some platforms the underlying optimizations are disabled and setting the rendering thread has no effect. Applications should not rely on setRenderingThread to prevent rendering from other threads.
- Specified by:
- setRenderingThread in interface GLDrawable
- Throws:
GLException
- if the rendering thread for this drawable has been set by another thread or if the passed thread is not equal to the current thread or null
public void swapBuffers()
Swaps the front and back buffers of this drawable. When automatic buffer swapping is enabled (as is the default), it is not necessary to call this method and doing so may have undefined results.
- Specified by:
- swapBuffers in interface GLDrawable
public void update(Graphics g)
Overridden from Canvas to prevent Java2D's clearing of the canvas from interfering with the OpenGL rendering.