|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjava.awt.Component
java.awt.Canvas
javax.media.opengl.awt.GLCanvas
public class GLCanvas
A heavyweight AWT component which provides OpenGL rendering
support. This is the primary implementation of an AWT 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.
sun.java2d.opengl=false
sun.java2d.noddraw=true
GLProfile.GL2, eg. using GLProfile#getMaxFixedFunc().sun.java2d.opengl=true
sun.java2d.noddraw=true
Toolkit method disableBeackgroundErase(java.awt.Canvas).sun.awt.noerasebackground=true
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class java.awt.Component |
|---|
Component.BaselineResizeBehavior |
| Nested classes/interfaces inherited from interface javax.media.nativewindow.WindowClosingProtocol |
|---|
WindowClosingProtocol.WindowClosingMode |
| Field Summary |
|---|
| Fields inherited from class java.awt.Component |
|---|
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
| Fields inherited from interface javax.media.opengl.GLAutoDrawable |
|---|
SCREEN_CHANGE_ACTION_ENABLED |
| Fields inherited from interface java.awt.image.ImageObserver |
|---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
| Constructor Summary | |
|---|---|
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. |
|
GLCanvas(GLCapabilitiesImmutable capsReqUser)
Creates a new GLCanvas component with the requested set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism, on the default screen device. |
|
GLCanvas(GLCapabilitiesImmutable capsReqUser,
GLCapabilitiesChooser chooser,
GLContext shareWith,
GraphicsDevice device)
Creates a new GLCanvas component. |
|
GLCanvas(GLCapabilitiesImmutable capsReqUser,
GLContext shareWith)
Creates a new GLCanvas component with the requested set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism, on the default screen device. |
|
| Method Summary | |
|---|---|
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. |
void |
addNotify()
Overridden to track when this component is added to a container. |
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()
Just an alias for removeNotify |
void |
display()
Causes OpenGL rendering to be performed for this GLAutoDrawable in the following order: Calling display(..) for all
registered GLEventListeners. |
GLAnimatorControl |
getAnimator()
|
boolean |
getAutoSwapBufferMode()
Indicates whether automatic buffer swapping is enabled for this drawable. |
GLCapabilitiesImmutable |
getChosenGLCapabilities()
Fetches the GLCapabilitiesImmutable corresponding to the chosen
OpenGL capabilities (pixel format / visual / GLProfile) for this drawable.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. |
GLContext |
getContext()
Returns the context associated with this drawable. |
int |
getContextCreationFlags()
|
WindowClosingProtocol.WindowClosingMode |
getDefaultCloseOperation()
|
GLDrawableFactory |
getFactory()
|
GL |
getGL()
Returns the GL pipeline object this GLAutoDrawable uses. |
GLProfile |
getGLProfile()
Fetches the GLProfile for this drawable. |
GraphicsConfiguration |
getGraphicsConfiguration()
Overridden to choose a GraphicsConfiguration on a parent container's GraphicsDevice because both devices |
long |
getHandle()
This is the GL/Windowing drawable handle. It is usually the NativeSurface.getSurfaceHandle(),
ie the native surface handle of the underlying windowing toolkit.However, on X11/GLX this reflects a GLXDrawable, which represents a GLXWindow, GLXPixmap, or GLXPbuffer. On EGL, this represents the EGLSurface. |
NativeSurface |
getNativeSurface()
Returns the underlying native surface which surface handle represents this OpenGL drawable's native resource. |
GLCapabilitiesImmutable |
getRequestedGLCapabilities()
|
boolean |
getShallUseOffscreenLayer()
Returns the property set by OffscreenLayerOption.setShallUseOffscreenLayer(boolean). |
void |
invoke(boolean wait,
GLRunnable glRunnable)
Enqueues a one-shot GLRunnable,
which will be executed with the next GLAutoDrawable.display() call. |
boolean |
isOffscreenLayerSurfaceEnabled()
Returns true if this instance uses an offscreen layer, otherwise false. |
boolean |
isRealized()
|
static void |
main(String[] args)
A most simple JOGL AWT test entry |
void |
paint(Graphics g)
Overridden to cause OpenGL rendering to be performed during repaint cycles. |
void |
removeGLEventListener(GLEventListener listener)
Removes a GLEventListener from this drawable. |
void |
removeNotify()
Overridden to track when this component is removed from a container. |
void |
reshape(int x,
int y,
int width,
int height)
Overridden to cause GLDrawableHelper.reshape(javax.media.opengl.GLEventListener, javax.media.opengl.GLAutoDrawable, int, int, int, int, boolean, boolean) to be
called on all registered GLEventListeners. |
void |
setAnimator(GLAnimatorControl animatorControl)
Registers the usage of an animator, an GLAnimatorControl implementation. |
void |
setAutoSwapBufferMode(boolean onOrOff)
Enables or disables automatic buffer swapping for this drawable. |
void |
setContext(GLContext ctx)
Associate a new context to this drawable. |
void |
setContextCreationFlags(int flags)
|
WindowClosingProtocol.WindowClosingMode |
setDefaultCloseOperation(WindowClosingProtocol.WindowClosingMode op)
|
GL |
setGL(GL gl)
Sets the GL pipeline object this GLAutoDrawable uses. |
void |
setRealized(boolean realized)
Indicates to on-screen GLDrawable implementations whether the underlying window has been created and can be drawn into. |
void |
setShallUseOffscreenLayer(boolean v)
Request an offscreen layer, if supported. |
void |
swapBuffers()
Swaps the front and back buffers of this drawable. |
String |
toString()
|
void |
update(Graphics g)
Overridden from Canvas to prevent the AWT's clearing of the canvas from interfering with the OpenGL rendering. |
| Methods inherited from class java.awt.Canvas |
|---|
createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface javax.media.opengl.awt.AWTGLAutoDrawable |
|---|
repaint, setSize |
| Methods inherited from interface javax.media.opengl.GLDrawable |
|---|
getHeight, getWidth |
| Constructor Detail |
|---|
public GLCanvas()
throws GLException
GLException - if no default profile is available for the default desktop device.
public GLCanvas(GLCapabilitiesImmutable capsReqUser)
throws GLException
GLException - if no GLCapabilities are given and no default profile is available for the default desktop device.GLCanvas(javax.media.opengl.GLCapabilitiesImmutable, javax.media.opengl.GLCapabilitiesChooser, javax.media.opengl.GLContext, java.awt.GraphicsDevice)
public GLCanvas(GLCapabilitiesImmutable capsReqUser,
GLContext shareWith)
throws GLException
GLException - if no GLCapabilities are given and no default profile is available for the default desktop device.GLCanvas(javax.media.opengl.GLCapabilitiesImmutable, javax.media.opengl.GLCapabilitiesChooser, javax.media.opengl.GLContext, java.awt.GraphicsDevice)
public GLCanvas(GLCapabilitiesImmutable capsReqUser,
GLCapabilitiesChooser chooser,
GLContext shareWith,
GraphicsDevice device)
throws GLException
GLException - if no GLCapabilities are given and no default profile is available for the default desktop device.| Method Detail |
|---|
public void setShallUseOffscreenLayer(boolean v)
OffscreenLayerOption
Shall be called before the first NativeSurface.lockSurface(),
and hence before realization.
setShallUseOffscreenLayer in interface OffscreenLayerOptionOffscreenLayerOption.getShallUseOffscreenLayer(),
OffscreenLayerOption.isOffscreenLayerSurfaceEnabled()public final boolean getShallUseOffscreenLayer()
OffscreenLayerOptionOffscreenLayerOption.setShallUseOffscreenLayer(boolean).
getShallUseOffscreenLayer in interface OffscreenLayerOptionpublic final boolean isOffscreenLayerSurfaceEnabled()
OffscreenLayerOption
This instance is an offscreen layer, if setShallUseOffscreenLayer(true)
has been called before it's realization and first lock and the underlying implementation supports it.
NativeSurface.lockSurface().
isOffscreenLayerSurfaceEnabled in interface OffscreenLayerOptionOffscreenLayerOption.setShallUseOffscreenLayer(boolean)public GraphicsConfiguration getGraphicsConfiguration()
getGraphicsConfiguration in class Componentpublic GLContext createContext(GLContext shareWith)
GLDrawable
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.
createContext in interface GLDrawablepublic void setRealized(boolean realized)
GLDrawablesetRealized on a GLCanvas, a GLJPanel, or a
GLPbuffer, as these perform the appropriate calls on their
underlying GLDrawables internally.
Developers implementing new OpenGL components for various window
toolkits need to call this method against GLDrawables obtained
from the GLDrawableFactory via the GLDrawableFactory.getGLDrawable() method. It must typically be
called with an argument of true when the component
associated with the GLDrawable is realized and with an argument
of false just before the component is unrealized.
For the AWT, this means calling setRealized(true) in
the addNotify method and with an argument of
false in the removeNotify method.
GLDrawable implementations should handle multiple
cycles of setRealized(true) /
setRealized(false) calls. Most, if not all, Java
window toolkits have a persistent object associated with a given
component, regardless of whether that component is currently
realized. The GLDrawable object associated with a
particular component is intended to be similarly persistent. A
GLDrawable is intended to be created for a given
component when it is constructed and live as long as that
component. setRealized allows the
GLDrawable to re-initialize and destroy any
associated resources as the component becomes realized and
unrealized, respectively.
With an argument of true,
the minimum implementation shall call
NativeSurface's lockSurface() and if successfull:
GLCapabilities, which are associated with
the attached NativeSurface's AbstractGraphicsConfiguration.NativeSurface's unlockSurface().NativeSurface's lockSurface()
ensures resolving the window/surface handles, and the drawable's GLCapabilities
might have changed.
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.
setRealized in interface GLDrawablepublic boolean isRealized()
isRealized in interface GLDrawablepublic WindowClosingProtocol.WindowClosingMode getDefaultCloseOperation()
getDefaultCloseOperation in interface WindowClosingProtocolWindowClosingProtocol.WindowClosingMode.DISPOSE_ON_CLOSE,
WindowClosingProtocol.WindowClosingMode.DO_NOTHING_ON_CLOSEpublic WindowClosingProtocol.WindowClosingMode setDefaultCloseOperation(WindowClosingProtocol.WindowClosingMode op)
setDefaultCloseOperation in interface WindowClosingProtocolop - the new close operation value
WindowClosingProtocol.WindowClosingMode.DISPOSE_ON_CLOSE,
WindowClosingProtocol.WindowClosingMode.DO_NOTHING_ON_CLOSEpublic void display()
GLAutoDrawableCauses OpenGL rendering to be performed for this GLAutoDrawable in the following order:
display(..) for all
registered GLEventListeners. GLRunnable,
enqueued via GLAutoDrawable.invoke(boolean, GLRunnable).
May be called periodically by a running GLAnimatorControl implementation,
which must register itself with GLAutoDrawable.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 GLEventListeners before making the
actual display(..) calls,
in case this has not been done yet.
display in interface GLAutoDrawableGLAutoDrawable.setAnimator(javax.media.opengl.GLAnimatorControl)public void destroy()
destroy in interface GLAutoDrawablepublic void paint(Graphics g)
Overrides:
paint in class java.awt.Component
paint in class Canvaspublic void addNotify()
Overrides:
addNotify in class java.awt.Component
addNotify in class Canvaspublic 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.
User shall not call this method outside of EDT, read the AWT/Swing specs about this.
Overrides:removeNotify in class java.awt.Component
removeNotify in class Component
public void reshape(int x,
int y,
int width,
int height)
GLDrawableHelper.reshape(javax.media.opengl.GLEventListener, javax.media.opengl.GLAutoDrawable, int, int, int, int, boolean, boolean) to be
called on all registered GLEventListeners. Subclasses
which override this method must call super.reshape() in
their reshape() method in order to function properly. Overrides:
reshape in class java.awt.Component
reshape in class Componentpublic void update(Graphics g)
update in class Canvaspublic void addGLEventListener(GLEventListener listener)
GLAutoDrawableGLEventListener to the end of this drawable queue.
The listeners are notified of events in the order of the queue.
addGLEventListener in interface GLAutoDrawable
public void addGLEventListener(int index,
GLEventListener listener)
GLAutoDrawableGLEventListener at the given index of this drawable queue.
The listeners are notified of events in the order of the queue.
addGLEventListener in interface GLAutoDrawableindex - 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 insertedpublic void removeGLEventListener(GLEventListener listener)
GLAutoDrawableGLEventListener 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.
removeGLEventListener in interface GLAutoDrawablepublic void setAnimator(GLAnimatorControl animatorControl)
GLAutoDrawable
Registers the usage of an animator, an GLAnimatorControl implementation.
The animator will be queried whether it's animating, ie periodically issuing GLAutoDrawable.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 GLAutoDrawable.display() and GLAutoDrawable.invoke(boolean, GLRunnable) semantics.
setAnimator in interface GLAutoDrawableGLAutoDrawable.display(),
GLAutoDrawable.invoke(boolean, GLRunnable),
GLAnimatorControlpublic GLAnimatorControl getAnimator()
getAnimator in interface GLAutoDrawableGLAnimatorControl implementation, using this GLAutoDrawable.GLAutoDrawable.setAnimator(javax.media.opengl.GLAnimatorControl),
GLAnimatorControl
public void invoke(boolean wait,
GLRunnable glRunnable)
GLAutoDrawable
Enqueues a one-shot GLRunnable,
which will be executed with the next GLAutoDrawable.display() call.
If no GLAnimatorControl is animating (default),
or if the current thread is the animator thread,
a GLAutoDrawable.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 GLAutoDrawable.display() call is issued, since the animator thread performs it.
If wait is true, the implementation waits until the GLRunnable is executed.
invoke in interface GLAutoDrawableGLAutoDrawable.setAnimator(javax.media.opengl.GLAnimatorControl),
GLAutoDrawable.display(),
GLRunnablepublic void setContext(GLContext ctx)
GLAutoDrawable
setContext in interface GLAutoDrawablepublic GLContext getContext()
GLAutoDrawable
getContext in interface GLAutoDrawablepublic GL getGL()
GLAutoDrawableGL 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.
getGL in interface GLAutoDrawablepublic GL setGL(GL gl)
GLAutoDrawableGL 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.
setGL in interface GLAutoDrawablepublic void setAutoSwapBufferMode(boolean onOrOff)
GLAutoDrawableGLDrawable.swapBuffers(..) manually.
setAutoSwapBufferMode in interface GLAutoDrawablepublic boolean getAutoSwapBufferMode()
GLAutoDrawableGLAutoDrawable.setAutoSwapBufferMode(boolean).
getAutoSwapBufferMode in interface GLAutoDrawablepublic void swapBuffers()
GLDrawableGLAutoDrawable 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.
swapBuffers in interface GLDrawablepublic void setContextCreationFlags(int flags)
setContextCreationFlags in interface GLAutoDrawableflags - Additional context creation flags.GLContext.setContextCreationFlags(int),
GLContext.enableGLDebugMessage(boolean)public int getContextCreationFlags()
getContextCreationFlags in interface GLAutoDrawablepublic GLProfile getGLProfile()
GLDrawableGLProfile for this drawable.
Returns the GLProfile object, no copy.
getGLProfile in interface GLDrawablepublic GLCapabilitiesImmutable getChosenGLCapabilities()
GLDrawableGLCapabilitiesImmutable corresponding to the chosen
OpenGL capabilities (pixel format / visual / GLProfile) for this drawable.NativeSurface's
AbstractGraphicsConfiguration, and if changes are necessary,
they should reflect those as well.
getChosenGLCapabilities in interface GLDrawablepublic GLCapabilitiesImmutable getRequestedGLCapabilities()
public NativeSurface getNativeSurface()
GLDrawable
getNativeSurface in interface GLDrawableGLDrawable.getHandle()public long getHandle()
GLDrawableNativeSurface.getSurfaceHandle(),
ie the native surface handle of the underlying windowing toolkit.
getHandle in interface GLDrawablepublic GLDrawableFactory getFactory()
getFactory in interface GLDrawablepublic String toString()
toString in interface GLDrawabletoString in class Componentpublic static void main(String[] args)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||