JOGL 2.3.2 · com.jogamp.opengl.GLAutoDrawableDelegate

Modifier and Type	Field and Description
private final RecursiveLock	lock
private Object	upstreamWidget

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	GLAutoDrawableDelegate(final GLDrawable a valid `GLDrawable`, may not be `realized` yet. drawable, final GLContext a valid `GLContext`, may not have been made current (created) yet, may not be associated w/ `drawable yet, may be null for lazy initialization at 1st display().` `context,final Object optional UI element holding this instance, see getUpstreamWidget().upstreamWidget, final boolean pass true if AbstractGraphicsDevice#close() shall be issued, otherwise pass false. Closing the device is required in case the drawable is created w/ it's own new instance, e.g. offscreen drawables, and no further lifecycle handling is applied.ownDevice, final RecursiveLock optional custom RecursiveLock.lock)` `The GLContext can be assigned later manually via setContext(ctx) or it will be created lazily at the 1st display() method call.`

public

a valid GLDrawable, may not be realized yet.

drawable, final GLContext

a valid GLContext, may not have been made current (created) yet, may not be associated w/

drawable yet,
               may be null for lazy initialization at 1st display().

context,

 final Object optional UI element holding this instance, see getUpstreamWidget().upstreamWidget, final boolean pass true if AbstractGraphicsDevice#close() shall be issued,
                 otherwise pass false. Closing the device is required in case
                 the drawable is created w/ it's own new instance, e.g. offscreen drawables,
                 and no further lifecycle handling is applied.ownDevice, final RecursiveLock optional custom RecursiveLock.lock)

The GLContext can be assigned later manually via setContext(ctx) or it will be created lazily at the 1st display() method call.

Method Summary

Modifier and Type	Method and Description
public final void	destroy() Implements com.jogamp.opengl.GLAutoDrawable.destroy. Destroys all resources associated with this GLAutoDrawable, inclusive the GLContext.
protected void	destroyImplInLock() Overrides jogamp.opengl.GLAutoDrawableBase.destroyImplInLock. Default implementation to destroys the drawable and context of this GLAutoDrawable: issues the GLEventListener dispose call, if drawable and context are valid destroys the GLContext, if valid destroys the GLDrawable, if valid
public void	display() Implements com.jogamp.opengl.GLAutoDrawable.display. Causes OpenGL rendering to be performed for this GLAutoDrawable in the following order: Calling `display(..)` for all registered `GLEventListener`s. Executes all one-shot `GLRunnable`, enqueued via `invoke(boolean, GLRunnable)`.
public final GLDrawableFactory	getFactory() Implements com.jogamp.opengl.GLDrawable.getFactory. Return the `GLDrawableFactory` being used to create this instance.
public final RecursiveLock	getUpstreamLock() Implements com.jogamp.opengl.GLAutoDrawable.getUpstreamLock. Returns the recursive lock object of the `upstream widget` to synchronize multithreaded access on top of `NativeSurface#lockSurface()`.
public final Object	getUpstreamWidget() Implements com.jogamp.opengl.GLAutoDrawable.getUpstreamWidget. Method may return the upstream UI toolkit object holding this `GLAutoDrawable` instance, if exist.</td<></td<></td<></td<></td<>
public final void	setUpstreamWidget(final Object newUpstreamWidget) Set the upstream UI toolkit object.
public final void	swapBuffers() Implements com.jogamp.opengl.GLDrawable.swapBuffers. Swaps the front and back buffers of this drawable.
public String	toString() Overrides jogamp.opengl.GLAutoDrawableBase.toString. Implements com.jogamp.opengl.GLDrawable.toString. Returns a string representation of the object.
public final void	windowDestroyNotifyOp() Implementation to handle destroy notifications from the windowing system.
public final void	windowRepaintOp() Default implementation to handle repaint events from the windowing system
public final void	windowResizedOp(final int new width in pixel units new height in pixel units newWidth, final int newHeight) Handling resize events from the windowing system.

Inherited from jogamp.opengl.GLAutoDrawableBase:: addGLEventListener addGLEventListener areAllGLEventListenerInitialized clearPreservedGLState createContext defaultDestroy defaultDisplay defaultDisposeGLEventListener defaultSwapBuffers defaultWindowDestroyNotifyOp defaultWindowRepaintOp defaultWindowResizedOp destroyAvoidAwareOfLocking disposeGLEventListener flushGLRunnables getAnimator getAutoSwapBufferMode getChosenGLCapabilities getContext getContextCreationFlags getDelegatedDrawable getExclusiveContextThread getFPSStartTime getGL getGLEventListener getGLEventListenerCount getGLEventListenerInitState getGLProfile getHandle getLastFPS getLastFPSPeriod getLastFPSUpdateTime getNativeSurface getPreservedGLState getRequestedGLCapabilities getSurfaceHeight getSurfaceWidth getThreadName getTotalFPS getTotalFPSDuration getTotalFPSFrames getUpdateFPSFrames invoke invoke invokeOnCurrentThread invokeOnNewThread isGLOriented isGLStatePreservationSupported isRealized isThreadGLCapable preserveGLEventListenerState preserveGLStateAtDestroy removeGLEventListener resetFPSCounter restoreGLEventListenerState setAnimator setAutoSwapBufferMode setContext setContextCreationFlags setExclusiveContextThread setGL setGLEventListenerInitState setGLStateKeeperListener setRealized setSharedAutoDrawable setSharedContext setUpdateFPSFrames

Field Detail

lock	back to summary
private final RecursiveLock lock

upstreamWidget	back to summary
private Object upstreamWidget

Constructor Detail

GLAutoDrawableDelegate back to summary

GLAutoDrawableDelegate	back to summary
public GLAutoDrawableDelegate(final GLDrawable drawable, final GLContext context, final Object upstreamWidget, final boolean ownDevice, final RecursiveLock lock) The `GLContext` can be assigned later manually via `setContext(ctx)` or it will be created lazily at the 1st `display()` method call. Lazy `GLContext` creation will take a shared `GLContext` into account which has been set `directly` or `via another GLAutoDrawable`. Parameters drawable:GLDrawable a valid `GLDrawable`, may not be `realized` yet. context:GLContext a valid `GLContext`, may not have been made current (created) yet, may not be associated w/ `drawable yet, may be null for lazy initialization at 1st display().` `upstreamWidget:Object` `optional UI element holding this instance, see getUpstreamWidget().` `ownDevice:boolean` `pass true if AbstractGraphicsDevice#close() shall be issued, otherwise pass false. Closing the device is required in case the drawable is created w/ it's own new instance, e.g. offscreen drawables, and no further lifecycle handling is applied.` `lock:RecursiveLock` `optional custom RecursiveLock.`

public GLAutoDrawableDelegate(final GLDrawable drawable, final GLContext context, final Object upstreamWidget, final boolean ownDevice, final RecursiveLock lock)

The GLContext can be assigned later manually via setContext(ctx) or it will be created lazily at the 1st display() method call.
Lazy GLContext creation will take a shared GLContext into account which has been set directly or via another GLAutoDrawable.

Parameters

drawable:GLDrawable: a valid GLDrawable, may not be realized yet.
context:GLContext: a valid GLContext, may not have been made current (created) yet, may not be associated w/ drawable yet, may be null for lazy initialization at 1st display().
upstreamWidget:Object: optional UI element holding this instance, see getUpstreamWidget().
ownDevice:boolean: pass true if AbstractGraphicsDevice#close() shall be issued, otherwise pass false. Closing the device is required in case the drawable is created w/ it's own new instance, e.g. offscreen drawables, and no further lifecycle handling is applied.
lock:RecursiveLock: optional custom RecursiveLock.

Method Detail

destroy back to summary

destroy	back to summary
public final void destroy() Implements com.jogamp.opengl.GLAutoDrawable.destroy. Doc from com.jogamp.opengl.GLAutoDrawable.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 `GLEventListener`s. Called automatically by the window system toolkit upon receiving a destroy notification. This routine may be called manually. This implementation calls `defaultDestroy()`. User still needs to destroy the upstream window, which details are hidden from this aspect. This can be performed by overriding `destroyImplInLock()`. Annotations @Override

public final void destroy()

Implements com.jogamp.opengl.GLAutoDrawable.destroy.

Doc from com.jogamp.opengl.GLAutoDrawable.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 implementation calls defaultDestroy().

User still needs to destroy the upstream window, which details are hidden from this aspect. This can be performed by overriding destroyImplInLock().

Annotations

@Override

destroyImplInLock back to summary

destroyImplInLock	back to summary
protected void destroyImplInLock() Overrides jogamp.opengl.GLAutoDrawableBase.destroyImplInLock. Doc from jogamp.opengl.GLAutoDrawableBase.destroyImplInLock. Default implementation to destroys the drawable and context of this GLAutoDrawable: issues the GLEventListener dispose call, if drawable and context are valid destroys the GLContext, if valid destroys the GLDrawable, if valid Method assumes the lock is being hold. Override it to extend it to destroy your resources, i.e. the actual window. In such case call `super.destroyImplInLock` first. Annotations @Override

protected void destroyImplInLock()

Overrides jogamp.opengl.GLAutoDrawableBase.destroyImplInLock.

Doc from jogamp.opengl.GLAutoDrawableBase.destroyImplInLock.

Default implementation to destroys the drawable and context of this GLAutoDrawable:

issues the GLEventListener dispose call, if drawable and context are valid
destroys the GLContext, if valid
destroys the GLDrawable, if valid

Method assumes the lock is being hold.

Override it to extend it to destroy your resources, i.e. the actual window. In such case call super.destroyImplInLock first.

Annotations

@Override

display back to summary

display	back to summary
public void display() Implements com.jogamp.opengl.GLAutoDrawable.display. Doc from com.jogamp.opengl.GLAutoDrawable.display. Causes OpenGL rendering to be performed for this GLAutoDrawable in the following order: Calling `display(..)` for all registered `GLEventListener`s. Executes all one-shot `GLRunnable`, enqueued via `invoke(boolean, GLRunnable)`. May be called periodically by a running `com.jogamp.opengl.GLAnimatorControl` implementation, which must register itself with `setAnimator(com.jogamp.opengl.GLAnimatorControl)`. Called automatically by the window system toolkit upon receiving a repaint() request, except an `com.jogamp.opengl.GLAnimatorControl` implementation `com.jogamp.opengl.GLAnimatorControl#isAnimating()`. This routine may also be called manually for better control over the rendering process. It is legal to call another GLAutoDrawable's display method from within the `display(..)` callback. In case of a new generated OpenGL context, the implementation shall call `init(..)` for all registered `GLEventListener`s before making the actual `display(..)` calls, in case this has not been done yet. Annotations @Override

public void display()

Implements com.jogamp.opengl.GLAutoDrawable.display.

Doc from com.jogamp.opengl.GLAutoDrawable.display.

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

Calling display(..) for all registered GLEventListeners.
Executes all one-shot GLRunnable, enqueued via invoke(boolean, GLRunnable).

May be called periodically by a running com.jogamp.opengl.GLAnimatorControl implementation,
which must register itself with setAnimator(com.jogamp.opengl.GLAnimatorControl).

Called automatically by the window system toolkit upon receiving a repaint() request,
except an com.jogamp.opengl.GLAnimatorControl implementation com.jogamp.opengl.GLAnimatorControl#isAnimating().

This routine may also be called manually for better control over the rendering process. It is legal to call another GLAutoDrawable's display method from within the display(..) callback.

In case of a new generated OpenGL context, the implementation shall call init(..) for all registered GLEventListeners before making the actual display(..) calls, in case this has not been done yet.

Annotations

@Override

getFactory back to summary

getFactory	back to summary
public final GLDrawableFactory getFactory() Implements com.jogamp.opengl.GLDrawable.getFactory. Doc from com.jogamp.opengl.GLDrawable.getFactory. Return the `GLDrawableFactory` being used to create this instance. Annotations @Override

public final GLDrawableFactory getFactory()

Implements com.jogamp.opengl.GLDrawable.getFactory.

Doc from com.jogamp.opengl.GLDrawable.getFactory.

Return the GLDrawableFactory being used to create this instance.

Annotations

@Override

getUpstreamLock back to summary

getUpstreamLock	back to summary
public final RecursiveLock getUpstreamLock() Implements com.jogamp.opengl.GLAutoDrawable.getUpstreamLock. Doc from com.jogamp.opengl.GLAutoDrawable.getUpstreamLock. Returns the recursive lock object of the `upstream widget` to synchronize multithreaded access on top of `NativeSurface#lockSurface()`. See GLAutoDrawable Locking. Annotations @Override

public final RecursiveLock getUpstreamLock()

Implements com.jogamp.opengl.GLAutoDrawable.getUpstreamLock.

Doc from com.jogamp.opengl.GLAutoDrawable.getUpstreamLock.

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

See GLAutoDrawable Locking.

Annotations

@Override

getUpstreamWidget back to summary

public final Object getUpstreamWidget()

Implements com.jogamp.opengl.GLAutoDrawable.getUpstreamWidget.

Doc from com.jogamp.opengl.GLAutoDrawable.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()
NEWT	`com.jogamp.newt.opengl.GLWindow`	has a	`com.jogamp.newt.Window`
SWT	`com.jogamp.opengl.swt.GLCanvas`	is a	`org.eclipse.swt.widgets.Canvas`
AWT	`com.jogamp.opengl.awt.GLCanvas`	is a	`java.awt.Canvas`
AWT	`com.jogamp.opengl.awt.GLJPanel`	is a	`javax.swing.JPanel`

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.

Annotations

@Override

setUpstreamWidget back to summary

setUpstreamWidget	back to summary
public final void setUpstreamWidget(final Object newUpstreamWidget) Set the upstream UI toolkit object. See Also `getUpstreamWidget()`

public final void setUpstreamWidget(final Object newUpstreamWidget)

Set the upstream UI toolkit object.

See Also: getUpstreamWidget()

swapBuffers back to summary

swapBuffers	back to summary
public final void swapBuffers() throws GLException Implements com.jogamp.opengl.GLDrawable.swapBuffers. Doc from com.jogamp.opengl.GLDrawable.swapBuffers. Swaps the front and back buffers of this drawable. For `GLAutoDrawable` implementations, when automatic buffer swapping is enabled (as is the default), this method is called automatically and should not be called by the end user. Annotations @Override

public final void swapBuffers() throws GLException

Implements com.jogamp.opengl.GLDrawable.swapBuffers.

Doc from com.jogamp.opengl.GLDrawable.swapBuffers.

Swaps the front and back buffers of this drawable. For GLAutoDrawable implementations, when automatic buffer swapping is enabled (as is the default), this method is called automatically and should not be called by the end user.

Annotations

@Override

toString	back to summary
public String toString() Overrides jogamp.opengl.GLAutoDrawableBase.toString. Implements com.jogamp.opengl.GLDrawable.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides jogamp.opengl.GLAutoDrawableBase.toString.

Implements com.jogamp.opengl.GLDrawable.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

windowDestroyNotifyOp back to summary

windowDestroyNotifyOp	back to summary
public final void windowDestroyNotifyOp() Implementation to handle destroy notifications from the windowing system. If the `NativeSurface` does not implement `WindowClosingProtocol` or `WindowClosingMode#DISPOSE_ON_CLOSE` is enabled (default), a thread safe destruction is being induced.

public final void windowDestroyNotifyOp()

Implementation to handle destroy notifications from the windowing system.

If the NativeSurface does not implement WindowClosingProtocol or WindowClosingMode#DISPOSE_ON_CLOSE is enabled (default), a thread safe destruction is being induced.

windowRepaintOp	back to summary
public final void windowRepaintOp() Default implementation to handle repaint events from the windowing system

windowResizedOp back to summary

windowResizedOp	back to summary
public final void windowResizedOp(final int newWidth, final int newHeight) Handling resize events from the windowing system. Implementation: resizes `the GLDrawable`, if offscreen, triggers a pending `reshape events`, and issues a `display()` call, if no animator is present. All required locks are being claimed. Parameters newWidth:int new width in pixel units new height in pixel units

public final void windowResizedOp(final int newWidth, final int newHeight)

Handling resize events from the windowing system.

Implementation:

resizes the GLDrawable, if offscreen,
triggers a pending reshape events, and
issues a display() call, if no animator is present.

All required locks are being claimed.

Parameters

newWidth:int

new width in pixel units
new height in pixel units

public Class GLAutoDrawableDelegate

OpenGL Context Sharing

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail