|
JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java (public API).
|
A heavyweight AWT component which provides OpenGL rendering support. More...
Public Member Functions | |||
| GLCanvas () throws GLException | |||
| Creates a new GLCanvas component with a default set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism, on the default screen device. More... | |||
| GLCanvas (final GLCapabilitiesImmutable capsReqUser) throws GLException | |||
| Creates a new GLCanvas component with the requested set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism, on the default screen device. More... | |||
| GLCanvas (final GLCapabilitiesImmutable capsReqUser, final GLCapabilitiesChooser chooser, final GraphicsDevice device) throws GLException | |||
| Creates a new GLCanvas component. More... | |||
| final void | setSharedContext (final GLContext sharedContext) throws IllegalStateException | ||
Specifies an OpenGL context, which shall be shared by this GLAutoDrawable's GLContext. More... | |||
| final void | setSharedAutoDrawable (final GLAutoDrawable sharedAutoDrawable) throws IllegalStateException | ||
Specifies an GLAutoDrawable, which OpenGL context shall be shared by this GLAutoDrawable's GLContext. More... | |||
| final Object | getUpstreamWidget () | ||
Method may return the upstream UI toolkit object holding this GLAutoDrawable instance, if exist. More... | |||
| final RecursiveLock | getUpstreamLock () | ||
Returns the recursive lock object of the upstream widget to synchronize multithreaded access on top of NativeSurface#lockSurface(). More... | |||
| final boolean | isThreadGLCapable () | ||
| Indicates whether the current thread is capable of performing OpenGL-related work. More... | |||
| void | setShallUseOffscreenLayer (final boolean v) | ||
| Request an offscreen layer, if supported. More... | |||
| final boolean | getShallUseOffscreenLayer () | ||
Returns the property set by setShallUseOffscreenLayer(boolean). More... | |||
| final boolean | isOffscreenLayerSurfaceEnabled () | ||
| Returns true if this instance uses an offscreen layer, otherwise false. More... | |||
| GraphicsConfiguration | getGraphicsConfiguration () | ||
| GLContext | createContext (final GLContext shareWith) | ||
Creates a new context for drawing to this drawable that will optionally share buffer objects, textures and other server-side OpenGL objects with the specified GLContext.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 context sharing as well as GLSharedContextSetter. 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, boolean). The GLAutoDrawable implementation shall also set the context creation flags as customized w/ setContextCreationFlags(int). More... | |||
| final void | setRealized (final boolean realized) | ||
Indicates to GLDrawable implementations whether the underlying surface has been created and can be drawn into. More... | |||
| boolean | isRealized () | ||
Returns true if this drawable is realized, otherwise false. More... | |||
| WindowClosingMode | getDefaultCloseOperation () | ||
| WindowClosingMode | setDefaultCloseOperation (final WindowClosingMode op) | ||
| void | display () | ||
| void | destroy () | ||
Destroys all resources associated with this GLAutoDrawable, inclusive the GLContext.If a window is attached to it's implementation, it shall be closed. Causes disposing of all OpenGL resources by calling dispose(..) for all registered GLEventListeners. Called automatically by the window system toolkit upon receiving a destroy notification. This routine may be called manually. More... | |||
| void | paint (final Graphics g) | ||
| Overridden to cause OpenGL rendering to be performed during repaint cycles. More... | |||
| void | addNotify () | ||
| Overridden to track when this component is added to a container. More... | |||
| final boolean | canSetSurfaceScale () | ||
Returns true if setSurfaceScale(float[]) is supported, otherwise false.For pure downstream scalable surfaces like AWT widgets, setting the picel scale is not supported since the pixel scale is set by the underlying toolkit. More... | |||
| final boolean | setSurfaceScale (final float[] pixelScale) | ||
Request a pixel scale in x- and y-direction for the associated NativeSurface, where size_in_pixel_units = pixel_scale * size_in_window_units.Default pixel scale request for both directions is AUTOMAX_PIXELSCALE. If canSetSurfaceScale() returns false, requested pixel scale is AUTOMAX_PIXELSCALE, immutable and method returns false. In case platform only supports uniform pixel scale, i.e. one scale for both directions, either AUTOMAX_PIXELSCALE or the maximum requested pixel scale component is used. The requested pixel scale will be validated against platform limits before native scale-setup, i.e. clipped to IDENTITY_PIXELSCALE if not supported or clipped to the platform maximum. It can be queried via getRequestedSurfaceScale(float[]). The actual realized pixel scale values of the NativeSurface can be queried via getCurrentSurfaceScale(float[]) or computed via surface.
| |||
| final float[] | getRequestedSurfaceScale (final float[] result) | ||
Returns the requested pixel scale of the associated NativeSurface.If canSetSurfaceScale() returns false, requested pixel scale is AUTOMAX_PIXELSCALE and immutable.
| |||
| final float[] | getCurrentSurfaceScale (final float[] result) | ||
Returns the current pixel scale of the associated NativeSurface. More... | |||
| float[] | getMinimumSurfaceScale (final float[] result) | ||
Returns the minimum pixel scale of the associated NativeSurface.
| |||
| float[] | getMaximumSurfaceScale (final float[] result) | ||
Returns the maximum pixel scale of the associated NativeSurface.The maximum pixel scale maybe used to determine the proper dpi value of the monitor displaying this NativeSurface. surfacePpMM = monitorPpMM * currentSurfaceScale / nativeSurfaceScale, with PpMM == pixel per millimeter
| |||
| void | removeNotify () | ||
| void | reshape (final int x, final int y, final int width, final int height) | ||
Overridden to cause GLDrawableHelper#reshape to be called on all registered GLEventListeners. More... | |||
| void | update (final Graphics g) | ||
| Overridden from Canvas to prevent the AWT's clearing of the canvas from interfering with the OpenGL rendering. More... | |||
| void | setupPrint (final double scaleMatX, final double scaleMatY, final int numSamples, final int tileWidth, final int tileHeight) | ||
Shall be called before PrinterJob#print(). More... | |||
| void | releasePrint () | ||
Shall be called after PrinterJob#print(). More... | |||
| void | print (final Graphics graphics) | ||
| void | addGLEventListener (final GLEventListener listener) | ||
Adds the given listener to the end of this drawable queue. More... | |||
| void | addGLEventListener (final int index, final GLEventListener listener) throws IndexOutOfBoundsException | ||
Adds the given listener at the given index of this drawable queue. More... | |||
| int | getGLEventListenerCount () | ||
Returns the number of GLEventListener of this drawable queue. More... | |||
| GLEventListener | getGLEventListener (final int index) throws IndexOutOfBoundsException | ||
Returns the GLEventListener at the given index of this drawable queue. More... | |||
| boolean | areAllGLEventListenerInitialized () | ||
Returns true if all added GLEventListener are initialized, otherwise false. More... | |||
| boolean | getGLEventListenerInitState (final GLEventListener listener) | ||
Retrieves whether the given listener is initialized or not. More... | |||
| void | setGLEventListenerInitState (final GLEventListener listener, final boolean initialized) | ||
Sets the given listener's initialized state. More... | |||
| GLEventListener | disposeGLEventListener (final GLEventListener listener, final boolean remove) | ||
Disposes the given listener via dispose(..) if it has been initialized and added to this queue. More... | |||
| GLEventListener | removeGLEventListener (final GLEventListener listener) | ||
Removes the given listener from this drawable queue. More... | |||
| void | setAnimator (final GLAnimatorControl animatorControl) | ||
Registers the usage of an animator, an com.jogamp.opengl.GLAnimatorControl implementation. More... | |||
| GLAnimatorControl | getAnimator () | ||
| final Thread | setExclusiveContextThread (final Thread t) throws GLException | ||
Dedicates this instance's GLContext to the given thread. More... | |||
| final Thread | getExclusiveContextThread () | ||
| boolean | invoke (final boolean wait, final GLRunnable glRunnable) throws IllegalStateException | ||
Enqueues a one-shot GLRunnable, which will be executed within the next display() call after all registered GLEventListeners display(GLAutoDrawable) methods have been called. More... | |||
| boolean | invoke (final boolean wait, final List< GLRunnable > glRunnables) throws IllegalStateException | ||
Extends invoke(boolean, GLRunnable) functionality allowing to inject a list of GLRunnables. More... | |||
| void | flushGLRunnables () | ||
Flushes all enqueued GLRunnable of this GLAutoDrawable including notifying waiting executor. More... | |||
| GLContext | setContext (final GLContext newCtx, final boolean destroyPrevCtx) | ||
Associate the new context, newtCtx, to this auto-drawable. More... | |||
| final GLDrawable | getDelegatedDrawable () | ||
If the implementation uses delegation, return the delegated GLDrawable instance, otherwise return this instance. More... | |||
| GLContext | getContext () | ||
| Returns the context associated with this drawable. More... | |||
| GL | getGL () | ||
Returns the GL pipeline object this GLAutoDrawable uses. More... | |||
| GL | setGL (final GL gl) | ||
Sets the GL pipeline object this GLAutoDrawable uses. More... | |||
| void | setAutoSwapBufferMode (final boolean onOrOff) | ||
| Enables or disables automatic buffer swapping for this drawable. More... | |||
| boolean | getAutoSwapBufferMode () | ||
| Indicates whether automatic buffer swapping is enabled for this drawable. More... | |||
| void | swapBuffers () | ||
| Swaps the front and back buffers of this drawable. More... | |||
| void | setContextCreationFlags (final int flags) | ||
| int | getContextCreationFlags () | ||
| GLProfile | getGLProfile () | ||
Fetches the GLProfile for this drawable. More... | |||
| GLCapabilitiesImmutable | getChosenGLCapabilities () | ||
Fetches the GLCapabilitiesImmutable corresponding to the chosen OpenGL capabilities (pixel format / visual / GLProfile) for this drawable. More... | |||
| GLCapabilitiesImmutable | getRequestedGLCapabilities () | ||
Fetches the GLCapabilitiesImmutable corresponding to the user requested OpenGL capabilities (pixel format / visual / GLProfile) for this drawable. More... | |||
| int | getSurfaceWidth () | ||
Returns the width of this GLDrawable's surface client area in pixel units. More... | |||
| int | getSurfaceHeight () | ||
Returns the height of this GLDrawable's surface client area in pixel units. More... | |||
| boolean | isGLOriented () | ||
Returns true if the drawable is rendered in OpenGL's coordinate system, origin at bottom left. More... | |||
| NativeSurface | getNativeSurface () | ||
Returns the associated NativeSurface of this NativeSurfaceHolder.Returns the underlying NativeSurface which native handle represents this OpenGL drawable's native resource.
| |||
| long | getHandle () | ||
Returns the GL drawable handle, guaranteed to be valid after realization and while it's surface is being locked. More... | |||
| GLDrawableFactory | getFactory () | ||
Return the GLDrawableFactory being used to create this instance. More... | |||
| String | toString () | ||
Public Member Functions inherited from com.jogamp.opengl.awt.AWTGLAutoDrawable | |||
| void | setSize (int width, int height) | ||
| Requests a new width and height for this AWTGLAutoDrawable. More... | |||
| void | repaint () | ||
| Schedules a repaint of the component at some point in the future. More... | |||
| GLDrawable | getDelegatedDrawable () | ||
If the implementation uses delegation, return the delegated GLDrawable instance, otherwise return this instance. More... | |||
| GLContext | getContext () | ||
| Returns the context associated with this drawable. More... | |||
| GLContext | setContext (GLContext newCtx, boolean destroyPrevCtx) | ||
Associate the new context, newtCtx, to this auto-drawable. More... | |||
| void | addGLEventListener (GLEventListener listener) | ||
Adds the given listener to the end of this drawable queue. More... | |||
| void | addGLEventListener (int index, GLEventListener listener) throws IndexOutOfBoundsException | ||
Adds the given listener at the given index of this drawable queue. More... | |||
| int | getGLEventListenerCount () | ||
Returns the number of GLEventListener of this drawable queue. More... | |||
| boolean | areAllGLEventListenerInitialized () | ||
Returns true if all added GLEventListener are initialized, otherwise false. More... | |||
| GLEventListener | getGLEventListener (int index) throws IndexOutOfBoundsException | ||
Returns the GLEventListener at the given index of this drawable queue. More... | |||
| boolean | getGLEventListenerInitState (GLEventListener listener) | ||
Retrieves whether the given listener is initialized or not. More... | |||
| void | setGLEventListenerInitState (GLEventListener listener, boolean initialized) | ||
Sets the given listener's initialized state. More... | |||
| GLEventListener | disposeGLEventListener (GLEventListener listener, boolean remove) | ||
Disposes the given listener via dispose(..) if it has been initialized and added to this queue. More... | |||
| GLEventListener | removeGLEventListener (GLEventListener listener) | ||
Removes the given listener from this drawable queue. More... | |||
| abstract void | setAnimator (GLAnimatorControl animatorControl) throws GLException | ||
Registers the usage of an animator, an com.jogamp.opengl.GLAnimatorControl implementation. More... | |||
| GLAnimatorControl | getAnimator () | ||
| Thread | setExclusiveContextThread (Thread t) throws GLException | ||
Dedicates this instance's GLContext to the given thread. More... | |||
| Thread | getExclusiveContextThread () | ||
| boolean | invoke (boolean wait, GLRunnable glRunnable) throws IllegalStateException | ||
Enqueues a one-shot GLRunnable, which will be executed within the next display() call after all registered GLEventListeners display(GLAutoDrawable) methods have been called. More... | |||
| boolean | invoke (boolean wait, List< GLRunnable > glRunnables) throws IllegalStateException | ||
Extends invoke(boolean, GLRunnable) functionality allowing to inject a list of GLRunnables. More... | |||
| void | flushGLRunnables () | ||
Flushes all enqueued GLRunnable of this GLAutoDrawable including notifying waiting executor. More... | |||
| void | destroy () | ||
| Destroys all resources associated with this GLAutoDrawable, inclusive the GLContext. More... | |||
| void | display () | ||
| void | setAutoSwapBufferMode (boolean enable) | ||
| Enables or disables automatic buffer swapping for this drawable. More... | |||
| boolean | getAutoSwapBufferMode () | ||
| Indicates whether automatic buffer swapping is enabled for this drawable. More... | |||
| void | setContextCreationFlags (int flags) | ||
| int | getContextCreationFlags () | ||
| GLContext | createContext (GLContext shareWith) | ||
Creates a new context for drawing to this drawable that will optionally share buffer objects, textures and other server-side OpenGL objects with the specified GLContext.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 context sharing as well as GLSharedContextSetter. More... | |||
| GL | getGL () | ||
Returns the GL pipeline object this GLAutoDrawable uses. More... | |||
| GL | setGL (GL gl) | ||
Sets the GL pipeline object this GLAutoDrawable uses. More... | |||
| Object | getUpstreamWidget () | ||
Method may return the upstream UI toolkit object holding this GLAutoDrawable instance, if exist. More... | |||
| RecursiveLock | getUpstreamLock () | ||
Returns the recursive lock object of the upstream widget to synchronize multithreaded access on top of NativeSurface#lockSurface(). More... | |||
| boolean | isThreadGLCapable () | ||
| Indicates whether the current thread is capable of performing OpenGL-related work. More... | |||
| GLContext | createContext (GLContext shareWith) | ||
| Creates a new context for drawing to this drawable that will optionally share buffer objects, textures and other server-side OpenGL objects with the specified GLContext. More... | |||
| void | setRealized (boolean realized) | ||
Indicates to GLDrawable implementations whether the underlying surface has been created and can be drawn into. More... | |||
| boolean | isRealized () | ||
Returns true if this drawable is realized, otherwise false. More... | |||
| int | getSurfaceWidth () | ||
Returns the width of this GLDrawable's surface client area in pixel units. More... | |||
| int | getSurfaceHeight () | ||
Returns the height of this GLDrawable's surface client area in pixel units. More... | |||
| boolean | isGLOriented () | ||
Returns true if the drawable is rendered in OpenGL's coordinate system, origin at bottom left. More... | |||
| void | swapBuffers () throws GLException | ||
| Swaps the front and back buffers of this drawable. More... | |||
| GLCapabilitiesImmutable | getChosenGLCapabilities () | ||
Fetches the GLCapabilitiesImmutable corresponding to the chosen OpenGL capabilities (pixel format / visual / GLProfile) for this drawable. More... | |||
| GLCapabilitiesImmutable | getRequestedGLCapabilities () | ||
Fetches the GLCapabilitiesImmutable corresponding to the user requested OpenGL capabilities (pixel format / visual / GLProfile) for this drawable. More... | |||
| GLProfile | getGLProfile () | ||
Fetches the GLProfile for this drawable. More... | |||
| NativeSurface | getNativeSurface () | ||
Returns the associated NativeSurface of this NativeSurfaceHolder. More... | |||
| long | getHandle () | ||
Returns the GL drawable handle, guaranteed to be valid after realization and while it's surface is being locked. More... | |||
| GLDrawableFactory | getFactory () | ||
Return the GLDrawableFactory being used to create this instance. More... | |||
| String | toString () | ||
| NativeSurface | getNativeSurface () | ||
Returns the associated NativeSurface of this NativeSurfaceHolder. More... | |||
Public Member Functions inherited from com.jogamp.opengl.awt.ComponentEvents | |||
| void | addComponentListener (ComponentListener l) | ||
| void | removeComponentListener (ComponentListener l) | ||
| void | addFocusListener (FocusListener l) | ||
| void | removeFocusListener (FocusListener l) | ||
| void | addHierarchyBoundsListener (HierarchyBoundsListener l) | ||
| void | removeHierarchyBoundsListener (HierarchyBoundsListener l) | ||
| void | addHierarchyListener (HierarchyListener l) | ||
| void | removeHierarchyListener (HierarchyListener l) | ||
| void | addInputMethodListener (InputMethodListener l) | ||
| void | removeInputMethodListener (InputMethodListener l) | ||
| void | addKeyListener (KeyListener l) | ||
| void | removeKeyListener (KeyListener l) | ||
| void | addMouseListener (MouseListener l) | ||
| void | removeMouseListener (MouseListener l) | ||
| void | addMouseMotionListener (MouseMotionListener l) | ||
| void | removeMouseMotionListener (MouseMotionListener l) | ||
| void | addMouseWheelListener (MouseWheelListener l) | ||
| void | removeMouseWheelListener (MouseWheelListener l) | ||
| void | addPropertyChangeListener (PropertyChangeListener listener) | ||
| void | removePropertyChangeListener (PropertyChangeListener listener) | ||
| void | addPropertyChangeListener (String propertyName, PropertyChangeListener listener) | ||
| void | removePropertyChangeListener (String propertyName, PropertyChangeListener listener) | ||
| WindowClosingMode | getDefaultCloseOperation () | ||
| WindowClosingMode | setDefaultCloseOperation (WindowClosingMode op) | ||
| void | setShallUseOffscreenLayer (boolean v) | ||
| Request an offscreen layer, if supported. More... | |||
| boolean | getShallUseOffscreenLayer () | ||
Returns the property set by setShallUseOffscreenLayer(boolean). More... | |||
| boolean | isOffscreenLayerSurfaceEnabled () | ||
| Returns true if this instance uses an offscreen layer, otherwise false. More... | |||
| void | setupPrint (double scaleMatX, double scaleMatY, int numSamples, int tileWidth, int tileHeight) | ||
Shall be called before PrinterJob#print(). More... | |||
| void | releasePrint () | ||
Shall be called after PrinterJob#print(). More... | |||
| void | setSharedContext (GLContext sharedContext) throws IllegalStateException | ||
Specifies an OpenGL context, which shall be shared by this GLAutoDrawable's GLContext. More... | |||
| void | setSharedAutoDrawable (GLAutoDrawable sharedAutoDrawable) throws IllegalStateException | ||
Specifies an GLAutoDrawable, which OpenGL context shall be shared by this GLAutoDrawable's GLContext. More... | |||
| boolean | canSetSurfaceScale () | ||
Returns true if setSurfaceScale(float[]) is supported, otherwise false. More... | |||
| boolean | setSurfaceScale (final float[] pixelScale) | ||
Request a pixel scale in x- and y-direction for the associated NativeSurface, where size_in_pixel_units = pixel_scale * size_in_window_units. More... | |||
| float[] | getRequestedSurfaceScale (final float[] result) | ||
Returns the requested pixel scale of the associated NativeSurface. More... | |||
| float[] | getCurrentSurfaceScale (final float[] result) | ||
Returns the current pixel scale of the associated NativeSurface. More... | |||
| float[] | getMinimumSurfaceScale (final float[] result) | ||
Returns the minimum pixel scale of the associated NativeSurface. More... | |||
| float[] | getMaximumSurfaceScale (final float[] result) | ||
Returns the maximum pixel scale of the associated NativeSurface. More... | |||
Static Public Member Functions | |
| static void | main (final String args[]) |
| A most simple JOGL AWT test entry. More... | |
Protected Member Functions | |
| void | destroyImpl (final boolean destroyJAWTWindowAndAWTDevice) |
Static Protected Member Functions | |
| static String | getThreadName () |
Additional Inherited Members | |
Static Public Attributes inherited from com.jogamp.opengl.GLAutoDrawable | |
| static final boolean | SCREEN_CHANGE_ACTION_ENABLED = Debug.getBooleanProperty("jogl.screenchange.action", true) |
Flag reflecting whether the GLDrawable reconfiguration will be issued in case a screen device change occurred, e.g. More... | |
Static Public Attributes inherited from com.jogamp.nativewindow.awt.AWTPrintLifecycle | |
| static final int | DEFAULT_PRINT_TILE_SIZE = 1024 |
Static Public Attributes inherited from com.jogamp.nativewindow.ScalableSurface | |
| static final float | IDENTITY_PIXELSCALE = 1f |
| Setting surface-pixel-scale of {@value}, results in same pixel- and window-units. More... | |
| static final float | AUTOMAX_PIXELSCALE = 0f |
| Setting surface-pixel-scale of {@value}, results in maximum platform dependent pixel-scale, i.e. More... | |
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.
setShallUseOffscreenLayer(true) maybe called to use an offscreen drawable (FBO or PBuffer) allowing the underlying JAWT mechanism to composite the image, if supported.
setShallUseOffscreenLayer(true) is being called if GLCapabilitiesImmutable#isOnscreen() is false.
To avoid any conflicts with a potential Java2D OpenGL context,
you shall consider setting the following JVM properties:
sun.java2d.opengl=false
sun.java2d.noddraw=true
This is especially true in case you want to utilize a GLProfile other than GLProfile#GL2, eg. using GLProfile#getMaxFixedFunc().
On the other hand, if you like to experiment with GLJPanel's utilization of Java2D's OpenGL pipeline, you have to set them to
sun.java2d.opengl=true
sun.java2d.noddraw=true
GLCanvas tries to disable background erase for the AWT Canvas before native peer creation (X11) and after it (Windows),
utilizing the optional java.awt.Toolkit method disableBeackgroundErase(java.awt.Canvas).
However if this does not give you the desired results, you may want to disable AWT background erase in general:
sun.awt.noerasebackground=true
To share a GLContext see the following note in the documentation overview: context sharing as well as GLSharedContextSetter.
Definition at line 169 of file GLCanvas.java.
| com.jogamp.opengl.awt.GLCanvas.GLCanvas | ( | ) | throws GLException |
Creates a new GLCanvas component with a default set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism, on the default screen device.
See details about OpenGL context sharing.
| GLException | if no default profile is available for the default desktop device. |
Definition at line 216 of file GLCanvas.java.
| com.jogamp.opengl.awt.GLCanvas.GLCanvas | ( | final GLCapabilitiesImmutable | capsReqUser | ) | throws GLException |
Creates a new GLCanvas component with the requested set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism, on the default screen device.
See details about OpenGL context sharing.
| GLException | if no GLCapabilities are given and no default profile is available for the default desktop device. |
Definition at line 229 of file GLCanvas.java.
| com.jogamp.opengl.awt.GLCanvas.GLCanvas | ( | final GLCapabilitiesImmutable | capsReqUser, |
| final GLCapabilitiesChooser | chooser, | ||
| final GraphicsDevice | device | ||
| ) | throws GLException |
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 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.
See details about OpenGL context sharing.
| GLException | if no GLCapabilities are given and no default profile is available for the default desktop device. |
Definition at line 248 of file GLCanvas.java.
| void com.jogamp.opengl.awt.GLCanvas.addGLEventListener | ( | final GLEventListener | listener | ) |
Adds the given listener to the end of this drawable queue.
The listeners are notified of events in the order of the queue.
The newly added listener's init(..) method will be called once before any other of it's callback methods. See getGLEventListenerInitState(GLEventListener) for details.
| listener | The GLEventListener object to be inserted |
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1065 of file GLCanvas.java.
| void com.jogamp.opengl.awt.GLCanvas.addGLEventListener | ( | final int | index, |
| final GLEventListener | listener | ||
| ) | throws IndexOutOfBoundsException |
Adds the given listener at the given index of this drawable queue.
The listeners are notified of events in the order of the queue.
The newly added listener's init(..) method will be called once before any other of it's callback methods. See getGLEventListenerInitState(GLEventListener) for details.
| 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 inserted |
| IndexOutOfBoundsException | If the index is not within (0 <= index && index <= size()), or -1 |
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1070 of file GLCanvas.java.
| void com.jogamp.opengl.awt.GLCanvas.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 in class java.awt.Component
Definition at line 572 of file GLCanvas.java.
| boolean com.jogamp.opengl.awt.GLCanvas.areAllGLEventListenerInitialized | ( | ) |
Returns true if all added GLEventListener are initialized, otherwise false.
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1085 of file GLCanvas.java.
| final boolean com.jogamp.opengl.awt.GLCanvas.canSetSurfaceScale | ( | ) |
Returns true if setSurfaceScale(float[]) is supported, otherwise false.For pure downstream scalable surfaces like AWT widgets, setting the picel scale is not supported since the pixel scale is set by the underlying toolkit.
This implementation returns false, i.e. not supporting manual change of pixel-scale.
Implements com.jogamp.nativewindow.ScalableSurface.
Definition at line 650 of file GLCanvas.java.
Creates a new context for drawing to this drawable that will optionally share buffer objects, textures and other server-side OpenGL objects with the specified GLContext.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 context sharing as well as GLSharedContextSetter. 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, boolean). The GLAutoDrawable implementation shall also set the context creation flags as customized w/ setContextCreationFlags(int).
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, boolean).
The GLAutoDrawable implementation shall also set the context creation flags as customized w/ setContextCreationFlags(int).
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 432 of file GLCanvas.java.
| void com.jogamp.opengl.awt.GLCanvas.destroy | ( | ) |
Destroys all resources associated with this GLAutoDrawable, inclusive the GLContext.If a window is attached to it's implementation, it shall be closed. Causes disposing of all OpenGL resources by calling dispose(..) for all registered GLEventListeners. Called automatically by the window system toolkit upon receiving a destroy notification. This routine may be called manually.
This impl. only destroys all GL related resources.
This impl. does not remove the GLCanvas from it's parent AWT container so this class's removeNotify() AWT override won't get called. To do so, remove this component from it's parent AWT container.
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 521 of file GLCanvas.java.
|
protected |
| void com.jogamp.opengl.awt.GLCanvas.display | ( | ) |
Causes OpenGL rendering to be performed for this GLAutoDrawable in the following order:
display(..) for all registered GLEventListeners. GLRunnable, enqueued via invoke(boolean, GLRunnable). May be called periodically by a running com.jogamp.opengl.GLAnimatorControl implementation,
which must register itself with setAnimator(com.jogamp.opengl.GLAnimatorControl).
Called automatically by the window system toolkit upon receiving a repaint() request,
except an com.jogamp.opengl.GLAnimatorControl implementation com.jogamp.opengl.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.
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 496 of file GLCanvas.java.
| GLEventListener com.jogamp.opengl.awt.GLCanvas.disposeGLEventListener | ( | final GLEventListener | listener, |
| final boolean | remove | ||
| ) |
Disposes the given listener via dispose(..) if it has been initialized and added to this queue.
If remove is true, the GLEventListener is removed from this drawable queue before disposal, otherwise marked uninitialized.
If an GLAnimatorControl is being attached and the current thread is different than the animator's thread, it is paused during the operation.
Note that this is an expensive operation, since dispose(..) is decorated by GLContext#makeCurrent() and GLContext#release().
Use removeGLEventListener(listener) instead if you just want to remove the listener and don't care about the disposal of the it's (OpenGL) resources.
Also note that 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 disposed and removed if remove is true |
| remove | pass true to have the listener removed from this drawable queue, otherwise pass false |
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1100 of file GLCanvas.java.
| void com.jogamp.opengl.awt.GLCanvas.flushGLRunnables | ( | ) |
Flushes all enqueued GLRunnable of this GLAutoDrawable including notifying waiting executor.
The executor which might have been blocked until notified will be unblocked and all tasks removed from the queue.
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1142 of file GLCanvas.java.
| GLAnimatorControl com.jogamp.opengl.awt.GLCanvas.getAnimator | ( | ) |
com.jogamp.opengl.GLAnimatorControl implementation, using this GLAutoDrawable.Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1117 of file GLCanvas.java.
| boolean com.jogamp.opengl.awt.GLCanvas.getAutoSwapBufferMode | ( | ) |
Indicates whether automatic buffer swapping is enabled for this drawable.
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1196 of file GLCanvas.java.
| GLCapabilitiesImmutable com.jogamp.opengl.awt.GLCanvas.getChosenGLCapabilities | ( | ) |
Fetches the GLCapabilitiesImmutable corresponding to the chosen OpenGL capabilities (pixel format / visual / GLProfile) for this drawable.
This query only returns the chosen capabilities if isRealized().
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.
This object shall be directly associated to the attached NativeSurface's AbstractGraphicsConfiguration, and if changes are necessary, they should reflect those as well.
Implements com.jogamp.opengl.GLDrawable.
Definition at line 1225 of file GLCanvas.java.
| GLContext com.jogamp.opengl.awt.GLCanvas.getContext | ( | ) |
Returns the context associated with this drawable.
The returned context will be synchronized. Don't rely on it's identity, the context may change.
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1166 of file GLCanvas.java.
| int com.jogamp.opengl.awt.GLCanvas.getContextCreationFlags | ( | ) |
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1215 of file GLCanvas.java.
| final float[] com.jogamp.opengl.awt.GLCanvas.getCurrentSurfaceScale | ( | final float[] | result | ) |
Returns the current pixel scale of the associated NativeSurface.
| result | float[2] storage for the result |
Implements com.jogamp.nativewindow.ScalableSurface.
Definition at line 692 of file GLCanvas.java.
| WindowClosingMode com.jogamp.opengl.awt.GLCanvas.getDefaultCloseOperation | ( | ) |
Implements com.jogamp.nativewindow.WindowClosingProtocol.
Definition at line 486 of file GLCanvas.java.
| final GLDrawable com.jogamp.opengl.awt.GLCanvas.getDelegatedDrawable | ( | ) |
If the implementation uses delegation, return the delegated GLDrawable instance, otherwise return this instance.
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1161 of file GLCanvas.java.
| final Thread com.jogamp.opengl.awt.GLCanvas.getExclusiveContextThread | ( | ) |
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1127 of file GLCanvas.java.
| GLDrawableFactory com.jogamp.opengl.awt.GLCanvas.getFactory | ( | ) |
Return the GLDrawableFactory being used to create this instance.
Implements com.jogamp.opengl.GLDrawable.
Definition at line 1271 of file GLCanvas.java.
| GL com.jogamp.opengl.awt.GLCanvas.getGL | ( | ) |
Returns the 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.
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1171 of file GLCanvas.java.
| GLEventListener com.jogamp.opengl.awt.GLCanvas.getGLEventListener | ( | final int | index | ) | throws IndexOutOfBoundsException |
Returns the GLEventListener at the given index of this drawable queue.
| index | Position of the listener to be returned. 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 -1 |
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1080 of file GLCanvas.java.
| int com.jogamp.opengl.awt.GLCanvas.getGLEventListenerCount | ( | ) |
Returns the number of GLEventListener of this drawable queue.
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1075 of file GLCanvas.java.
| boolean com.jogamp.opengl.awt.GLCanvas.getGLEventListenerInitState | ( | final GLEventListener | listener | ) |
Retrieves whether the given listener is initialized or not.
After adding a GLEventListener it is marked uninitialized and added to a list of to be initialized GLEventListener. If such uninitialized GLEventListener's handler methods (reshape, display) are about to be invoked, it's init(..) method is invoked first. Afterwards the GLEventListener is marked initialized and removed from the list of to be initialized GLEventListener.
This methods returns the GLEventListener initialized state, i.e. returns false if it is included in the list of to be initialized GLEventListener, otherwise true.
| listener | the GLEventListener object to query it's initialized state. |
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1090 of file GLCanvas.java.
| GLProfile com.jogamp.opengl.awt.GLCanvas.getGLProfile | ( | ) |
Fetches the GLProfile for this drawable.
Returns the GLProfile object, no copy.
Implements com.jogamp.opengl.GLDrawable.
Definition at line 1220 of file GLCanvas.java.
| GraphicsConfiguration com.jogamp.opengl.awt.GLCanvas.getGraphicsConfiguration | ( | ) |
Overridden to choose a GraphicsConfiguration from a parent container's GraphicsDevice.
Method also intercepts GraphicsConfiguration changes regarding to its capabilities and its GraphicsDevice. This may happen in case the display changes its configuration or the component is moved to another screen.
Definition at line 336 of file GLCanvas.java.
| long com.jogamp.opengl.awt.GLCanvas.getHandle | ( | ) |
Returns the GL drawable handle, guaranteed to be valid after realization and while it's surface is being locked.
It is usually identical to the underlying windowing toolkit surface's handle or an intermediate layer to suite GL, e.g. an EGL surface.
On EGL it is represented by the EGLSurface.
On X11/GLX it is represented by either the Window XID, GLXPixmap, or GLXPbuffer.
On Windows it is represented by the HDC, which may change with each NativeSurface#lockSurface().
Implements com.jogamp.opengl.GLDrawable.
Definition at line 1265 of file GLCanvas.java.
| float[] com.jogamp.opengl.awt.GLCanvas.getMaximumSurfaceScale | ( | final float[] | result | ) |
Returns the maximum pixel scale of the associated NativeSurface.The maximum pixel scale maybe used to determine the proper dpi value of the monitor displaying this NativeSurface.
surfacePpMM = monitorPpMM * currentSurfaceScale / nativeSurfaceScale, with PpMM == pixel per millimeter
| result | float[2] storage for the result |
Returns getCurrentSurfaceScale(float[]).
Implements com.jogamp.nativewindow.ScalableSurface.
Definition at line 717 of file GLCanvas.java.
| float[] com.jogamp.opengl.awt.GLCanvas.getMinimumSurfaceScale | ( | final float[] | result | ) |
Returns the minimum pixel scale of the associated NativeSurface.
| result | float[2] storage for the result |
Returns 1.0, always.
Implements com.jogamp.nativewindow.ScalableSurface.
Definition at line 704 of file GLCanvas.java.
| NativeSurface com.jogamp.opengl.awt.GLCanvas.getNativeSurface | ( | ) |
Returns the associated NativeSurface of this NativeSurfaceHolder.Returns the underlying NativeSurface which native handle represents this OpenGL drawable's native resource.
Returns the underlying NativeSurface which native handle represents this OpenGL drawable's native resource.
Implements com.jogamp.opengl.GLDrawable.
Definition at line 1259 of file GLCanvas.java.
| GLCapabilitiesImmutable com.jogamp.opengl.awt.GLCanvas.getRequestedGLCapabilities | ( | ) |
Fetches the GLCapabilitiesImmutable corresponding to the user requested OpenGL capabilities (pixel format / visual / GLProfile) for this drawable.
If realized, the chosen capabilities reflect the actual selected OpenGL capabilities.
Implements com.jogamp.opengl.GLDrawable.
Definition at line 1235 of file GLCanvas.java.
| final float[] com.jogamp.opengl.awt.GLCanvas.getRequestedSurfaceScale | ( | final float[] | result | ) |
Returns the requested pixel scale of the associated NativeSurface.If canSetSurfaceScale() returns false, requested pixel scale is AUTOMAX_PIXELSCALE and immutable.
| result | float[2] storage for the result |
Returns ScalableSurface#AUTOMAX_PIXELSCALE, always.
Implements com.jogamp.nativewindow.ScalableSurface.
Definition at line 685 of file GLCanvas.java.
| final boolean com.jogamp.opengl.awt.GLCanvas.getShallUseOffscreenLayer | ( | ) |
Returns the property set by setShallUseOffscreenLayer(boolean).
Implements com.jogamp.nativewindow.OffscreenLayerOption.
Definition at line 309 of file GLCanvas.java.
| int com.jogamp.opengl.awt.GLCanvas.getSurfaceHeight | ( | ) |
Returns the height of this GLDrawable's surface client area in pixel units.
Implements com.jogamp.opengl.GLDrawable.
Definition at line 1248 of file GLCanvas.java.
| int com.jogamp.opengl.awt.GLCanvas.getSurfaceWidth | ( | ) |
Returns the width of this GLDrawable's surface client area in pixel units.
Implements com.jogamp.opengl.GLDrawable.
Definition at line 1243 of file GLCanvas.java.
|
staticprotected |
Definition at line 1551 of file GLCanvas.java.
| final RecursiveLock com.jogamp.opengl.awt.GLCanvas.getUpstreamLock | ( | ) |
Returns the recursive lock object of the upstream widget to synchronize multithreaded access on top of NativeSurface#lockSurface().
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 298 of file GLCanvas.java.
| final Object com.jogamp.opengl.awt.GLCanvas.getUpstreamWidget | ( | ) |
Method may return the upstream UI toolkit object holding this GLAutoDrawable instance, if exist.
Currently known Java UI toolkits and it's known return types are:
| Toolkit | GLAutoDrawable Implementation | ~ | Return Type of getUpstreamWidget()</td |
| NEWT | com.jogamp.newt.opengl.GLWindow | has a | com.jogamp.newt.Window</td |
| SWT | com.jogamp.opengl.swt.GLCanvas | is a | org.eclipse.swt.widgets.Canvas</td |
| AWT | com.jogamp.opengl.awt.GLCanvas | is a | java.awt.Canvas</td |
| AWT | com.jogamp.opengl.awt.GLJPanel | is a | javax.swing.JPanel</td |
However, the result may be other object types than the listed above due to new supported toolkits.
This method may also return null if no UI toolkit is being used, as common for offscreen rendering.
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 293 of file GLCanvas.java.
| boolean com.jogamp.opengl.awt.GLCanvas.invoke | ( | final boolean | wait, |
| final GLRunnable | glRunnable | ||
| ) | throws IllegalStateException |
Enqueues a one-shot GLRunnable, which will be executed within the next display() call after all registered GLEventListeners display(GLAutoDrawable) methods have been called.
The given GLRunnable#run(GLAutoDrawable) shall return true to indicate that the GL [back] framebuffer remains intact by this runnable.
If returning false GLAutoDrawable will call display(GLAutoDrawable) of all registered GLEventListeners once more to reinstate the framebuffer.
If no GLAnimatorControl is animating (default),
or if the current thread is the animator thread,
a display() call is issued after enqueue the GLRunnable, hence the GLRunnable will be executed right away.
If an animator is running,
no explicit display() call is issued, allowing the animator to perform at due time.
If wait is true the call blocks until the glRunnable has been executed by the animator, otherwise the method returns immediately.
If wait is true and 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.
To avoid a deadlock situation which causes an IllegalStateException one should avoid issuing invoke while this GLAutoDrawable is being locked.
Detected deadlock situations throwing an IllegalStateException are:
Animator is running on another thread and waiting and is locked on current thread, but is not GL-Thread Animator is running on another thread and is locked on current thread, but is not GL-Thread | wait | if true block until execution of glRunnable is finished, otherwise return immediately w/o waiting |
| glRunnable | the GLRunnable to execute within display() |
true if the GLRunnable has been processed or queued, otherwise false. | IllegalStateException | in case of a detected deadlock situation ahead, see above. |
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1132 of file GLCanvas.java.
| boolean com.jogamp.opengl.awt.GLCanvas.invoke | ( | final boolean | wait, |
| final List< GLRunnable > | glRunnables | ||
| ) | throws IllegalStateException |
Extends invoke(boolean, GLRunnable) functionality allowing to inject a list of GLRunnables.
| wait | if true block until execution of the last glRunnable is finished, otherwise return immediately w/o waiting |
| glRunnables | the GLRunnables to execute within display() |
true if the GLRunnables has been processed or queued, otherwise false. | IllegalStateException | in case of a detected deadlock situation ahead, see invoke(boolean, GLRunnable). |
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1137 of file GLCanvas.java.
| boolean com.jogamp.opengl.awt.GLCanvas.isGLOriented | ( | ) |
Returns true if the drawable is rendered in OpenGL's coordinate system, origin at bottom left.
Otherwise returns false, i.e. origin at top left.
Default impl. is true, i.e. OpenGL coordinate system.
Currently only MS-Windows bitmap offscreen drawable uses a non OpenGL orientation and hence returns false.
This removes the need of a vertical flip when used in AWT or Windows applications.
Implements com.jogamp.opengl.GLDrawable.
Definition at line 1253 of file GLCanvas.java.
| final boolean com.jogamp.opengl.awt.GLCanvas.isOffscreenLayerSurfaceEnabled | ( | ) |
Returns true if this instance uses an offscreen layer, otherwise false.
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.
The return value is undefined before issuing the first NativeWindow#lockSurface().
Implements com.jogamp.nativewindow.OffscreenLayerOption.
Definition at line 314 of file GLCanvas.java.
| boolean com.jogamp.opengl.awt.GLCanvas.isRealized | ( | ) |
Returns true if this drawable is realized, otherwise false.
A drawable can be realized and unrealized via setRealized(boolean).
Implements com.jogamp.opengl.GLDrawable.
Definition at line 480 of file GLCanvas.java.
| final boolean com.jogamp.opengl.awt.GLCanvas.isThreadGLCapable | ( | ) |
Indicates whether the current thread is capable of performing OpenGL-related work.
Implementation utilizes this knowledge to determine whether display() performs the OpenGL commands on the current thread directly or spawns them on the dedicated OpenGL thread.
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 301 of file GLCanvas.java.
|
static |
A most simple JOGL AWT test entry.
Definition at line 1556 of file GLCanvas.java.
| void com.jogamp.opengl.awt.GLCanvas.paint | ( | final 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.
Definition at line 538 of file GLCanvas.java.
| void com.jogamp.opengl.awt.GLCanvas.print | ( | final Graphics | graphics | ) |
| void com.jogamp.opengl.awt.GLCanvas.releasePrint | ( | ) |
Shall be called after PrinterJob#print().
See Usage.
Implements com.jogamp.nativewindow.awt.AWTPrintLifecycle.
Definition at line 984 of file GLCanvas.java.
| GLEventListener com.jogamp.opengl.awt.GLCanvas.removeGLEventListener | ( | final GLEventListener | listener | ) |
Removes the given listener from this drawable queue.
This is an inexpensive operation, since the removed listener's dispose(..) method will not be called.
Use disposeGLEventListener(listener, true) instead to ensure disposal of the listener's (OpenGL) resources.
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 removed |
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1107 of file GLCanvas.java.
| void com.jogamp.opengl.awt.GLCanvas.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
Definition at line 806 of file GLCanvas.java.
| void com.jogamp.opengl.awt.GLCanvas.reshape | ( | final int | x, |
| final int | y, | ||
| final int | width, | ||
| final int | height | ||
| ) |
Overridden to cause GLDrawableHelper#reshape 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
Definition at line 837 of file GLCanvas.java.
| void com.jogamp.opengl.awt.GLCanvas.setAnimator | ( | final GLAnimatorControl | animatorControl | ) |
Registers the usage of an animator, an com.jogamp.opengl.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. com.jogamp.opengl.util.Animator#add(com.jogamp.opengl.GLAutoDrawable), passing it's control implementation,
and com.jogamp.opengl.util.Animator#remove(com.jogamp.opengl.GLAutoDrawable), passing null.
Impacts display() and invoke(boolean, GLRunnable) semantics.
| animatorControl | null reference indicates no animator is using this GLAutoDrawable,a valid reference indicates an animator is using this GLAutoDrawable. |
| GLException | if an animator is already registered. |
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1112 of file GLCanvas.java.
| void com.jogamp.opengl.awt.GLCanvas.setAutoSwapBufferMode | ( | final boolean | enable | ) |
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 calling swapBuffers(..) manually.
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1191 of file GLCanvas.java.
| GLContext com.jogamp.opengl.awt.GLCanvas.setContext | ( | final GLContext | newCtx, |
| final boolean | destroyPrevCtx | ||
| ) |
Associate the new context, newtCtx, to this auto-drawable.
Remarks:
destroyPrevCtx is true, otherwise it will be disassociated from this auto-drawable via setGLDrawable(null, true); including glFinish(). newCtx.setGLDrawable(drawable, true);. GLContext#makeCurrent() and GLContext#release() while drawable reassociation. auto-drawable's upstream-locks and surfaces to avoid a race condition. See GLAutoDrawable Locking. | newCtx | the new context, maybe null for dis-association. |
| destroyPrevCtx | if true, destroy the previous context if exists |
nullImplements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1147 of file GLCanvas.java.
| void com.jogamp.opengl.awt.GLCanvas.setContextCreationFlags | ( | final int | flags | ) |
| flags | Additional context creation flags. |
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1206 of file GLCanvas.java.
| WindowClosingMode com.jogamp.opengl.awt.GLCanvas.setDefaultCloseOperation | ( | final WindowClosingMode | op | ) |
| op | the new close operation value |
Implements com.jogamp.nativewindow.WindowClosingProtocol.
Definition at line 491 of file GLCanvas.java.
| final Thread com.jogamp.opengl.awt.GLCanvas.setExclusiveContextThread | ( | final Thread | t | ) | throws GLException |
Dedicates this instance's GLContext to the given thread.
The thread will exclusively claim the GLContext via display() and not release it until destroy() or setExclusiveContextThread(null) has been called.
Default non-exclusive behavior is requested via setExclusiveContextThread(null), which will cause the next call of display() on the exclusive thread to release the GLContext. Only after it's async release, getExclusiveContextThread() will return null.
To release a previous made exclusive thread, a user issues setExclusiveContextThread(null) and may poll getExclusiveContextThread() until it returns null, while the exclusive thread is still running.
Note: Setting a new exclusive thread without properly releasing a previous one will throw an GLException.
Note: Utilizing this feature w/ AWT could lead to an AWT-EDT deadlock, depending on the AWT implementation. Hence it is advised not to use it with native AWT GLAutoDrawable like GLCanvas.
One scenario could be to dedicate the context to the animator thread and spare redundant context switches, see com.jogamp.opengl.util.AnimatorBase#setExclusiveContext(boolean).
| t | the exclusive thread to claim the context, or null for default operation. |
| GLException | If an exclusive thread is still active but a new one is attempted to be set |
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1122 of file GLCanvas.java.
Sets the 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.
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1180 of file GLCanvas.java.
| void com.jogamp.opengl.awt.GLCanvas.setGLEventListenerInitState | ( | final GLEventListener | listener, |
| final boolean | initialized | ||
| ) |
Sets the given listener's initialized state.
This methods allows manually setting the GLEventListener initialized state, i.e. adding it to, or removing it from the list of to be initialized GLEventListener. See getGLEventListenerInitState(GLEventListener) for details.
Warning: This method does not validate whether the given listener's is member of this drawable queue, i.e. added.
This method is only exposed to allow users full control over the GLEventListener's state and is usually not recommended to change.
One use case is moving a GLContext and their initialized GLEventListener from one GLAutoDrawable to another, where a subsequent init(..) call after adding it to the new owner is neither required nor desired. See swapGLContextAndAllGLEventListener(..).
| listener | the GLEventListener object to perform a state change. |
| initialized | if true, mark the listener initialized, otherwise uninitialized. |
Implements com.jogamp.opengl.GLAutoDrawable.
Definition at line 1095 of file GLCanvas.java.
| final void com.jogamp.opengl.awt.GLCanvas.setRealized | ( | final boolean | realized | ) |
Indicates to GLDrawable implementations whether the underlying surface has been created and can be drawn into.
If realized, the drawable handle may become valid while it's surface is being locked.
End users do not need to call this method; it is not necessary to call setRealized on a GLAutoDrawable 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#createGLDrawable(NativeSurface) 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 successful:
GLCapabilities, which are associated with the attached NativeSurface's AbstractGraphicsConfiguration. NativeSurface's unlockSurface().
This is important since 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.
Implements com.jogamp.opengl.GLDrawable.
Definition at line 474 of file GLCanvas.java.
| void com.jogamp.opengl.awt.GLCanvas.setShallUseOffscreenLayer | ( | final boolean | v | ) |
Request an offscreen layer, if supported.
Shall be called before the first NativeWindow#lockSurface(), and hence before realization.
Implements com.jogamp.nativewindow.OffscreenLayerOption.
Definition at line 304 of file GLCanvas.java.
| final void com.jogamp.opengl.awt.GLCanvas.setSharedAutoDrawable | ( | final GLAutoDrawable | sharedAutoDrawable | ) | throws IllegalStateException |
Specifies an GLAutoDrawable, which OpenGL context shall be shared by this GLAutoDrawable's GLContext.
Since the drawable and context is created at GLAutoDrawable initialization this method shall be called beforehand to have any effect.
A set sharedAutoDrawable will block context creation, i.e. initialization as long it's
GLContext is null, or GLContext has not been created natively, or GLEventListener are not completely initialized | sharedContext | The GLAutoDrawable, which OpenGL context shall be shared by this GLAutoDrawable's GLContext. |
| IllegalStateException | if a shared GLContext or shared GLAutoDrawable is already set, the given sharedAutoDrawable is null or equal to this GLAutoDrawable. |
Implements com.jogamp.opengl.GLSharedContextSetter.
Definition at line 288 of file GLCanvas.java.
| final void com.jogamp.opengl.awt.GLCanvas.setSharedContext | ( | final GLContext | sharedContext | ) | throws IllegalStateException |
Specifies an OpenGL context, which shall be shared by this GLAutoDrawable's GLContext.
Since the drawable and context is created at GLAutoDrawable initialization this method shall be called beforehand to have any effect.
A set sharedContext will block context creation, i.e. GLAutoDrawable initialization, as long it is not created natively.
The preferred method of assigning a shared context is to set the shared GLAutoDrawable, since this method also takes the GLEventListener initialization into account.
| sharedContext | The OpenGL context to be shared by this GLAutoDrawable's GLContext. |
| IllegalStateException | if a shared GLContext or shared GLAutoDrawable is already set, the given sharedContext is null or equal to this GLAutoDrawable's context. |
Implements com.jogamp.opengl.GLSharedContextSetter.
Definition at line 283 of file GLCanvas.java.
| final boolean com.jogamp.opengl.awt.GLCanvas.setSurfaceScale | ( | final float[] | pixelScale | ) |
Request a pixel scale in x- and y-direction for the associated NativeSurface, where size_in_pixel_units = pixel_scale * size_in_window_units.Default pixel scale request for both directions is AUTOMAX_PIXELSCALE. If canSetSurfaceScale() returns false, requested pixel scale is AUTOMAX_PIXELSCALE, immutable and method returns false. In case platform only supports uniform pixel scale, i.e. one scale for both directions, either AUTOMAX_PIXELSCALE or the maximum requested pixel scale component is used. The requested pixel scale will be validated against platform limits before native scale-setup, i.e. clipped to IDENTITY_PIXELSCALE if not supported or clipped to the platform maximum. It can be queried via getRequestedSurfaceScale(float[]). The actual realized pixel scale values of the NativeSurface can be queried via getCurrentSurfaceScale(float[]) or computed via surface. convertToPixelUnits(new int[] { 1, 1 })
| pixelScale | requested surface pixel scale float[2] values for x- and y-direction. |
true if the current pixel scale has changed, otherwise false. Ignored for an AWT widget since pixelScale is dictated by AWT mechanisms.
Implements com.jogamp.nativewindow.ScalableSurface.
Definition at line 659 of file GLCanvas.java.
| void com.jogamp.opengl.awt.GLCanvas.setupPrint | ( | final double | scaleMatX, |
| final double | scaleMatY, | ||
| final int | numSamples, | ||
| final int | tileWidth, | ||
| final int | tileHeight | ||
| ) |
Shall be called before PrinterJob#print().
See Usage.
| scaleMatX | Graphics2D scaling factor, i.e. rendering 1/scaleMatX * width pixels |
| scaleMatY | Graphics2D scaling factor, i.e. rendering 1/scaleMatY * height pixels |
| numSamples | multisampling value: < 0 turns off, == 0 leaves as-is, > 0 enables using given num samples |
| tileWidth | custom tile width for tile renderer, pass -1 for default. |
| tileHeight | custom tile height for tile renderer, pass -1 for default. FIXME: Add border size ! |
Implements com.jogamp.nativewindow.awt.AWTPrintLifecycle.
Definition at line 890 of file GLCanvas.java.
| void com.jogamp.opengl.awt.GLCanvas.swapBuffers | ( | ) |
Swaps the front and back buffers of this drawable.
For GLAutoDrawable 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.
Implements com.jogamp.opengl.GLDrawable.
Definition at line 1201 of file GLCanvas.java.
| String com.jogamp.opengl.awt.GLCanvas.toString | ( | ) |
Implements com.jogamp.opengl.GLDrawable.
Definition at line 1277 of file GLCanvas.java.
| void com.jogamp.opengl.awt.GLCanvas.update | ( | final Graphics | g | ) |
Overridden from Canvas to prevent the AWT's clearing of the canvas from interfering with the OpenGL rendering.
Definition at line 880 of file GLCanvas.java.