JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.opengl.awt.GLJPanel Class Reference

A lightweight Swing component which provides OpenGL rendering support. More...

Inheritance diagram for com.jogamp.opengl.awt.GLJPanel:
Collaboration diagram for com.jogamp.opengl.awt.GLJPanel:

Classes

interface  Backend
 Abstraction of the different rendering backends: i.e., pure software / pixmap rendering, pbuffer-based acceleration, Java 2D JOGL bridge.
 
class  J2DOGLBackend
 
class  OffscreenBackend
 
class  Updater
 

Public Member Functions

 GLJPanel () throws GLException
 Creates a new GLJPanel component with a default set of OpenGL capabilities and using the default OpenGL capabilities selection mechanism. More...
 
 GLJPanel (final GLCapabilitiesImmutable userCapsRequest) throws GLException
 Creates a new GLJPanel component with the requested set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism. More...
 
 GLJPanel (final GLCapabilitiesImmutable userCapsRequest, final GLCapabilitiesChooser chooser) throws GLException
 Creates a new GLJPanel component. More...
 
final boolean initializeBackend (final boolean offthread)
 Attempts to initialize the backend, if not initialized yet. 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...
 
AWTGLPixelBufferProvider getCustomPixelBufferProvider ()
 
void setPixelBufferProvider (final AWTGLPixelBufferProvider custom) throws IllegalArgumentException, IllegalStateException
 
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 display ()
 
void destroy ()
 Just an alias for removeNotify. 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.convertToPixelUnits(new int[] { 1, 1 })
Parameters
pixelScalerequested surface pixel scale float[2] values for x- and y-direction.
Returns
true if the current pixel scale has changed, otherwise false.
See also
getRequestedSurfaceScale(float[])
canSetSurfaceScale()
More...
 
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.
Parameters
resultfloat[2] storage for the result
Returns
the passed storage containing the current pixelScale for chaining
See also
setSurfaceScale(float[])
canSetSurfaceScale()
More...
 
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.
Parameters
resultfloat[2] storage for the result
Returns
the passed storage containing the minimum pixelScale for chaining
More...
 
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
Parameters
resultfloat[2] storage for the result
Returns
the passed storage containing the maximum pixelScale for chaining
More...
 
void addNotify ()
 Overridden to track when this component is added to a container. More...
 
void removeNotify ()
 Overridden to track when this component is removed from a container. More...
 
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 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 setOpaque (final boolean opaque)
 
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)
 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 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...
 
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...
 
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 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 swapBuffers ()
 Swaps the front and back buffers of this drawable. More...
 
void setContextCreationFlags (final int flags)
 
int getContextCreationFlags ()
 
boolean shouldPreserveColorBufferIfTranslucent ()
 For a translucent GLJPanel (one for which setOpaque(false) has been called), indicates whether the application should preserve the OpenGL color buffer (GL_COLOR_BUFFER_BIT) for correct rendering of the GLJPanel and underlying widgets which may show through portions of the GLJPanel with alpha values less than 1. 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.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. More...
 
final void setSkipGLOrientationVerticalFlip (final boolean v)
 Skip isGLOriented() based vertical flip, which usually is required by the offscreen backend, see details about vertical flip and FBO / GLSL vertical flip. More...
 
final boolean getSkipGLOrientationVerticalFlip ()
 See setSkipGLOrientationVerticalFlip(boolean). More...
 
final void setUseGLSLVerticalFlip (final boolean v)
 Toggle using GLSL texture renderer for the isGLOriented() based vertical flip, which usually is required by the offscreen backend, see details about vertical flip and FBO / GLSL vertical flip. More...
 
final boolean getUseGLSLVerticalFlip ()
 See setUseGLSLVerticalFlip(boolean). More...
 
GLCapabilitiesImmutable getChosenGLCapabilities ()
 Fetches the GLCapabilitiesImmutable corresponding to the chosen OpenGL capabilities (pixel format / visual / GLProfile) for this drawable. More...
 
final GLCapabilitiesImmutable getRequestedGLCapabilities ()
 Fetches the GLCapabilitiesImmutable corresponding to the user requested OpenGL capabilities (pixel format / visual / GLProfile) for this drawable. More...
 
final void setRequestedGLCapabilities (final GLCapabilitiesImmutable caps)
 Set a new requested GLCapabilitiesImmutable for this GLJPanel allowing reconfiguration. More...
 
final GLProfile getGLProfile ()
 Fetches the GLProfile for this drawable. More...
 
NativeSurface getNativeSurface ()
 Returns the associated NativeSurface of this NativeSurfaceHolder.Returns the underlying NativeSurface which native handle represents this OpenGL drawable's native resource.
See also
getHandle()
More...
 
long getHandle ()
 Returns the GL drawable handle, guaranteed to be valid after realization and while it's surface is being locked. More...
 
final GLDrawableFactory getFactory ()
 Return the GLDrawableFactory being used to create this instance. More...
 
final int getTextureUnit ()
 Returns the used texture unit, i.e. More...
 
final void setTextureUnit (final int v)
 Allows user to request a texture unit to be used, must be called before the first initialization, i.e. More...
 
WindowClosingMode getDefaultCloseOperation ()
 
WindowClosingMode setDefaultCloseOperation (final WindowClosingMode op)
 
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 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...
 

Protected Member Functions

void dispose (final Runnable post)
 
void paintComponent (final Graphics g)
 Overridden to cause OpenGL rendering to be performed during repaint cycles. More...
 
void printComponent (final Graphics g)
 

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...
 

Detailed Description

A lightweight Swing component which provides OpenGL rendering support.

Provided for compatibility with Swing user interfaces when adding a heavyweight doesn't work either because of Z-ordering or LayoutManager problems.

The GLJPanel can be made transparent by creating it with a GLCapabilities object with alpha bits specified and calling setOpaque(false). Pixels with resulting OpenGL alpha values less than 1.0 will be overlaid on any underlying Swing rendering.

This component attempts to use hardware-accelerated rendering via FBO or pbuffers and falls back on to software rendering if none of the former are available using GLDrawableFactory.createOffscreenDrawable(..).

A vertical-flip is required, if the drawable isGLOriented() and vertical flip is not skipped.
In this case this component performs the required vertical flip to bring the content from OpenGL's orientation into AWT's orientation.
In case GLSL based vertical-flip is not available or disabled, the CPU intensive System.arraycopy(..) is used line by line. See details about FBO and GLSL vertical flipping.

For performance reasons, as well as for GL state sideeffects, skipping vertical flip is highly recommended!

The OpenGL path is concluded by copying the rendered pixels an BufferedImage via glReadPixels(..) for later Java2D composition.

Finally the Java2D compositioning takes place via via Graphics.drawImage(...) on the prepared BufferedImage as described above.

Please read Java2D OpenGL Remarks.

FBO / GLSL Vertical Flip

If vertical flip is required, FBO is used, GLSL is available and vertical flip is not skipped, a fragment shader is utilized to flip the FBO texture vertically by default. This hardware-accelerated step can be disabled via system property jogl.gljpanel.noglsl or by setUseGLSLVerticalFlip(false).

The FBO / GLSL code path uses one texture-unit and binds the FBO texture to it's active texture-target, see setTextureUnit(int) and getTextureUnit().

The active and dedicated texture-unit's GL#GL_TEXTURE_2D state is preserved via TextureState. See also Order of Texture Commands.

The current gl-viewport is preserved.

Warning (Bug 842): Certain GL states other than viewport and texture (see above) influencing rendering, will also influence the GLSL vertical flip, e.g. glFrontFace(GL#GL_CCW). It is recommended to reset those states to default when leaving the GLEventListener#display(GLAutoDrawable) method! We may change this behavior in the future, i.e. preserve all influencing states.

OpenGL Context Sharing

To share a GLContext see the following note in the documentation overview: context sharing as well as GLSharedContextSetter.

Definition at line 189 of file GLJPanel.java.

Constructor & Destructor Documentation

◆ GLJPanel() [1/3]

com.jogamp.opengl.awt.GLJPanel.GLJPanel ( ) throws GLException

Creates a new GLJPanel component with a default set of OpenGL capabilities and using the default OpenGL capabilities selection mechanism.

See details about OpenGL context sharing.

Exceptions
GLExceptionif no default profile is available for the default desktop device.

Definition at line 322 of file GLJPanel.java.

◆ GLJPanel() [2/3]

com.jogamp.opengl.awt.GLJPanel.GLJPanel ( final GLCapabilitiesImmutable  userCapsRequest) throws GLException

Creates a new GLJPanel component with the requested set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism.

See details about OpenGL context sharing.

Exceptions
GLExceptionif no GLCapabilities are given and no default profile is available for the default desktop device.

Definition at line 334 of file GLJPanel.java.

◆ GLJPanel() [3/3]

com.jogamp.opengl.awt.GLJPanel.GLJPanel ( final GLCapabilitiesImmutable  userCapsRequest,
final GLCapabilitiesChooser  chooser 
) throws GLException

Creates a new GLJPanel 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.

See details about OpenGL context sharing.

Exceptions
GLExceptionif no GLCapabilities are given and no default profile is available for the default desktop device.

Definition at line 349 of file GLJPanel.java.

Here is the call graph for this function:

Member Function Documentation

◆ addGLEventListener() [1/2]

void com.jogamp.opengl.awt.GLJPanel.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.

Parameters
listenerThe GLEventListener object to be inserted

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 989 of file GLJPanel.java.

Here is the caller graph for this function:

◆ addGLEventListener() [2/2]

void com.jogamp.opengl.awt.GLJPanel.addGLEventListener ( final int  index,
final GLEventListener  listener 
)

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.

Parameters
indexPosition 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().
listenerThe GLEventListener object to be inserted
Exceptions
IndexOutOfBoundsExceptionIf the index is not within (0 <= index && index <= size()), or -1

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 994 of file GLJPanel.java.

◆ addNotify()

void com.jogamp.opengl.awt.GLJPanel.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.

addNotify in class java.awt.Component

Definition at line 690 of file GLJPanel.java.

Here is the call graph for this function:

◆ areAllGLEventListenerInitialized()

boolean com.jogamp.opengl.awt.GLJPanel.areAllGLEventListenerInitialized ( )

Returns true if all added GLEventListener are initialized, otherwise false.

Since
2.2

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 1009 of file GLJPanel.java.

◆ canSetSurfaceScale()

final boolean com.jogamp.opengl.awt.GLJPanel.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 610 of file GLJPanel.java.

◆ createContext()

GLContext com.jogamp.opengl.awt.GLJPanel.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).

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 1081 of file GLJPanel.java.

◆ destroy()

void com.jogamp.opengl.awt.GLJPanel.destroy ( )

Just an alias for removeNotify.

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 531 of file GLJPanel.java.

Here is the caller graph for this function:

◆ display()

void com.jogamp.opengl.awt.GLJPanel.display ( )

Causes OpenGL rendering to be performed for this GLAutoDrawable in the following order:

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.

See also
setAnimator(com.jogamp.opengl.GLAnimatorControl)

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 463 of file GLJPanel.java.

Here is the caller graph for this function:

◆ dispose()

void com.jogamp.opengl.awt.GLJPanel.dispose ( final Runnable  post)
protected

Definition at line 480 of file GLJPanel.java.

Here is the call graph for this function:

◆ disposeGLEventListener()

GLEventListener com.jogamp.opengl.awt.GLJPanel.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.

Parameters
listenerThe GLEventListener object to be disposed and removed if remove is true
removepass true to have the listener removed from this drawable queue, otherwise pass false
Returns
the disposed and/or removed GLEventListener, or null if no action was performed, i.e. listener was not added

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 1024 of file GLJPanel.java.

Here is the caller graph for this function:

◆ flushGLRunnables()

void com.jogamp.opengl.awt.GLJPanel.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.

See also
invoke(boolean, GLRunnable)
Since
2.2

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 1076 of file GLJPanel.java.

◆ getAnimator()

GLAnimatorControl com.jogamp.opengl.awt.GLJPanel.getAnimator ( )

◆ getAutoSwapBufferMode()

boolean com.jogamp.opengl.awt.GLJPanel.getAutoSwapBufferMode ( )

Indicates whether automatic buffer swapping is enabled for this drawable.

See setAutoSwapBufferMode.

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 1176 of file GLJPanel.java.

◆ getChosenGLCapabilities()

GLCapabilitiesImmutable com.jogamp.opengl.awt.GLJPanel.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.

Returns
The immutable queried instance.
See also
getRequestedGLCapabilities()

Implements com.jogamp.opengl.GLDrawable.

Definition at line 1275 of file GLJPanel.java.

Here is the caller graph for this function:

◆ getContext()

GLContext com.jogamp.opengl.awt.GLJPanel.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 1133 of file GLJPanel.java.

Here is the caller graph for this function:

◆ getContextCreationFlags()

int com.jogamp.opengl.awt.GLJPanel.getContextCreationFlags ( )
Returns
Additional context creation flags

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 1196 of file GLJPanel.java.

◆ getCurrentSurfaceScale()

final float[] com.jogamp.opengl.awt.GLJPanel.getCurrentSurfaceScale ( final float[]  result)

Returns the current pixel scale of the associated NativeSurface.

Parameters
resultfloat[2] storage for the result
Returns
the passed storage containing the current pixelScale for chaining

Implements com.jogamp.nativewindow.ScalableSurface.

Definition at line 653 of file GLJPanel.java.

Here is the caller graph for this function:

◆ getCustomPixelBufferProvider()

AWTGLPixelBufferProvider com.jogamp.opengl.awt.GLJPanel.getCustomPixelBufferProvider ( )

Definition at line 434 of file GLJPanel.java.

◆ getDefaultCloseOperation()

WindowClosingMode com.jogamp.opengl.awt.GLJPanel.getDefaultCloseOperation ( )
Returns
the current close operation value
See also
WindowClosingMode::DISPOSE_ON_CLOSE
WindowClosingMode::DO_NOTHING_ON_CLOSE

Implements com.jogamp.nativewindow.WindowClosingProtocol.

Definition at line 1433 of file GLJPanel.java.

Here is the call graph for this function:

◆ getDelegatedDrawable()

final GLDrawable com.jogamp.opengl.awt.GLJPanel.getDelegatedDrawable ( )

If the implementation uses delegation, return the delegated GLDrawable instance, otherwise return this instance.

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 1124 of file GLJPanel.java.

◆ getExclusiveContextThread()

final Thread com.jogamp.opengl.awt.GLJPanel.getExclusiveContextThread ( )

◆ getFactory()

final GLDrawableFactory com.jogamp.opengl.awt.GLJPanel.getFactory ( )

Return the GLDrawableFactory being used to create this instance.

Implements com.jogamp.opengl.GLDrawable.

Definition at line 1344 of file GLJPanel.java.

◆ getGL()

GL com.jogamp.opengl.awt.GLJPanel.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 1142 of file GLJPanel.java.

Here is the call graph for this function:

◆ getGLEventListener()

GLEventListener com.jogamp.opengl.awt.GLJPanel.getGLEventListener ( final int  index) throws IndexOutOfBoundsException

Returns the GLEventListener at the given index of this drawable queue.

Parameters
indexPosition 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.
Returns
The GLEventListener object at the given index.
Exceptions
IndexOutOfBoundsExceptionIf the index is not within (0 <= index && index < size()), or -1

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 1004 of file GLJPanel.java.

◆ getGLEventListenerCount()

int com.jogamp.opengl.awt.GLJPanel.getGLEventListenerCount ( )

Returns the number of GLEventListener of this drawable queue.

Returns
The number of GLEventListener objects of this drawable queue.

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 999 of file GLJPanel.java.

◆ getGLEventListenerInitState()

boolean com.jogamp.opengl.awt.GLJPanel.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.

Parameters
listenerthe GLEventListener object to query it's initialized state.

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 1014 of file GLJPanel.java.

◆ getGLProfile()

final GLProfile com.jogamp.opengl.awt.GLJPanel.getGLProfile ( )

Fetches the GLProfile for this drawable.

Returns the GLProfile object, no copy.

Implements com.jogamp.opengl.GLDrawable.

Definition at line 1321 of file GLJPanel.java.

Here is the call graph for this function:

◆ getHandle()

long com.jogamp.opengl.awt.GLJPanel.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().

See also
setRealized(boolean)
NativeSurface::lockSurface()
NativeSurface::unlockSurface()

Implements com.jogamp.opengl.GLDrawable.

Definition at line 1335 of file GLJPanel.java.

◆ getMaximumSurfaceScale()

float[] com.jogamp.opengl.awt.GLJPanel.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
Parameters
resultfloat[2] storage for the result
Returns
the passed storage containing the maximum pixelScale for chaining

Returns getCurrentSurfaceScale(float[]).

Implements com.jogamp.nativewindow.ScalableSurface.

Definition at line 678 of file GLJPanel.java.

Here is the caller graph for this function:

◆ getMinimumSurfaceScale()

float[] com.jogamp.opengl.awt.GLJPanel.getMinimumSurfaceScale ( final float[]  result)

Returns the minimum pixel scale of the associated NativeSurface.

Parameters
resultfloat[2] storage for the result
Returns
the passed storage containing the minimum pixelScale for chaining

Returns 1.0, always.

Implements com.jogamp.nativewindow.ScalableSurface.

Definition at line 665 of file GLJPanel.java.

Here is the caller graph for this function:

◆ getNativeSurface()

NativeSurface com.jogamp.opengl.awt.GLJPanel.getNativeSurface ( )

Returns the associated NativeSurface of this NativeSurfaceHolder.Returns the underlying NativeSurface which native handle represents this OpenGL drawable's native resource.

See also
getHandle()

Returns the underlying NativeSurface which native handle represents this OpenGL drawable's native resource.

See also
getHandle()

Implements com.jogamp.opengl.GLDrawable.

Definition at line 1326 of file GLJPanel.java.

◆ getRequestedGLCapabilities()

final GLCapabilitiesImmutable com.jogamp.opengl.awt.GLJPanel.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.

Returns
The immutable queried instance.
See also
getChosenGLCapabilities()
Since
2.2

Implements com.jogamp.opengl.GLDrawable.

Definition at line 1284 of file GLJPanel.java.

◆ getRequestedSurfaceScale()

final float[] com.jogamp.opengl.awt.GLJPanel.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.

Parameters
resultfloat[2] storage for the result
Returns
the passed storage containing the current pixelScale for chaining
See also
setSurfaceScale(float[])
canSetSurfaceScale()

Returns ScalableSurface#AUTOMAX_PIXELSCALE, always.

Implements com.jogamp.nativewindow.ScalableSurface.

Definition at line 646 of file GLJPanel.java.

Here is the caller graph for this function:

◆ getSkipGLOrientationVerticalFlip()

final boolean com.jogamp.opengl.awt.GLJPanel.getSkipGLOrientationVerticalFlip ( )

◆ getSurfaceHeight()

int com.jogamp.opengl.awt.GLJPanel.getSurfaceHeight ( )

Returns the height of this GLDrawable's surface client area in pixel units.

See also
NativeSurface::getSurfaceHeight()

Implements com.jogamp.opengl.GLDrawable.

Definition at line 1222 of file GLJPanel.java.

Here is the caller graph for this function:

◆ getSurfaceWidth()

int com.jogamp.opengl.awt.GLJPanel.getSurfaceWidth ( )

Returns the width of this GLDrawable's surface client area in pixel units.

See also
NativeSurface::getSurfaceWidth()

Implements com.jogamp.opengl.GLDrawable.

Definition at line 1217 of file GLJPanel.java.

Here is the caller graph for this function:

◆ getTextureUnit()

final int com.jogamp.opengl.awt.GLJPanel.getTextureUnit ( )

Returns the used texture unit, i.e.

a value of [0..n], or -1 if non used.

If implementation uses a texture-unit, it will be known only after the first initialization, i.e. display call.

See FBO / GLSL Vertical Flip.

Definition at line 1357 of file GLJPanel.java.

◆ getThreadName()

static String com.jogamp.opengl.awt.GLJPanel.getThreadName ( )
staticprotected

Definition at line 1606 of file GLJPanel.java.

◆ getUpstreamLock()

final RecursiveLock com.jogamp.opengl.awt.GLJPanel.getUpstreamLock ( )

Returns the recursive lock object of the upstream widget to synchronize multithreaded access on top of NativeSurface#lockSurface().

See GLAutoDrawable Locking.

Since
2.2

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 457 of file GLJPanel.java.

◆ getUpstreamWidget()

final Object com.jogamp.opengl.awt.GLJPanel.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 452 of file GLJPanel.java.

◆ getUseGLSLVerticalFlip()

final boolean com.jogamp.opengl.awt.GLJPanel.getUseGLSLVerticalFlip ( )

See setUseGLSLVerticalFlip(boolean).

Definition at line 1272 of file GLJPanel.java.

◆ initializeBackend()

final boolean com.jogamp.opengl.awt.GLJPanel.initializeBackend ( final boolean  offthread)

Attempts to initialize the backend, if not initialized yet.

If backend is already initialized method returns true.

If offthread is true, initialization will kicked off on a short lived arbitrary thread and method returns immediately.
If platform supports such arbitrary thread initialization method returns true, otherwise false.

If offthread is false, initialization be performed on the current thread and method returns after initialization.
Method returns true if initialization was successful, otherwise false.

Parameters
offthread

Definition at line 405 of file GLJPanel.java.

◆ invoke() [1/2]

boolean com.jogamp.opengl.awt.GLJPanel.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
  • No Animator is running on another thread and is locked on current thread, but is not GL-Thread
Parameters
waitif true block until execution of glRunnable is finished, otherwise return immediately w/o waiting
glRunnablethe GLRunnable to execute within display()
Returns
true if the GLRunnable has been processed or queued, otherwise false.
Exceptions
IllegalStateExceptionin case of a detected deadlock situation ahead, see above.
See also
setAnimator(GLAnimatorControl)
display()
GLRunnable
#invoke(boolean, List)
flushGLRunnables()

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 1066 of file GLJPanel.java.

◆ invoke() [2/2]

boolean com.jogamp.opengl.awt.GLJPanel.invoke ( final boolean  wait,
final List< GLRunnable glRunnables 
) throws IllegalStateException

Extends invoke(boolean, GLRunnable) functionality allowing to inject a list of GLRunnables.

Parameters
waitif true block until execution of the last glRunnable is finished, otherwise return immediately w/o waiting
glRunnablesthe GLRunnables to execute within display()
Returns
true if the GLRunnables has been processed or queued, otherwise false.
Exceptions
IllegalStateExceptionin case of a detected deadlock situation ahead, see invoke(boolean, GLRunnable).
See also
invoke(boolean, GLRunnable)
flushGLRunnables()

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 1071 of file GLJPanel.java.

◆ isGLOriented()

boolean com.jogamp.opengl.awt.GLJPanel.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.

Method returns a valid value only after the backend has been initialized, either eagerly or manually via the first display call.
Method always returns a valid value when called from within a GLEventListener.

Implements com.jogamp.opengl.GLDrawable.

Definition at line 1236 of file GLJPanel.java.

◆ isRealized()

boolean com.jogamp.opengl.awt.GLJPanel.isRealized ( )

Returns true if this drawable is realized, otherwise false.

A drawable can be realized and unrealized via setRealized(boolean).

See also
setRealized(boolean)

Implements com.jogamp.opengl.GLDrawable.

Definition at line 1100 of file GLJPanel.java.

◆ isThreadGLCapable()

final boolean com.jogamp.opengl.awt.GLJPanel.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.

Since
2.2

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 460 of file GLJPanel.java.

◆ paintComponent()

void com.jogamp.opengl.awt.GLJPanel.paintComponent ( final Graphics  g)
protected

Overridden to cause OpenGL rendering to be performed during repaint cycles.

Subclasses which override this method must call super.paintComponent() in their paintComponent() method in order to function properly.

paintComponent in class javax.swing.JComponent

Definition at line 542 of file GLJPanel.java.

◆ print()

void com.jogamp.opengl.awt.GLJPanel.print ( final Graphics  graphics)

Definition at line 929 of file GLJPanel.java.

Here is the call graph for this function:

◆ printComponent()

void com.jogamp.opengl.awt.GLJPanel.printComponent ( final Graphics  g)
protected

Definition at line 973 of file GLJPanel.java.

◆ releasePrint()

void com.jogamp.opengl.awt.GLJPanel.releasePrint ( )

Shall be called after PrinterJob#print().

See Usage.

Implements com.jogamp.nativewindow.awt.AWTPrintLifecycle.

Definition at line 870 of file GLJPanel.java.

◆ removeGLEventListener()

GLEventListener com.jogamp.opengl.awt.GLJPanel.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.

Parameters
listenerThe GLEventListener object to be removed
Returns
the removed GLEventListener, or null if listener was not added

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 1041 of file GLJPanel.java.

◆ removeNotify()

void com.jogamp.opengl.awt.GLJPanel.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.

removeNotify in class java.awt.Component

Definition at line 722 of file GLJPanel.java.

Here is the call graph for this function:

◆ reshape()

void com.jogamp.opengl.awt.GLJPanel.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.

Definition at line 741 of file GLJPanel.java.

◆ setAnimator()

void com.jogamp.opengl.awt.GLJPanel.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.


Parameters
animatorControlnull reference indicates no animator is using this GLAutoDrawable,
a valid reference indicates an animator is using this GLAutoDrawable.
Exceptions
GLExceptionif an animator is already registered.
See also
display()
invoke(boolean, GLRunnable)
com.jogamp.opengl.GLAnimatorControl

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 1046 of file GLJPanel.java.

◆ setAutoSwapBufferMode()

void com.jogamp.opengl.awt.GLJPanel.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 1161 of file GLJPanel.java.

◆ setContext()

GLContext com.jogamp.opengl.awt.GLJPanel.setContext ( final GLContext  newCtx,
final boolean  destroyPrevCtx 
)

Associate the new context, newtCtx, to this auto-drawable.

Remarks:

Parameters
newCtxthe new context, maybe null for dis-association.
destroyPrevCtxif true, destroy the previous context if exists
Returns
the previous GLContext, maybe null
See also
GLContext::setGLDrawable(GLDrawable, boolean)
GLContext::setGLReadDrawable(GLDrawable)
jogamp.opengl.GLDrawableHelper::switchContext(GLDrawable, GLContext, boolean, GLContext, int)

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 1105 of file GLJPanel.java.

◆ setContextCreationFlags()

void com.jogamp.opengl.awt.GLJPanel.setContextCreationFlags ( final int  flags)
Parameters
flagsAdditional context creation flags.
See also
GLContext::setContextCreationFlags(int)
GLContext::enableGLDebugMessage(boolean)

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 1191 of file GLJPanel.java.

◆ setDefaultCloseOperation()

WindowClosingMode com.jogamp.opengl.awt.GLJPanel.setDefaultCloseOperation ( final WindowClosingMode  op)
Parameters
opthe new close operation value
Returns
the previous close operation value
See also
WindowClosingMode::DISPOSE_ON_CLOSE
WindowClosingMode::DO_NOTHING_ON_CLOSE

Implements com.jogamp.nativewindow.WindowClosingProtocol.

Definition at line 1438 of file GLJPanel.java.

Here is the call graph for this function:

◆ setExclusiveContextThread()

final Thread com.jogamp.opengl.awt.GLJPanel.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).

Parameters
tthe exclusive thread to claim the context, or null for default operation.
Returns
previous exclusive context thread
Exceptions
GLExceptionIf an exclusive thread is still active but a new one is attempted to be set
See also
com.jogamp.opengl.util.AnimatorBase::setExclusiveContext(boolean)

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 1056 of file GLJPanel.java.

◆ setGL()

GL com.jogamp.opengl.awt.GLJPanel.setGL ( final GL  gl)

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.

Returns
the set GL pipeline or null if not successful

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 1151 of file GLJPanel.java.

Here is the call graph for this function:

◆ setGLEventListenerInitState()

void com.jogamp.opengl.awt.GLJPanel.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(..).

Parameters
listenerthe GLEventListener object to perform a state change.
initializedif true, mark the listener initialized, otherwise uninitialized.

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 1019 of file GLJPanel.java.

◆ setOpaque()

void com.jogamp.opengl.awt.GLJPanel.setOpaque ( final boolean  opaque)

Definition at line 981 of file GLJPanel.java.

Here is the caller graph for this function:

◆ setPixelBufferProvider()

void com.jogamp.opengl.awt.GLJPanel.setPixelBufferProvider ( final AWTGLPixelBufferProvider  custom) throws IllegalArgumentException, IllegalStateException
Parameters
customcustom AWTGLPixelBufferProvider
Exceptions
IllegalArgumentExceptionif custom is null
IllegalStateExceptionif backend is already realized, i.e. this instanced already painted once.

Definition at line 441 of file GLJPanel.java.

◆ setRealized()

void com.jogamp.opengl.awt.GLJPanel.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:


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.

See also
isRealized()
getHandle()
NativeSurface::lockSurface()

Implements com.jogamp.opengl.GLDrawable.

Definition at line 1096 of file GLJPanel.java.

◆ setRequestedGLCapabilities()

final void com.jogamp.opengl.awt.GLJPanel.setRequestedGLCapabilities ( final GLCapabilitiesImmutable  caps)

Set a new requested GLCapabilitiesImmutable for this GLJPanel allowing reconfiguration.

Method shall be invoked from the AWT-EDT thread. In case it is not invoked on the AWT-EDT thread, an attempt is made to do so.

Method will dispose a previous realized GLContext and offscreen backend!

Parameters
capsnew capabilities.

Definition at line 1300 of file GLJPanel.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setSharedAutoDrawable()

final void com.jogamp.opengl.awt.GLJPanel.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

See Lifecycle Considerations.

Parameters
sharedContextThe GLAutoDrawable, which OpenGL context shall be shared by this GLAutoDrawable's GLContext.
Exceptions
IllegalStateExceptionif a shared GLContext or shared GLAutoDrawable is already set, the given sharedAutoDrawable is null or equal to this GLAutoDrawable.
See also
setSharedContext(GLContext)

Implements com.jogamp.opengl.GLSharedContextSetter.

Definition at line 430 of file GLJPanel.java.

Here is the caller graph for this function:

◆ setSharedContext()

final void com.jogamp.opengl.awt.GLJPanel.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.

See Lifecycle Considerations.

Parameters
sharedContextThe OpenGL context to be shared by this GLAutoDrawable's GLContext.
Exceptions
IllegalStateExceptionif a shared GLContext or shared GLAutoDrawable is already set, the given sharedContext is null or equal to this GLAutoDrawable's context.
See also
setSharedAutoDrawable(GLAutoDrawable)

Implements com.jogamp.opengl.GLSharedContextSetter.

Definition at line 425 of file GLJPanel.java.

◆ setSkipGLOrientationVerticalFlip()

final void com.jogamp.opengl.awt.GLJPanel.setSkipGLOrientationVerticalFlip ( final boolean  v)

Skip isGLOriented() based vertical flip, which usually is required by the offscreen backend, see details about vertical flip and FBO / GLSL vertical flip.

If set to true, user needs to flip the OpenGL rendered scene if isGLOriented() == true, e.g. via the projection matrix.
See constraints of isGLOriented().

Definition at line 1255 of file GLJPanel.java.

Here is the caller graph for this function:

◆ setSurfaceScale()

final boolean com.jogamp.opengl.awt.GLJPanel.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 })

Parameters
pixelScalerequested surface pixel scale float[2] values for x- and y-direction.
Returns
true if the current pixel scale has changed, otherwise false.
See also
getRequestedSurfaceScale(float[])
canSetSurfaceScale()

Ignored for an AWT widget since pixelScale is dictated by AWT mechanisms.

Implements com.jogamp.nativewindow.ScalableSurface.

Definition at line 619 of file GLJPanel.java.

Here is the caller graph for this function:

◆ setTextureUnit()

final void com.jogamp.opengl.awt.GLJPanel.setTextureUnit ( final int  v)

Allows user to request a texture unit to be used, must be called before the first initialization, i.e.

display() call.

Defaults to 0.

See FBO / GLSL Vertical Flip.

Parameters
vrequested texture unit
See also
getTextureUnit()

Definition at line 1378 of file GLJPanel.java.

◆ setupPrint()

void com.jogamp.opengl.awt.GLJPanel.setupPrint ( final double  scaleMatX,
final double  scaleMatY,
final int  numSamples,
final int  tileWidth,
final int  tileHeight 
)

Shall be called before PrinterJob#print().

See Usage.

Parameters
scaleMatXGraphics2D scaling factor, i.e. rendering 1/scaleMatX * width pixels
scaleMatYGraphics2D scaling factor, i.e. rendering 1/scaleMatY * height pixels
numSamplesmultisampling value: < 0 turns off, == 0 leaves as-is, > 0 enables using given num samples
tileWidthcustom tile width for tile renderer, pass -1 for default.
tileHeightcustom tile height for tile renderer, pass -1 for default. FIXME: Add border size !

Implements com.jogamp.nativewindow.awt.AWTPrintLifecycle.

Definition at line 769 of file GLJPanel.java.

◆ setUseGLSLVerticalFlip()

final void com.jogamp.opengl.awt.GLJPanel.setUseGLSLVerticalFlip ( final boolean  v)

Toggle using GLSL texture renderer for the isGLOriented() based vertical flip, which usually is required by the offscreen backend, see details about vertical flip and FBO / GLSL vertical flip.

If set to true, user needs to flip the OpenGL rendered scene if isGLOriented() == true, e.g. via the projection matrix.
See constraints of isGLOriented().

Definition at line 1270 of file GLJPanel.java.

◆ shouldPreserveColorBufferIfTranslucent()

boolean com.jogamp.opengl.awt.GLJPanel.shouldPreserveColorBufferIfTranslucent ( )

For a translucent GLJPanel (one for which setOpaque(false) has been called), indicates whether the application should preserve the OpenGL color buffer (GL_COLOR_BUFFER_BIT) for correct rendering of the GLJPanel and underlying widgets which may show through portions of the GLJPanel with alpha values less than 1.

Most Swing implementations currently expect the GLJPanel to be completely cleared (e.g., by glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT)), but for certain optimized Swing implementations which use OpenGL internally, it may be possible to perform OpenGL rendering using the GLJPanel into the same OpenGL drawable as the Swing implementation uses.

Definition at line 1212 of file GLJPanel.java.

◆ swapBuffers()

void com.jogamp.opengl.awt.GLJPanel.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 1181 of file GLJPanel.java.

◆ toString()

String com.jogamp.opengl.awt.GLJPanel.toString ( )

Implements com.jogamp.opengl.GLDrawable.

Definition at line 1505 of file GLJPanel.java.

Here is the caller graph for this function:

The documentation for this class was generated from the following file: