Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
Canvas
javax.media.opengl.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. Constructor Summary | |
| |
| |
|
Method Summary | |
void |
|
void |
|
GLContext |
|
void |
|
boolean |
|
GLCapabilities |
|
GLContext |
|
GL | |
GraphicsConfiguration |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void | |
void |
|
void |
|
void |
|
public GLCanvas()
Creates a new GLCanvas component with a default set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism, on the default screen device.
public GLCanvas(GLCapabilities capabilities)
Creates a new GLCanvas component with the requested set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism, on the default screen device.
public GLCanvas(GLCapabilities capabilities, GLCapabilitiesChooser chooser, GLContext shareWith, GraphicsDevice device)
Creates a new GLCanvas component. The passed GLCapabilities specifies the OpenGL capabilities for the component; if null, a default set of capabilities is used. The GLCapabilitiesChooser specifies the algorithm for selecting one of the available GLCapabilities for the component; a DefaultGLCapabilitesChooser is used if null is passed for this argument. The passed GLContext specifies an OpenGL context with which to share textures, display lists and other OpenGL state, and may be null if sharing is not desired. See the note in the overview documentation on context sharing. The passed GraphicsDevice indicates the screen on which to create the GLCanvas; the GLDrawableFactory uses the default screen device of the local GraphicsEnvironment if null is passed for this argument.
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 GLAutoDrawable
public void addNotify()
Overridden to track when this component is added to a container. Subclasses which override this method must call super.addNotify() in their addNotify() method in order to function properly. Overrides:
addNotify
java.awt.Component
public 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. The GLContextshare
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.
- Specified by:
- createContext in interface GLDrawable
public void display()
Causes OpenGL rendering to be performed for this GLAutoDrawable by callingdisplay
for all registeredGLEventListener
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 thedisplay
callback.
- Specified by:
- display in interface GLAutoDrawable
public boolean getAutoSwapBufferMode()
Indicates whether automatic buffer swapping is enabled for this drawable. SeeGLAutoDrawable.setAutoSwapBufferMode(boolean)
.
- Specified by:
- getAutoSwapBufferMode in interface GLAutoDrawable
public GLCapabilities getChosenGLCapabilities()
Fetches theGLCapabilities
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.
- Specified by:
- getChosenGLCapabilities in interface GLDrawable
public GLContext getContext()
Returns the context associated with this drawable. The returned context will be synchronized.
- Specified by:
- getContext in interface GLAutoDrawable
public GL getGL()
Returns theGL
pipeline object this GLAutoDrawable 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 GLAutoDrawable at the beginning of each call to init, display, etc.
- Specified by:
- getGL in interface GLAutoDrawable
public GraphicsConfiguration getGraphicsConfiguration()
Overridden to choose a GraphicsConfiguration on a parent container's GraphicsDevice because both devices
public void paint(Graphics g)
Overridden to cause OpenGL rendering to be performed during repaint cycles. Subclasses which override this method must call super.paint() in their paint() method in order to function properly. Overrides:
paint
java.awt.Component
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 GLAutoDrawable
public void removeNotify()
Overridden to track when this component is removed from a container. Subclasses which override this method must call super.removeNotify() in their removeNotify() method in order to function properly. Overrides:
removeNotify
java.awt.Component
public void reshape(int x, int y, int width, int height)
Overridden to causeGLDrawableHelper.reshape
to be called on all registeredGLEventListener
s. Subclasses which override this method must call super.reshape() in their reshape() method in order to function properly. Overrides:
reshape
java.awt.Component
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 callingGLAutoDrawable
manually.
- Specified by:
- setAutoSwapBufferMode in interface GLAutoDrawable
public void setGL(GL gl)
Sets theGL
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.
- Specified by:
- setGL in interface GLAutoDrawable
public void setRealized(boolean realized)
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 theGLDrawableFactory.getGLDrawable()
method. It must typically be called with an argument oftrue
in theaddNotify
method of components performing OpenGL rendering and with an argument offalse
in theremoveNotify
method. Calling this method has no other effects. For example, ifremoveNotify
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 callsetRealized
on a GLCanvas, a GLJPanel, or a GLPbuffer, as these perform the appropriate calls on their underlying GLDrawables internally..
- Specified by:
- setRealized in interface GLDrawable
public void swapBuffers()
Swaps the front and back buffers of this drawable. ForGLAutoDrawable
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.
- Specified by:
- swapBuffers in interface GLDrawable
public void update(Graphics g)
Overrides:
update
java.awt.Component