Class GLCanvas
- java.lang.Object
-
- org.eclipse.swt.widgets.Widget
-
- org.eclipse.swt.widgets.Control
-
- org.eclipse.swt.widgets.Scrollable
-
- org.eclipse.swt.widgets.Composite
-
- org.eclipse.swt.widgets.Canvas
-
- com.jogamp.opengl.swt.GLCanvas
-
- All Implemented Interfaces:
NativeSurfaceHolder,GLAutoDrawable,GLDrawable,GLSharedContextSetter,org.eclipse.swt.graphics.Drawable
public class GLCanvas extends org.eclipse.swt.widgets.Canvas implements GLAutoDrawable, GLSharedContextSetter
Native SWT Canvas implementing GLAutoDrawableImplementation allows use of custom
GLCapabilities.OpenGL Context Sharing
To share aGLContextsee the following note in the documentation overview: context sharing as well asGLSharedContextSetter.
-
-
Field Summary
-
Fields inherited from interface com.jogamp.opengl.GLAutoDrawable
SCREEN_CHANGE_ACTION_ENABLED
-
-
Constructor Summary
Constructors Constructor Description GLCanvas(org.eclipse.swt.widgets.Composite parent, int style, GLCapabilitiesImmutable capsReqUser, GLCapabilitiesChooser capsChooser)Creates a new SWT GLCanvas.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddGLEventListener(int idx, GLEventListener listener)Adds the givenlistenerat the given index of this drawable queue.voidaddGLEventListener(GLEventListener listener)Adds the givenlistenerto the end of this drawable queue.booleanareAllGLEventListenerInitialized()Returns true if all addedGLEventListenerare initialized, otherwise false.static GLCanvascreate(org.eclipse.swt.widgets.Composite parent, int style, GLCapabilitiesImmutable caps, GLCapabilitiesChooser chooser)Creates an instance usingGLCanvas(Composite, int, GLCapabilitiesImmutable, GLCapabilitiesChooser)on the SWT thread.GLContextcreateContext(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.voiddestroy()Destroys all resources associated with this GLAutoDrawable, inclusive the GLContext.voiddisplay()Causes OpenGL rendering to be performed for this GLAutoDrawable in the following order: Callingdisplay(..)for all registeredGLEventListeners.voiddispose()GLEventListenerdisposeGLEventListener(GLEventListener listener, boolean remove)Disposes the givenlistenerviadispose(..)if it has been initialized and added to this queue.voidflushGLRunnables()GLAnimatorControlgetAnimator()booleangetAutoSwapBufferMode()Indicates whether automatic buffer swapping is enabled for this drawable.GLCapabilitiesImmutablegetChosenGLCapabilities()Fetches theGLCapabilitiesImmutablecorresponding to the chosen OpenGL capabilities (pixel format / visual / GLProfile) for this drawable.GLContextgetContext()Returns the context associated with this drawable.intgetContextCreationFlags()GLDrawablegetDelegatedDrawable()If the implementation uses delegation, return the delegatedGLDrawableinstance, otherwise returnthisinstance.ThreadgetExclusiveContextThread()GLDrawableFactorygetFactory()Return theGLDrawableFactorybeing used to create this instance.GLgetGL()Returns theGLpipeline object this GLAutoDrawable uses.GLEventListenergetGLEventListener(int index)Returns theGLEventListenerat the given index of this drawable queue.intgetGLEventListenerCount()Returns the number ofGLEventListenerof this drawable queue.booleangetGLEventListenerInitState(GLEventListener listener)Retrieves whether the givenlisteneris initialized or not.GLProfilegetGLProfile()Fetches theGLProfilefor this drawable.longgetHandle()Returns the GL drawable handle, guaranteed to be valid afterrealizationand while it'ssurfaceis beinglocked.NativeSurfacegetNativeSurface()Returns the associatedNativeSurfaceof thisNativeSurfaceHolder.GLCapabilitiesImmutablegetRequestedGLCapabilities()Fetches theGLCapabilitiesImmutablecorresponding to the user requested OpenGL capabilities (pixel format / visual / GLProfile) for this drawable.intgetSurfaceHeight()Returns the height of thisGLDrawable'ssurfaceclient area in pixel units.intgetSurfaceWidth()Returns the width of thisGLDrawable'ssurfaceclient area in pixel units.RecursiveLockgetUpstreamLock()Returns the recursive lock object of theupstream widgetto synchronize multithreaded access on top ofNativeSurface.lockSurface().ObjectgetUpstreamWidget()Method may return the upstream UI toolkit object holding thisGLAutoDrawableinstance, if exist.booleaninvoke(boolean wait, GLRunnable runnable)Enqueues a one-shotGLRunnable, which will be executed within the nextGLAutoDrawable.display()call after all registeredGLEventListenersdisplay(GLAutoDrawable)methods have been called.booleaninvoke(boolean wait, List<GLRunnable> runnables)ExtendsGLAutoDrawable.invoke(boolean, GLRunnable)functionality allowing to inject a list ofGLRunnables.booleanisGLOriented()Returnstrueif the drawable is rendered in OpenGL's coordinate system, origin at bottom left.booleanisRealized()Returnstrueif this drawable is realized, otherwisefalse.booleanisThreadGLCapable()Indicates whether the current thread is capable of performing OpenGL-related work.static voidmain(String[] args)GLEventListenerremoveGLEventListener(GLEventListener listener)Removes the givenlistenerfrom this drawable queue.voidsetAnimator(GLAnimatorControl arg0)Registers the usage of an animator, anGLAnimatorControlimplementation.voidsetAutoSwapBufferMode(boolean arg0)Enables or disables automatic buffer swapping for this drawable.GLContextsetContext(GLContext newCtx, boolean destroyPrevCtx)Associate the new context,newtCtx, to this auto-drawable.voidsetContextCreationFlags(int arg0)ThreadsetExclusiveContextThread(Thread t)Dedicates this instance'sGLContextto the given thread.
The thread will exclusively claim theGLContextviaGLAutoDrawable.display()and not release it untilGLAutoDrawable.destroy()orsetExclusiveContextThread(null)has been called.GLsetGL(GL arg0)Sets theGLpipeline object this GLAutoDrawable uses.voidsetGLEventListenerInitState(GLEventListener listener, boolean initialized)Sets the givenlistener'sinitialized state.voidsetRealized(boolean arg0)Indicates to GLDrawable implementations whether the underlyingsurfacehas been created and can be drawn into.voidsetSharedAutoDrawable(GLAutoDrawable sharedAutoDrawable)Specifies anGLAutoDrawable, whichOpenGL contextshall be shared by thisGLAutoDrawable'sGLContext.voidsetSharedContext(GLContext sharedContext)voidswapBuffers()Swaps the front and back buffers of this drawable.StringtoString()voidupdate()-
Methods inherited from class org.eclipse.swt.widgets.Canvas
drawBackground, getCaret, getIME, scroll, setCaret, setFont, setIME
-
Methods inherited from class org.eclipse.swt.widgets.Composite
changed, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList
-
Methods inherited from class org.eclipse.swt.widgets.Scrollable
computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar
-
Methods inherited from class org.eclipse.swt.widgets.Control
addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getTextDirection, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isAutoScalable, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, requestLayout, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTextDirection, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse
-
-
-
-
Constructor Detail
-
GLCanvas
public GLCanvas(org.eclipse.swt.widgets.Composite parent, int style, GLCapabilitiesImmutable capsReqUser, GLCapabilitiesChooser capsChooser)Creates a new SWT GLCanvas.- Parameters:
parent- Required (non-null) parent Composite.style- Optional SWT style bit-field. TheSWT.NO_BACKGROUNDbit is set before passing this up to the Canvas constructor, so OpenGL handles the background.capsReqUser- Optional 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.capsChooser- Optional GLCapabilitiesChooser to customize the selection of the used GLCapabilities based on the requested GLCapabilities, and the available capabilities of the graphics device.
-
-
Method Detail
-
create
public static GLCanvas create(org.eclipse.swt.widgets.Composite parent, int style, GLCapabilitiesImmutable caps, GLCapabilitiesChooser chooser)
Creates an instance usingGLCanvas(Composite, int, GLCapabilitiesImmutable, GLCapabilitiesChooser)on the SWT thread.- Parameters:
parent- Required (non-null) parent Composite.style- Optional SWT style bit-field. TheSWT.NO_BACKGROUNDbit is set before passing this up to the Canvas constructor, so OpenGL handles the background.caps- Optional 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.chooser- Optional 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
-
setSharedContext
public final void setSharedContext(GLContext sharedContext) throws IllegalStateException
Description copied from interface:GLSharedContextSetterSpecifies anOpenGL context, which shall be shared by thisGLAutoDrawable'sGLContext.Since the
drawableandcontextis created atGLAutoDrawable initializationthis method shall be called beforehand to have any effect.A set sharedContext will block context creation, i.e.
GLAutoDrawable initialization, as long it is notcreated natively.The preferred method of assigning a shared context is to
set the shared GLAutoDrawable, since this method also takes theGLEventListenerinitialization into account.- Specified by:
setSharedContextin interfaceGLSharedContextSetter- Parameters:
sharedContext- The OpenGL context to be shared by thisGLAutoDrawable'sGLContext.- Throws:
IllegalStateException- if ashared GLContextorshared GLAutoDrawableis already set, the given sharedContext is null or equal to thisGLAutoDrawable's context.- See Also:
GLSharedContextSetter.setSharedAutoDrawable(GLAutoDrawable)
-
setSharedAutoDrawable
public final void setSharedAutoDrawable(GLAutoDrawable sharedAutoDrawable) throws IllegalStateException
Description copied from interface:GLSharedContextSetterSpecifies anGLAutoDrawable, whichOpenGL contextshall be shared by thisGLAutoDrawable'sGLContext.Since the
drawableandcontextis created atGLAutoDrawable initializationthis method shall be called beforehand to have any effect.A set sharedAutoDrawable will block context creation, i.e. initialization as long it's
GLContextisnull, orGLContexthas not beencreated natively, orGLEventListenerare notcompletely initialized
- Specified by:
setSharedAutoDrawablein interfaceGLSharedContextSetter- Throws:
IllegalStateException- if ashared GLContextorshared GLAutoDrawableis already set, the given sharedAutoDrawable is null or equal to this GLAutoDrawable.- See Also:
GLSharedContextSetter.setSharedContext(GLContext)
-
update
public void update()
- Overrides:
updatein classorg.eclipse.swt.widgets.Control
-
dispose
public void dispose()
- Overrides:
disposein classorg.eclipse.swt.widgets.Widget
-
display
public void display()
Description copied from interface:GLAutoDrawableCauses OpenGL rendering to be performed for this GLAutoDrawable in the following order:
- Calling
display(..)for all registeredGLEventListeners. - Executes all one-shot
GLRunnable, enqueued viaGLAutoDrawable.invoke(boolean, GLRunnable).
May be called periodically by a running
GLAnimatorControlimplementation,
which must register itself withGLAutoDrawable.setAnimator(com.jogamp.opengl.GLAnimatorControl).Called automatically by the window system toolkit upon receiving a repaint() request,
except anGLAnimatorControlimplementationGLAnimatorControl.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 registeredGLEventListeners before making the actualdisplay(..)calls, in case this has not been done yet.- Specified by:
displayin interfaceGLAutoDrawable- See Also:
GLAutoDrawable.setAnimator(com.jogamp.opengl.GLAnimatorControl)
- Calling
-
getUpstreamWidget
public final Object getUpstreamWidget()
Description copied from interface:GLAutoDrawableMethod may return the upstream UI toolkit object holding thisGLAutoDrawableinstance, if exist.Currently known Java UI toolkits and it's known return types are:
However, the result may be other object types than the listed above due to new supported toolkits.Toolkit GLAutoDrawable Implementation ~ Return Type of getUpstreamWidget() NEWT GLWindowhas a WindowSWT GLCanvasis a CanvasAWT GLCanvasis a CanvasAWT GLJPanelis a JPanelThis method may also return
nullif no UI toolkit is being used, as common for offscreen rendering.- Specified by:
getUpstreamWidgetin interfaceGLAutoDrawable
-
getUpstreamLock
public final RecursiveLock getUpstreamLock()
Description copied from interface:GLAutoDrawableReturns the recursive lock object of theupstream widgetto synchronize multithreaded access on top ofNativeSurface.lockSurface().- Specified by:
getUpstreamLockin interfaceGLAutoDrawable
-
getSurfaceWidth
public int getSurfaceWidth()
Description copied from interface:GLDrawableReturns the width of thisGLDrawable'ssurfaceclient area in pixel units.- Specified by:
getSurfaceWidthin interfaceGLDrawable- See Also:
NativeSurface.getSurfaceWidth()
-
getSurfaceHeight
public int getSurfaceHeight()
Description copied from interface:GLDrawableReturns the height of thisGLDrawable'ssurfaceclient area in pixel units.- Specified by:
getSurfaceHeightin interfaceGLDrawable- See Also:
NativeSurface.getSurfaceHeight()
-
isGLOriented
public boolean isGLOriented()
Description copied from interface:GLDrawableReturnstrueif the drawable is rendered in OpenGL's coordinate system, origin at bottom left. Otherwise returnsfalse, 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.- Specified by:
isGLOrientedin interfaceGLDrawable
-
addGLEventListener
public void addGLEventListener(GLEventListener listener)
Description copied from interface:GLAutoDrawableAdds the givenlistenerto the end of this drawable queue. Thelistenersare 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. SeeGLAutoDrawable.getGLEventListenerInitState(GLEventListener)for details.- Specified by:
addGLEventListenerin interfaceGLAutoDrawable- Parameters:
listener- The GLEventListener object to be inserted
-
addGLEventListener
public void addGLEventListener(int idx, GLEventListener listener) throws IndexOutOfBoundsExceptionDescription copied from interface:GLAutoDrawableAdds the givenlistenerat the given index of this drawable queue. Thelistenersare 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. SeeGLAutoDrawable.getGLEventListenerInitState(GLEventListener)for details.- Specified by:
addGLEventListenerin interfaceGLAutoDrawable- Parameters:
idx- Position where the listener will be inserted. Should be within (0 <= index && index <= size()). An index value of -1 is interpreted as the end of the list, size().listener- The GLEventListener object to be inserted- Throws:
IndexOutOfBoundsException- If the index is not within (0 <= index && index <= size()), or -1
-
getGLEventListenerCount
public int getGLEventListenerCount()
Description copied from interface:GLAutoDrawableReturns the number ofGLEventListenerof this drawable queue.- Specified by:
getGLEventListenerCountin interfaceGLAutoDrawable- Returns:
- The number of GLEventListener objects of this drawable queue.
-
getGLEventListener
public GLEventListener getGLEventListener(int index) throws IndexOutOfBoundsException
Description copied from interface:GLAutoDrawableReturns theGLEventListenerat the given index of this drawable queue.- Specified by:
getGLEventListenerin interfaceGLAutoDrawable- Parameters:
index- Position of the listener to be returned. Should be within (0 <= index && index < size()). An index value of -1 is interpreted as last listener, size()-1.- Returns:
- The GLEventListener object at the given index.
- Throws:
IndexOutOfBoundsException- If the index is not within (0 <= index && index < size()), or -1
-
areAllGLEventListenerInitialized
public boolean areAllGLEventListenerInitialized()
Description copied from interface:GLAutoDrawableReturns true if all addedGLEventListenerare initialized, otherwise false.- Specified by:
areAllGLEventListenerInitializedin interfaceGLAutoDrawable
-
getGLEventListenerInitState
public boolean getGLEventListenerInitState(GLEventListener listener)
Description copied from interface:GLAutoDrawableRetrieves whether the givenlisteneris initialized or not.After
addingaGLEventListenerit is marked uninitialized and added to a list of to be initializedGLEventListener. If such uninitializedGLEventListener's handler methods (reshape, display) are about to be invoked, it'sinit(..)method is invoked first. Afterwards theGLEventListeneris marked initialized and removed from the list of to be initializedGLEventListener.This methods returns the
GLEventListenerinitialized state, i.e. returnsfalseif it is included in the list of to be initializedGLEventListener, otherwisetrue.- Specified by:
getGLEventListenerInitStatein interfaceGLAutoDrawable- Parameters:
listener- the GLEventListener object to query it's initialized state.
-
setGLEventListenerInitState
public void setGLEventListenerInitState(GLEventListener listener, boolean initialized)
Description copied from interface:GLAutoDrawableSets the givenlistener'sinitialized state.This methods allows manually setting the
GLEventListenerinitialized state, i.e. adding it to, or removing it from the list of to be initializedGLEventListener. SeeGLAutoDrawable.getGLEventListenerInitState(GLEventListener)for details.Warning: This method does not validate whether the given
listener'sis 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
GLContextand their initializedGLEventListenerfrom oneGLAutoDrawableto another, where a subsequentinit(..)call after adding it to the new owner is neither required nor desired. SeeswapGLContextAndAllGLEventListener(..).- Specified by:
setGLEventListenerInitStatein interfaceGLAutoDrawable- Parameters:
listener- the GLEventListener object to perform a state change.initialized- iftrue, mark the listener initialized, otherwise uninitialized.
-
disposeGLEventListener
public GLEventListener disposeGLEventListener(GLEventListener listener, boolean remove)
Description copied from interface:GLAutoDrawableDisposes the givenlistenerviadispose(..)if it has been initialized and added to this queue.If
removeistrue, theGLEventListeneris removed from this drawable queue before disposal, otherwise marked uninitialized.If an
GLAnimatorControlis being attached and the current thread is different thanthe animator's thread, it is paused during the operation.Note that this is an expensive operation, since
dispose(..)is decorated byGLContext.makeCurrent()andGLContext.release().Use
removeGLEventListener(listener)instead if you just want to remove thelistenerand don't care about the disposal of the it's (OpenGL) resources.Also note that this is done from within a particular drawable's
GLEventListenerhandler (reshape, display, etc.), that it is not guaranteed that all other listeners will be evaluated properly during this update cycle.- Specified by:
disposeGLEventListenerin interfaceGLAutoDrawable- Parameters:
listener- The GLEventListener object to be disposed and removed ifremoveistrueremove- passtrueto have thelistenerremoved from this drawable queue, otherwise passfalse- Returns:
- the disposed and/or removed GLEventListener, or null if no action was performed, i.e. listener was not added
-
removeGLEventListener
public GLEventListener removeGLEventListener(GLEventListener listener)
Description copied from interface:GLAutoDrawableRemoves the givenlistenerfrom 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 thelistener's (OpenGL) resources.Note that if this is done from within a particular drawable's
GLEventListenerhandler (reshape, display, etc.), that it is not guaranteed that all other listeners will be evaluated properly during this update cycle.- Specified by:
removeGLEventListenerin interfaceGLAutoDrawable- Parameters:
listener- The GLEventListener object to be removed- Returns:
- the removed GLEventListener, or null if listener was not added
-
destroy
public 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 callingdispose(..)for all registeredGLEventListeners. 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.- Specified by:
destroyin interfaceGLAutoDrawable
-
getAnimator
public GLAnimatorControl getAnimator()
- Specified by:
getAnimatorin interfaceGLAutoDrawable- Returns:
- the registered
GLAnimatorControlimplementation, using thisGLAutoDrawable. - See Also:
GLAutoDrawable.setAnimator(com.jogamp.opengl.GLAnimatorControl),GLAnimatorControl
-
setExclusiveContextThread
public final Thread setExclusiveContextThread(Thread t) throws GLException
Description copied from interface:GLAutoDrawableDedicates this instance'sGLContextto the given thread.
The thread will exclusively claim theGLContextviaGLAutoDrawable.display()and not release it untilGLAutoDrawable.destroy()orsetExclusiveContextThread(null)has been called.Default non-exclusive behavior is requested via
setExclusiveContextThread(null), which will cause the next call ofGLAutoDrawable.display()on the exclusive thread to release theGLContext. Only after it's async release,GLAutoDrawable.getExclusiveContextThread()will returnnull.To release a previous made exclusive thread, a user issues
setExclusiveContextThread(null)and may pollGLAutoDrawable.getExclusiveContextThread()until it returnsnull, 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 threadand spare redundant context switches, seeAnimatorBase.setExclusiveContext(boolean).- Specified by:
setExclusiveContextThreadin interfaceGLAutoDrawable- Parameters:
t- the exclusive thread to claim the context, ornullfor default operation.- Returns:
- previous exclusive context thread
- Throws:
GLException- If an exclusive thread is still active but a new one is attempted to be set- See Also:
AnimatorBase.setExclusiveContext(boolean)
-
getExclusiveContextThread
public final Thread getExclusiveContextThread()
- Specified by:
getExclusiveContextThreadin interfaceGLAutoDrawable- See Also:
GLAutoDrawable.setExclusiveContextThread(Thread)
-
getAutoSwapBufferMode
public boolean getAutoSwapBufferMode()
Description copied from interface:GLAutoDrawableIndicates whether automatic buffer swapping is enabled for this drawable. SeeGLAutoDrawable.setAutoSwapBufferMode(boolean).- Specified by:
getAutoSwapBufferModein interfaceGLAutoDrawable
-
getDelegatedDrawable
public final GLDrawable getDelegatedDrawable()
Description copied from interface:GLAutoDrawableIf the implementation uses delegation, return the delegatedGLDrawableinstance, otherwise returnthisinstance.- Specified by:
getDelegatedDrawablein interfaceGLAutoDrawable
-
getContext
public GLContext getContext()
Description copied from interface:GLAutoDrawableReturns the context associated with this drawable. The returned context will be synchronized. Don't rely on it's identity, the context may change.- Specified by:
getContextin interfaceGLAutoDrawable
-
getContextCreationFlags
public int getContextCreationFlags()
- Specified by:
getContextCreationFlagsin interfaceGLAutoDrawable- Returns:
- Additional context creation flags
-
getGL
public GL getGL()
Description copied from interface:GLAutoDrawableReturns theGLpipeline object this GLAutoDrawable uses. If this method is called outside of theGLEventListener's callback methods (init, display, etc.) it may return null. Users should not rely on the identity of the returned GL object; for example, users should not maintain a hash table with the GL object as the key. Additionally, the GL object should not be cached in client code, but should be re-fetched from the GLAutoDrawable at the beginning of each call to init, display, etc.- Specified by:
getGLin interfaceGLAutoDrawable
-
invoke
public boolean invoke(boolean wait, GLRunnable runnable) throws IllegalStateExceptionDescription copied from interface:GLAutoDrawableEnqueues a one-shotGLRunnable, which will be executed within the nextGLAutoDrawable.display()call after all registeredGLEventListenersdisplay(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 falseGLAutoDrawablewill calldisplay(GLAutoDrawable)of all registeredGLEventListeners once more to reinstate the framebuffer.If no
GLAnimatorControlis animating (default),
or if the current thread is the animator thread,
aGLAutoDrawable.display()call is issued after enqueue theGLRunnable, hence theGLRunnablewill be executed right away.
If an
animatoris running,
no explicitGLAutoDrawable.display()call is issued, allowing theanimatorto perform at due time.
If
waitistruethe call blocks until theglRunnablehas been executed by theanimator, otherwise the method returns immediately.If
waitistrueandGLDrawable.isRealized()returnsfalseorGLAutoDrawable.getContext()returnsnull, the call is ignored and returnsfalse.
This helps avoiding deadlocking the caller.The internal queue of
GLRunnable's is being flushed withGLAutoDrawable.destroy()where all blocked callers are being notified.To avoid a deadlock situation which causes an
IllegalStateExceptionone should avoid issuinginvokewhile this GLAutoDrawable is being locked.
Detected deadlock situations throwing anIllegalStateExceptionare:- Specified by:
invokein interfaceGLAutoDrawable- Parameters:
wait- iftrueblock until execution ofglRunnableis finished, otherwise return immediately w/o waitingrunnable- theGLRunnableto execute withinGLAutoDrawable.display()- Returns:
trueif theGLRunnablehas been processed or queued, otherwisefalse.- Throws:
IllegalStateException- in case of a detected deadlock situation ahead, see above.- See Also:
GLAutoDrawable.setAnimator(GLAnimatorControl),GLAutoDrawable.display(),GLRunnable,GLAutoDrawable.invoke(boolean, List),GLAutoDrawable.flushGLRunnables()
-
invoke
public boolean invoke(boolean wait, List<GLRunnable> runnables) throws IllegalStateExceptionDescription copied from interface:GLAutoDrawableExtendsGLAutoDrawable.invoke(boolean, GLRunnable)functionality allowing to inject a list ofGLRunnables.- Specified by:
invokein interfaceGLAutoDrawable- Parameters:
wait- iftrueblock until execution of the lastglRunnableis finished, otherwise return immediately w/o waitingrunnables- theGLRunnables to execute withinGLAutoDrawable.display()- Returns:
trueif theGLRunnables has been processed or queued, otherwisefalse.- Throws:
IllegalStateException- in case of a detected deadlock situation ahead, seeGLAutoDrawable.invoke(boolean, GLRunnable).- See Also:
GLAutoDrawable.invoke(boolean, GLRunnable),GLAutoDrawable.flushGLRunnables()
-
flushGLRunnables
public void flushGLRunnables()
Description copied from interface:GLAutoDrawableFlushes allenqueuedGLRunnableof thisGLAutoDrawableincluding notifying waiting executor.The executor which might have been blocked until notified will be unblocked and all tasks removed from the queue.
- Specified by:
flushGLRunnablesin interfaceGLAutoDrawable- See Also:
GLAutoDrawable.invoke(boolean, GLRunnable)
-
setAnimator
public void setAnimator(GLAnimatorControl arg0) throws GLException
Description copied from interface:GLAutoDrawableRegisters the usage of an animator, anGLAnimatorControlimplementation. The animator will be queried whether it's animating, ie periodically issuingGLAutoDrawable.display()calls or not.This method shall be called by an animator implementation only,
e.g.AnimatorBase.add(com.jogamp.opengl.GLAutoDrawable), passing it's control implementation,
andAnimatorBase.remove(com.jogamp.opengl.GLAutoDrawable), passingnull.Impacts
GLAutoDrawable.display()andGLAutoDrawable.invoke(boolean, GLRunnable)semantics.- Specified by:
setAnimatorin interfaceGLAutoDrawable- Parameters:
arg0-nullreference indicates no animator is using thisGLAutoDrawable,
a valid reference indicates an animator is using thisGLAutoDrawable.- Throws:
GLException- if an animator is already registered.- See Also:
GLAutoDrawable.display(),GLAutoDrawable.invoke(boolean, GLRunnable),GLAnimatorControl
-
setAutoSwapBufferMode
public void setAutoSwapBufferMode(boolean arg0)
Description copied from interface:GLAutoDrawableEnables 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 {@link #swapBuffers(..)} manually.- Specified by:
setAutoSwapBufferModein interfaceGLAutoDrawable
-
setContext
public GLContext setContext(GLContext newCtx, boolean destroyPrevCtx)
Description copied from interface:GLAutoDrawableAssociate the new context,newtCtx, to this auto-drawable.Remarks:
- The currently associated context will be destroyed if
destroyPrevCtxistrue, otherwise it will be disassociated from this auto-drawable viasetGLDrawable(null, true);includingglFinish(). - The new context will be associated with this auto-drawable
via
newCtx.setGLDrawable(drawable, true);. - If the old context was current on this thread, it is being released after disassociating this auto-drawable.
- If the new context was current on this thread, it is being released before associating this auto-drawable and made current afterwards.
- Implementation may issue
GLContext.makeCurrent()andGLContext.release()while drawable reassociation. - The user shall take extra care of thread synchronization,
i.e. lock the involved
auto-drawable'supstream-locksandsurfacesto avoid a race condition. See GLAutoDrawable Locking.
- Specified by:
setContextin interfaceGLAutoDrawable- Parameters:
newCtx- the new context, maybenullfor dis-association.destroyPrevCtx- iftrue, destroy the previous context if exists- Returns:
- the previous GLContext, maybe
null - See Also:
GLContext.setGLDrawable(GLDrawable, boolean),GLContext.setGLReadDrawable(GLDrawable),GLDrawableHelper.switchContext(GLDrawable, GLContext, boolean, GLContext, int)
- The currently associated context will be destroyed if
-
setContextCreationFlags
public void setContextCreationFlags(int arg0)
- Specified by:
setContextCreationFlagsin interfaceGLAutoDrawable- Parameters:
arg0- Additional context creation flags.- See Also:
GLContext.setContextCreationFlags(int),GLContext.enableGLDebugMessage(boolean)
-
setGL
public GL setGL(GL arg0)
Description copied from interface:GLAutoDrawableSets theGLpipeline object this GLAutoDrawable uses. This should only be called from within the GLEventListener's callback methods, and usually only from within the init() method, in order to install a composable pipeline. See the JOGL demos for examples.- Specified by:
setGLin interfaceGLAutoDrawable- Returns:
- the set GL pipeline or null if not successful
-
createContext
public GLContext createContext(GLContext shareWith)
Description copied from interface:GLAutoDrawableCreates 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
shareneed 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 asGLSharedContextSetter.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
GLAutoDrawable.setContext(GLContext, boolean).The GLAutoDrawable implementation shall also set the context creation flags as customized w/
GLAutoDrawable.setContextCreationFlags(int).- Specified by:
createContextin interfaceGLAutoDrawable- Specified by:
createContextin interfaceGLDrawable
-
getChosenGLCapabilities
public GLCapabilitiesImmutable getChosenGLCapabilities()
Description copied from interface:GLDrawableFetches theGLCapabilitiesImmutablecorresponding to the chosen OpenGL capabilities (pixel format / visual / GLProfile) for this drawable.This query only returns the chosen capabilities if
GLDrawable.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'sAbstractGraphicsConfiguration, and if changes are necessary, they should reflect those as well.- Specified by:
getChosenGLCapabilitiesin interfaceGLDrawable- Returns:
- The immutable queried instance.
- See Also:
GLDrawable.getRequestedGLCapabilities()
-
getRequestedGLCapabilities
public GLCapabilitiesImmutable getRequestedGLCapabilities()
Description copied from interface:GLDrawableFetches theGLCapabilitiesImmutablecorresponding to the user requested OpenGL capabilities (pixel format / visual / GLProfile) for this drawable.If
realized,the chosen capabilitiesreflect the actual selected OpenGL capabilities.- Specified by:
getRequestedGLCapabilitiesin interfaceGLDrawable- Returns:
- The immutable queried instance.
- See Also:
GLDrawable.getChosenGLCapabilities()
-
getFactory
public GLDrawableFactory getFactory()
Description copied from interface:GLDrawableReturn theGLDrawableFactorybeing used to create this instance.- Specified by:
getFactoryin interfaceGLDrawable
-
getGLProfile
public GLProfile getGLProfile()
Description copied from interface:GLDrawableFetches theGLProfilefor this drawable. Returns the GLProfile object, no copy.- Specified by:
getGLProfilein interfaceGLDrawable
-
getHandle
public long getHandle()
Description copied from interface:GLDrawableReturns the GL drawable handle, guaranteed to be valid afterrealizationand while it'ssurfaceis beinglocked.It is usually identical to the underlying windowing toolkit
surface'shandleor 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 eachNativeSurface.lockSurface().
- Specified by:
getHandlein interfaceGLDrawable- See Also:
GLDrawable.setRealized(boolean),NativeSurface.lockSurface(),NativeSurface.unlockSurface()
-
getNativeSurface
public NativeSurface getNativeSurface()
Description copied from interface:GLDrawableReturns the associatedNativeSurfaceof thisNativeSurfaceHolder.Returns the underlying
NativeSurfacewhichnative handlerepresents this OpenGL drawable's native resource.- Specified by:
getNativeSurfacein interfaceGLDrawable- Specified by:
getNativeSurfacein interfaceNativeSurfaceHolder- See Also:
GLDrawable.getHandle()
-
isRealized
public boolean isRealized()
Description copied from interface:GLDrawableReturnstrueif this drawable is realized, otherwisefalse.A drawable can be realized and unrealized via
GLDrawable.setRealized(boolean).- Specified by:
isRealizedin interfaceGLDrawable- See Also:
GLDrawable.setRealized(boolean)
-
setRealized
public void setRealized(boolean arg0)
Description copied from interface:GLDrawableIndicates to GLDrawable implementations whether the underlyingsurfacehas been created and can be drawn into.If realized, the
drawable handlemay become valid while it'ssurfaceis beinglocked.End users do not need to call this method; it is not necessary to call
setRealizedon aGLAutoDrawableas 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 oftruewhen the component associated with the GLDrawable is realized and with an argument offalsejust before the component is unrealized. For the AWT, this means callingsetRealized(true)in theaddNotifymethod and with an argument offalsein theremoveNotifymethod.GLDrawableimplementations should handle multiple cycles ofsetRealized(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. TheGLDrawableobject associated with a particular component is intended to be similarly persistent. AGLDrawableis intended to be created for a given component when it is constructed and live as long as that component.setRealizedallows theGLDrawableto re-initialize and destroy any associated resources as the component becomes realized and unrealized, respectively.With an argument of
true, the minimum implementation shall callNativeSurface's lockSurface()and if successful:- Update the
GLCapabilities, which are associated with the attachedNativeSurface'sAbstractGraphicsConfiguration. - Release the lock with
NativeSurface's unlockSurface().
This is important sinceNativeSurface's lockSurface()ensures resolving the window/surface handles, and the drawable'sGLCapabilitiesmight have changed.Calling this method has no other effects. For example, if
removeNotifyis 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.- Specified by:
setRealizedin interfaceGLDrawable- See Also:
GLDrawable.isRealized(),GLDrawable.getHandle(),NativeSurface.lockSurface()
- Update the
-
swapBuffers
public void swapBuffers() throws GLExceptionDescription copied from interface:GLDrawableSwaps the front and back buffers of this drawable. ForGLAutoDrawableimplementations, when automatic buffer swapping is enabled (as is the default), this method is called automatically and should not be called by the end user.- Specified by:
swapBuffersin interfaceGLDrawable- Throws:
GLException
-
isThreadGLCapable
public final boolean isThreadGLCapable()
Indicates whether the current thread is capable of performing OpenGL-related work.Implementation utilizes this knowledge to determine whether
GLAutoDrawable.display()performs the OpenGL commands on the current thread directly or spawns them on the dedicated OpenGL thread.Implementation always supports multithreading, hence method always returns
true.- Specified by:
isThreadGLCapablein interfaceGLAutoDrawable
-
toString
public String toString()
- Specified by:
toStringin interfaceGLDrawable- Overrides:
toStringin classorg.eclipse.swt.widgets.Composite
-
main
public static void main(String[] args)
-
-