JOGL v2.6.0-rc-20250706
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.opengl.swt.GLCanvas Class Reference

Native SWT Canvas implementing GLAutoDrawable. More...

Inheritance diagram for com.jogamp.opengl.swt.GLCanvas:
Collaboration diagram for com.jogamp.opengl.swt.GLCanvas:

Public Member Functions

 GLCanvas (final Composite parent, final int style, final GLCapabilitiesImmutable capsReqUser, final GLCapabilitiesChooser capsChooser)
 Creates a new SWT GLCanvas. 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...
 
void update ()
 
void dispose ()
 @Override public boolean forceFocus() { final boolean r = super.forceFocus(); if(r && 0 != gdkWindow) { SWTGTKUtil.focusGDKWindow(gdkWindow); } return r; } More...
 
void display ()
 
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...
 
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 addGLEventListener (final GLEventListener listener)
 Adds the given listener to the end of this drawable queue. More...
 
void addGLEventListener (final int idx, 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 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...
 
GLAnimatorControl getAnimator ()
 
final Thread setExclusiveContextThread (final Thread t) throws GLException
 Dedicates this instance's GLContext to the given thread. More...
 
final Thread getExclusiveContextThread ()
 
boolean getAutoSwapBufferMode ()
 Indicates whether automatic buffer swapping is enabled for this 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...
 
int getContextCreationFlags ()
 
GL getGL ()
 Returns the GL pipeline object this GLAutoDrawable uses. More...
 
boolean invoke (final boolean wait, final GLRunnable runnable) 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 > runnables) 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 setAnimator (final GLAnimatorControl arg0) throws GLException
 Registers the usage of an animator, an com.jogamp.opengl.GLAnimatorControl implementation. More...
 
void setAutoSwapBufferMode (final boolean arg0)
 Enables or disables automatic buffer swapping for this drawable. More...
 
GLContext setContext (final GLContext newCtx, final boolean destroyPrevCtx)
 Associate the new context, newtCtx, to this auto-drawable. More...
 
void setContextCreationFlags (final int arg0)
 
GL setGL (final GL arg0)
 Sets the GL pipeline object this GLAutoDrawable uses. 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...
 
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...
 
GLDrawableFactory getFactory ()
 Return the GLDrawableFactory being used to create this instance. More...
 
GLProfile getGLProfile ()
 Fetches the GLProfile for this drawable. More...
 
long getHandle ()
 Returns the GL drawable handle, guaranteed to be valid after realization and while it's surface is being locked. 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...
 
boolean isRealized ()
 Returns true if this drawable is realized, otherwise false. More...
 
void setRealized (final boolean arg0)
 Indicates to GLDrawable implementations whether the underlying surface has been created and can be drawn into. More...
 
void swapBuffers () throws GLException
 Swaps the front and back buffers of this drawable. More...
 
final boolean 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
More...
 
String toString ()
 
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...
 
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...
 

Static Public Member Functions

static GLCanvas create (final Composite parent, final int style, final GLCapabilitiesImmutable caps, final GLCapabilitiesChooser chooser)
 Creates an instance using GLCanvas(Composite, int, GLCapabilitiesImmutable, GLCapabilitiesChooser) on the SWT thread. More...
 
static void main (final String[] args)
 

Protected Member Functions

final void updateSizeCheck ()
 
final boolean validateDrawableAndContextWithCheck ()
 assumes drawable == null (implying !drawable.isRealized()) ! Checks of !isDispose() and isVisible() More...
 

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

Detailed Description

Native SWT Canvas implementing GLAutoDrawable.

Implementation allows use of custom GLCapabilities.

OpenGL Context Sharing

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

Definition at line 98 of file GLCanvas.java.

Constructor & Destructor Documentation

◆ GLCanvas()

com.jogamp.opengl.swt.GLCanvas.GLCanvas ( final Composite  parent,
final int  style,
final GLCapabilitiesImmutable  capsReqUser,
final GLCapabilitiesChooser  capsChooser 
)

Creates a new SWT GLCanvas.

Parameters
parentRequired (non-null) parent Composite.
styleOptional SWT style bit-field. The SWT#NO_BACKGROUND bit is set before passing this up to the Canvas constructor, so OpenGL handles the background.
capsReqUserOptional GLCapabilities. If not provided, the default capabilities for the default GLProfile for the graphics device determined by the parent Composite are used. Note that the GLCapabilities that are actually used may differ based on the capabilities of the graphics device.
capsChooserOptional GLCapabilitiesChooser to customize the selection of the used GLCapabilities based on the requested GLCapabilities, and the available capabilities of the graphics device.

Definition at line 341 of file GLCanvas.java.

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

Member Function Documentation

◆ addGLEventListener() [1/2]

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

Parameters
listenerThe GLEventListener object to be inserted

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 706 of file GLCanvas.java.

Here is the caller graph for this function:

◆ addGLEventListener() [2/2]

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

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 711 of file GLCanvas.java.

◆ areAllGLEventListenerInitialized()

boolean com.jogamp.opengl.swt.GLCanvas.areAllGLEventListenerInitialized ( )

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

Since
2.2

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 726 of file GLCanvas.java.

◆ create()

static GLCanvas com.jogamp.opengl.swt.GLCanvas.create ( final Composite  parent,
final int  style,
final GLCapabilitiesImmutable  caps,
final GLCapabilitiesChooser  chooser 
)
static

Creates an instance using GLCanvas(Composite, int, GLCapabilitiesImmutable, GLCapabilitiesChooser) on the SWT thread.

Parameters
parentRequired (non-null) parent Composite.
styleOptional SWT style bit-field. The SWT#NO_BACKGROUND bit is set before passing this up to the Canvas constructor, so OpenGL handles the background.
capsOptional GLCapabilities. If not provided, the default capabilities for the default GLProfile for the graphics device determined by the parent Composite are used. Note that the GLCapabilities that are actually used may differ based on the capabilities of the graphics device.
chooserOptional GLCapabilitiesChooser to customize the selection of the used GLCapabilities based on the requested GLCapabilities, and the available capabilities of the graphics device.
Returns
a new instance

Definition at line 313 of file GLCanvas.java.

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

◆ createContext()

GLContext com.jogamp.opengl.swt.GLCanvas.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 865 of file GLCanvas.java.

Here is the call graph for this function:

◆ destroy()

void com.jogamp.opengl.swt.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. calls this class's dispose() SWT override, where the actual implementation resides.

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 761 of file GLCanvas.java.

Here is the call graph for this function:

◆ display()

void com.jogamp.opengl.swt.GLCanvas.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 675 of file GLCanvas.java.

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

◆ dispose()

void com.jogamp.opengl.swt.GLCanvas.dispose ( )

@Override public boolean forceFocus() { final boolean r = super.forceFocus(); if(r && 0 != gdkWindow) { SWTGTKUtil.focusGDKWindow(gdkWindow); } return r; }

Definition at line 657 of file GLCanvas.java.

Here is the caller graph for this function:

◆ disposeGLEventListener()

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

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 741 of file GLCanvas.java.

◆ flushGLRunnables()

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

See also
invoke(boolean, GLRunnable)
Since
2.2

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 817 of file GLCanvas.java.

◆ getAnimator()

GLAnimatorControl com.jogamp.opengl.swt.GLCanvas.getAnimator ( )

◆ getAutoSwapBufferMode()

boolean com.jogamp.opengl.swt.GLCanvas.getAutoSwapBufferMode ( )

Indicates whether automatic buffer swapping is enabled for this drawable.

See setAutoSwapBufferMode.

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 781 of file GLCanvas.java.

◆ getChosenGLCapabilities()

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

Returns
The immutable queried instance.
See also
getRequestedGLCapabilities()

Implements com.jogamp.opengl.GLDrawable.

Definition at line 881 of file GLCanvas.java.

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

◆ getContext()

GLContext com.jogamp.opengl.swt.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 791 of file GLCanvas.java.

◆ getContextCreationFlags()

int com.jogamp.opengl.swt.GLCanvas.getContextCreationFlags ( )
Returns
Additional context creation flags

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 796 of file GLCanvas.java.

◆ getDelegatedDrawable()

final GLDrawable com.jogamp.opengl.swt.GLCanvas.getDelegatedDrawable ( )

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

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 786 of file GLCanvas.java.

Here is the caller graph for this function:

◆ getExclusiveContextThread()

final Thread com.jogamp.opengl.swt.GLCanvas.getExclusiveContextThread ( )
See also
setExclusiveContextThread(Thread)

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 776 of file GLCanvas.java.

Here is the caller graph for this function:

◆ getFactory()

GLDrawableFactory com.jogamp.opengl.swt.GLCanvas.getFactory ( )

Return the GLDrawableFactory being used to create this instance.

Implements com.jogamp.opengl.GLDrawable.

Definition at line 893 of file GLCanvas.java.

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

◆ getGL()

GL com.jogamp.opengl.swt.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 801 of file GLCanvas.java.

Here is the call graph for this function:

◆ getGLEventListener()

GLEventListener com.jogamp.opengl.swt.GLCanvas.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 721 of file GLCanvas.java.

◆ getGLEventListenerCount()

int com.jogamp.opengl.swt.GLCanvas.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 716 of file GLCanvas.java.

◆ getGLEventListenerInitState()

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

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

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 731 of file GLCanvas.java.

◆ getGLProfile()

GLProfile com.jogamp.opengl.swt.GLCanvas.getGLProfile ( )

Fetches the GLProfile for this drawable.

Returns the GLProfile object, no copy.

Implements com.jogamp.opengl.GLDrawable.

Definition at line 899 of file GLCanvas.java.

Here is the call graph for this function:

◆ getHandle()

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

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

Implements com.jogamp.opengl.GLDrawable.

Definition at line 904 of file GLCanvas.java.

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

◆ getNativeSurface()

NativeSurface com.jogamp.opengl.swt.GLCanvas.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 910 of file GLCanvas.java.

Here is the call graph for this function:

◆ getRequestedGLCapabilities()

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

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

Implements com.jogamp.opengl.GLDrawable.

Definition at line 887 of file GLCanvas.java.

Here is the call graph for this function:

◆ getSurfaceHeight()

int com.jogamp.opengl.swt.GLCanvas.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 695 of file GLCanvas.java.

Here is the caller graph for this function:

◆ getSurfaceWidth()

int com.jogamp.opengl.swt.GLCanvas.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 690 of file GLCanvas.java.

Here is the caller graph for this function:

◆ getUpstreamLock()

final RecursiveLock com.jogamp.opengl.swt.GLCanvas.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 687 of file GLCanvas.java.

◆ getUpstreamWidget()

final Object com.jogamp.opengl.swt.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 682 of file GLCanvas.java.

◆ invoke() [1/2]

boolean com.jogamp.opengl.swt.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
  • 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 807 of file GLCanvas.java.

◆ invoke() [2/2]

boolean com.jogamp.opengl.swt.GLCanvas.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 812 of file GLCanvas.java.

◆ isGLOriented()

boolean com.jogamp.opengl.swt.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 700 of file GLCanvas.java.

Here is the call graph for this function:

◆ isRealized()

boolean com.jogamp.opengl.swt.GLCanvas.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 916 of file GLCanvas.java.

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

◆ isThreadGLCapable()

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

Since
2.2

Implementation always supports multithreading, hence method always returns true.

Implements com.jogamp.opengl.GLAutoDrawable.

Definition at line 938 of file GLCanvas.java.

◆ main()

static void com.jogamp.opengl.swt.GLCanvas.main ( final String[]  args)
static

Definition at line 1006 of file GLCanvas.java.

Here is the call graph for this function:

◆ removeGLEventListener()

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

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 748 of file GLCanvas.java.

◆ setAnimator()

void com.jogamp.opengl.swt.GLCanvas.setAnimator ( final GLAnimatorControl  animatorControl) throws GLException

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 822 of file GLCanvas.java.

◆ setAutoSwapBufferMode()

void com.jogamp.opengl.swt.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 827 of file GLCanvas.java.

◆ setContext()

GLContext com.jogamp.opengl.swt.GLCanvas.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 832 of file GLCanvas.java.

◆ setContextCreationFlags()

void com.jogamp.opengl.swt.GLCanvas.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 846 of file GLCanvas.java.

Here is the call graph for this function:

◆ setExclusiveContextThread()

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

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 771 of file GLCanvas.java.

◆ setGL()

GL com.jogamp.opengl.swt.GLCanvas.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 855 of file GLCanvas.java.

Here is the call graph for this function:

◆ setGLEventListenerInitState()

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

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 736 of file GLCanvas.java.

◆ setRealized()

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


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 922 of file GLCanvas.java.

◆ setSharedAutoDrawable()

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

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 417 of file GLCanvas.java.

◆ setSharedContext()

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

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 412 of file GLCanvas.java.

◆ swapBuffers()

void com.jogamp.opengl.swt.GLCanvas.swapBuffers ( ) throws GLException

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 927 of file GLCanvas.java.

◆ toString()

String com.jogamp.opengl.swt.GLCanvas.toString ( )

Implements com.jogamp.opengl.GLDrawable.

Definition at line 993 of file GLCanvas.java.

Here is the call graph for this function:

◆ update()

void com.jogamp.opengl.swt.GLCanvas.update ( )

Definition at line 641 of file GLCanvas.java.

◆ updateSizeCheck()

final void com.jogamp.opengl.swt.GLCanvas.updateSizeCheck ( )
protected

Definition at line 455 of file GLCanvas.java.

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

◆ validateDrawableAndContextWithCheck()

final boolean com.jogamp.opengl.swt.GLCanvas.validateDrawableAndContextWithCheck ( )
protected

assumes drawable == null (implying !drawable.isRealized()) ! Checks of !isDispose() and isVisible()

Definition at line 508 of file GLCanvas.java.

Here is the caller graph for this function:

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