Class GLCanvas
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Canvas
-
- com.jogamp.opengl.awt.GLCanvas
-
- All Implemented Interfaces:
AWTPrintLifecycle,NativeSurfaceHolder,OffscreenLayerOption,ScalableSurface,WindowClosingProtocol,AWTGLAutoDrawable,ComponentEvents,GLAutoDrawable,GLDrawable,GLSharedContextSetter,ImageObserver,MenuContainer,Serializable,Accessible
public class GLCanvas extends Canvas implements AWTGLAutoDrawable, WindowClosingProtocol, OffscreenLayerOption, AWTPrintLifecycle, GLSharedContextSetter, ScalableSurface
A heavyweight AWT component which provides OpenGL rendering support. This is the primary implementation of an AWTGLDrawable;GLJPanelis provided for compatibility with Swing user interfaces when adding a heavyweight doesn't work either because of Z-ordering or LayoutManager problems.Offscreen Layer Remarks
setShallUseOffscreenLayer(true)maybe called to use an offscreen drawable (FBO or PBuffer) allowing the underlying JAWT mechanism to composite the image, if supported.setShallUseOffscreenLayer(true)is being called ifCapabilitiesImmutable.isOnscreen()isfalse.Java2D OpenGL Remarks
To avoid any conflicts with a potential Java2D OpenGL context,
you shall consider setting the following JVM properties:
sun.java2d.opengl=false
sun.java2d.noddraw=true
GLProfile.GL2, eg. usingGLProfile#getMaxFixedFunc().
On the other hand, if you like to experiment with GLJPanel's utilization of Java2D's OpenGL pipeline, you have to set them tosun.java2d.opengl=true
sun.java2d.noddraw=true
Disable Background Erase
GLCanvas tries to disable background erase for the AWT Canvas before native peer creation (X11) and after it (Windows),
utilizing the optionalToolkitmethoddisableBeackgroundErase(java.awt.Canvas).
However if this does not give you the desired results, you may want to disable AWT background erase in general:sun.awt.noerasebackground=true
OpenGL Context Sharing
To share aGLContextsee the following note in the documentation overview: context sharing as well asGLSharedContextSetter.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
-
Nested classes/interfaces inherited from interface com.jogamp.nativewindow.awt.AWTPrintLifecycle
AWTPrintLifecycle.Context
-
Nested classes/interfaces inherited from interface com.jogamp.nativewindow.WindowClosingProtocol
WindowClosingProtocol.WindowClosingMode
-
-
Field Summary
-
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
-
Fields inherited from interface com.jogamp.nativewindow.awt.AWTPrintLifecycle
DEFAULT_PRINT_TILE_SIZE
-
Fields inherited from interface com.jogamp.opengl.GLAutoDrawable
SCREEN_CHANGE_ACTION_ENABLED
-
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
-
Fields inherited from interface com.jogamp.nativewindow.ScalableSurface
AUTOMAX_PIXELSCALE, IDENTITY_PIXELSCALE
-
-
Constructor Summary
Constructors Constructor Description GLCanvas()Creates a new GLCanvas component with a default set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism, on the default screen device.GLCanvas(GLCapabilitiesImmutable capsReqUser)Creates a new GLCanvas component with the requested set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism, on the default screen device.GLCanvas(GLCapabilitiesImmutable capsReqUser, GLCapabilitiesChooser chooser, GraphicsDevice device)Creates a new GLCanvas component.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddGLEventListener(int index, GLEventListener listener)Adds the givenlistenerat the given index of this drawable queue.voidaddGLEventListener(GLEventListener listener)Adds the givenlistenerto the end of this drawable queue.voidaddNotify()Overridden to track when this component is added to a container.booleanareAllGLEventListenerInitialized()Returns true if all addedGLEventListenerare initialized, otherwise false.booleancanSetSurfaceScale()Returns true ifScalableSurface.setSurfaceScale(float[])is supported, otherwise false.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.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()float[]getCurrentSurfaceScale(float[] result)Returns the current pixel scale of the associatedNativeSurface.WindowClosingProtocol.WindowClosingModegetDefaultCloseOperation()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.GraphicsConfigurationgetGraphicsConfiguration()longgetHandle()Returns the GL drawable handle, guaranteed to be valid afterrealizationand while it'ssurfaceis beinglocked.float[]getMaximumSurfaceScale(float[] result)Returns the maximum pixel scale of the associatedNativeSurface.float[]getMinimumSurfaceScale(float[] result)Returns the minimum pixel scale of the associatedNativeSurface.NativeSurfacegetNativeSurface()Returns the associatedNativeSurfaceof thisNativeSurfaceHolder.GLCapabilitiesImmutablegetRequestedGLCapabilities()Fetches theGLCapabilitiesImmutablecorresponding to the user requested OpenGL capabilities (pixel format / visual / GLProfile) for this drawable.float[]getRequestedSurfaceScale(float[] result)Returns therequestedpixel scale of the associatedNativeSurface.booleangetShallUseOffscreenLayer()Returns the property set byOffscreenLayerOption.setShallUseOffscreenLayer(boolean).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 glRunnable)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> glRunnables)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.booleanisOffscreenLayerSurfaceEnabled()Returns true if this instance uses an offscreen layer, otherwise false.booleanisRealized()Returnstrueif this drawable is realized, otherwisefalse.booleanisThreadGLCapable()Indicates whether the current thread is capable of performing OpenGL-related work.static voidmain(String[] args)A most simple JOGL AWT test entryvoidpaint(Graphics g)Overridden to cause OpenGL rendering to be performed during repaint cycles.voidprint(Graphics graphics)voidreleasePrint()Shall be called afterPrinterJob.print().GLEventListenerremoveGLEventListener(GLEventListener listener)Removes the givenlistenerfrom this drawable queue.voidremoveNotify()Overridden to track when this component is removed from a container.voidreshape(int x, int y, int width, int height)Overridden to causeGLDrawableHelper.reshape(com.jogamp.opengl.GLAutoDrawable, int, int, int, int)to be called on all registeredGLEventListeners.voidsetAnimator(GLAnimatorControl animatorControl)Registers the usage of an animator, anGLAnimatorControlimplementation.voidsetAutoSwapBufferMode(boolean onOrOff)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 flags)WindowClosingProtocol.WindowClosingModesetDefaultCloseOperation(WindowClosingProtocol.WindowClosingMode op)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 gl)Sets theGLpipeline object this GLAutoDrawable uses.voidsetGLEventListenerInitState(GLEventListener listener, boolean initialized)Sets the givenlistener'sinitialized state.voidsetRealized(boolean realized)Indicates to GLDrawable implementations whether the underlyingsurfacehas been created and can be drawn into.voidsetShallUseOffscreenLayer(boolean v)Request an offscreen layer, if supported.voidsetSharedAutoDrawable(GLAutoDrawable sharedAutoDrawable)Specifies anGLAutoDrawable, whichOpenGL contextshall be shared by thisGLAutoDrawable'sGLContext.voidsetSharedContext(GLContext sharedContext)booleansetSurfaceScale(float[] pixelScale)Request a pixel scale in x- and y-direction for the associatedNativeSurface, wheresize_in_pixel_units = pixel_scale * size_in_window_units.voidsetupPrint(double scaleMatX, double scaleMatY, int numSamples, int tileWidth, int tileHeight)Shall be called beforePrinterJob.print().voidswapBuffers()Swaps the front and back buffers of this drawable.StringtoString()voidupdate(Graphics g)Overridden from Canvas to prevent the AWT's clearing of the canvas from interfering with the OpenGL rendering.-
Methods inherited from class java.awt.Canvas
createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy
-
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, dispatchEvent, doLayout, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, preferredSize, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setMixingCutoutShape, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle, validate
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.jogamp.opengl.awt.AWTGLAutoDrawable
repaint, setSize
-
Methods inherited from interface com.jogamp.opengl.awt.ComponentEvents
addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener
-
-
-
-
Constructor Detail
-
GLCanvas
public GLCanvas() throws GLExceptionCreates a new GLCanvas component with a default set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism, on the default screen device.See details about OpenGL context sharing.
- Throws:
GLException- if no default profile is available for the default desktop device.
-
GLCanvas
public GLCanvas(GLCapabilitiesImmutable capsReqUser) throws GLException
Creates a new GLCanvas component with the requested set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism, on the default screen device.See details about OpenGL context sharing.
- Throws:
GLException- if no GLCapabilities are given and no default profile is available for the default desktop device.- See Also:
GLCanvas#GLCanvas(com.jogamp.opengl.GLCapabilitiesImmutable, com.jogamp.opengl.GLCapabilitiesChooser, com.jogamp.opengl.GLContext, java.awt.GraphicsDevice)
-
GLCanvas
public GLCanvas(GLCapabilitiesImmutable capsReqUser, GLCapabilitiesChooser chooser, GraphicsDevice device) throws GLException
Creates a new GLCanvas component. The passed GLCapabilities specifies the OpenGL capabilities for the component; if null, a default set of capabilities is used. The GLCapabilitiesChooser specifies the algorithm for selecting one of the available GLCapabilities for the component; a DefaultGLCapabilitesChooser is used if null is passed for this argument. The passed GraphicsDevice indicates the screen on which to create the GLCanvas; the GLDrawableFactory uses the default screen device of the local GraphicsEnvironment if null is passed for this argument.See details about OpenGL context sharing.
- Throws:
GLException- if no GLCapabilities are given and no default profile is available for the default desktop device.
-
-
Method Detail
-
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)
-
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
-
isThreadGLCapable
public final boolean isThreadGLCapable()
Description copied from interface:GLAutoDrawableIndicates 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.- Specified by:
isThreadGLCapablein interfaceGLAutoDrawable
-
setShallUseOffscreenLayer
public void setShallUseOffscreenLayer(boolean v)
Description copied from interface:com.jogamp.nativewindow.OffscreenLayerOptionRequest an offscreen layer, if supported.Shall be called before the first
NativeSurface.lockSurface(), and hence before realization.- Specified by:
setShallUseOffscreenLayerin interfaceOffscreenLayerOption- See Also:
OffscreenLayerOption.getShallUseOffscreenLayer(),OffscreenLayerOption.isOffscreenLayerSurfaceEnabled()
-
getShallUseOffscreenLayer
public final boolean getShallUseOffscreenLayer()
Description copied from interface:com.jogamp.nativewindow.OffscreenLayerOptionReturns the property set byOffscreenLayerOption.setShallUseOffscreenLayer(boolean).- Specified by:
getShallUseOffscreenLayerin interfaceOffscreenLayerOption
-
isOffscreenLayerSurfaceEnabled
public final boolean isOffscreenLayerSurfaceEnabled()
Description copied from interface:com.jogamp.nativewindow.OffscreenLayerOptionReturns true if this instance uses an offscreen layer, otherwise false.This instance is an offscreen layer, if
The return value is undefined before issuing the firstsetShallUseOffscreenLayer(true)has been called before it's realization and first lock and the underlying implementation supports it.NativeSurface.lockSurface().- Specified by:
isOffscreenLayerSurfaceEnabledin interfaceOffscreenLayerOption- See Also:
OffscreenLayerOption.setShallUseOffscreenLayer(boolean)
-
getGraphicsConfiguration
public GraphicsConfiguration getGraphicsConfiguration()
Overridden to choose a
GraphicsConfigurationfrom a parent container'sGraphicsDevice.Method also intercepts
GraphicsConfigurationchanges regarding to its capabilities and itsGraphicsDevice. This may happen in case the display changes its configuration or the component is moved to another screen.- Overrides:
getGraphicsConfigurationin classComponent
-
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
-
setRealized
public final void setRealized(boolean realized)
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
-
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)
-
getDefaultCloseOperation
public WindowClosingProtocol.WindowClosingMode getDefaultCloseOperation()
- Specified by:
getDefaultCloseOperationin interfaceWindowClosingProtocol- Returns:
- the current close operation value
- See Also:
WindowClosingProtocol.WindowClosingMode.DISPOSE_ON_CLOSE,WindowClosingProtocol.WindowClosingMode.DO_NOTHING_ON_CLOSE
-
setDefaultCloseOperation
public WindowClosingProtocol.WindowClosingMode setDefaultCloseOperation(WindowClosingProtocol.WindowClosingMode op)
- Specified by:
setDefaultCloseOperationin interfaceWindowClosingProtocol- Parameters:
op- the new close operation value- Returns:
- the previous close operation value
- See Also:
WindowClosingProtocol.WindowClosingMode.DISPOSE_ON_CLOSE,WindowClosingProtocol.WindowClosingMode.DO_NOTHING_ON_CLOSE
-
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
-
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. only destroys all GL related resources.
This impl. does not remove the GLCanvas from it's parent AWT container so this class's
removeNotify()AWT override won't get called. To do so, remove this component from it's parent AWT container.- Specified by:
destroyin interfaceGLAutoDrawable
-
paint
public void paint(Graphics g)
Overridden to cause OpenGL rendering to be performed during repaint cycles. Subclasses which override this method must call super.paint() in their paint() method in order to function properly.
-
addNotify
public void addNotify()
Overridden to track when this component is added to a container. Subclasses which override this method must call super.addNotify() in their addNotify() method in order to function properly.Overrides:
addNotifyin classjava.awt.Component
-
canSetSurfaceScale
public final boolean canSetSurfaceScale()
Returns true ifScalableSurface.setSurfaceScale(float[])is supported, otherwise false.For pure downstream scalable surfaces like AWT widgets, setting the picel scale is not supported since the pixel scale is set by the underlying toolkit.
This implementation returns false, i.e. not supporting manual change of pixel-scale.
- Specified by:
canSetSurfaceScalein interfaceScalableSurface
-
setSurfaceScale
public final boolean setSurfaceScale(float[] pixelScale)
Request a pixel scale in x- and y-direction for the associatedNativeSurface, wheresize_in_pixel_units = pixel_scale * size_in_window_units.Default pixel scale request for both directions is
ScalableSurface.AUTOMAX_PIXELSCALE.If
ScalableSurface.canSetSurfaceScale()returns false, requested pixel scale isScalableSurface.AUTOMAX_PIXELSCALE, immutable and method returns false.In case platform only supports uniform pixel scale, i.e. one scale for both directions, either
ScalableSurface.AUTOMAX_PIXELSCALEor the maximum requested pixel scale component is used.The requested pixel scale will be validated against platform limits before native scale-setup, i.e. clipped to
ScalableSurface.IDENTITY_PIXELSCALEif not supported or clipped to the platform maximum. It can be queried viaScalableSurface.getRequestedSurfaceScale(float[]).The actual realized pixel scale values of the
NativeSurfacecan be queried viaScalableSurface.getCurrentSurfaceScale(float[])or computed viasurface.convertToPixelUnits(new int[] { 1, 1 })Ignored for an AWT widget since pixelScale is dictated by AWT mechanisms.
- Specified by:
setSurfaceScalein interfaceScalableSurface- Parameters:
pixelScale- requested surface pixel scale float[2] values for x- and y-direction.- Returns:
trueif thecurrent pixel scalehas changed, otherwisefalse.- See Also:
ScalableSurface.getRequestedSurfaceScale(float[]),ScalableSurface.canSetSurfaceScale()
-
getRequestedSurfaceScale
public final float[] getRequestedSurfaceScale(float[] result)
Returns therequestedpixel scale of the associatedNativeSurface.If
ScalableSurface.canSetSurfaceScale()returns false, requested pixel scale isScalableSurface.AUTOMAX_PIXELSCALEand immutable.Returns
ScalableSurface.AUTOMAX_PIXELSCALE, always.- Specified by:
getRequestedSurfaceScalein interfaceScalableSurface- Parameters:
result- float[2] storage for the result- Returns:
- the passed storage containing the current pixelScale for chaining
- See Also:
ScalableSurface.setSurfaceScale(float[]),ScalableSurface.canSetSurfaceScale()
-
getCurrentSurfaceScale
public final float[] getCurrentSurfaceScale(float[] result)
Description copied from interface:com.jogamp.nativewindow.ScalableSurfaceReturns the current pixel scale of the associatedNativeSurface.- Specified by:
getCurrentSurfaceScalein interfaceScalableSurface- Parameters:
result- float[2] storage for the result- Returns:
- the passed storage containing the current pixelScale for chaining
-
getMinimumSurfaceScale
public float[] getMinimumSurfaceScale(float[] result)
Returns the minimum pixel scale of the associatedNativeSurface.Returns 1.0, always.
- Specified by:
getMinimumSurfaceScalein interfaceScalableSurface- Parameters:
result- float[2] storage for the result- Returns:
- the passed storage containing the minimum pixelScale for chaining
-
getMaximumSurfaceScale
public float[] getMaximumSurfaceScale(float[] result)
Returns the maximum pixel scale of the associatedNativeSurface.The maximum pixel scale maybe used to determine the proper dpi value of the monitor displaying this
NativeSurface.surfacePpMM = monitorPpMM * currentSurfaceScale / nativeSurfaceScale, with PpMM == pixel per millimeterReturns
getCurrentSurfaceScale(float[]).- Specified by:
getMaximumSurfaceScalein interfaceScalableSurface- Parameters:
result- float[2] storage for the result- Returns:
- the passed storage containing the maximum pixelScale for chaining
-
removeNotify
public void removeNotify()
Overridden to track when this component is removed from a container. Subclasses which override this method must call super.removeNotify() in their removeNotify() method in order to function properly.
User shall not call this method outside of EDT, read the AWT/Swing specs about this.
Overrides:removeNotifyin classjava.awt.Component
- Overrides:
removeNotifyin classComponent
-
reshape
public void reshape(int x, int y, int width, int height)Overridden to causeGLDrawableHelper.reshape(com.jogamp.opengl.GLAutoDrawable, int, int, int, int)to be called on all registeredGLEventListeners. Subclasses which override this method must call super.reshape() in their reshape() method in order to function properly.Overrides:
reshapein classjava.awt.Component
-
update
public void update(Graphics g)
Overridden from Canvas to prevent the AWT's clearing of the canvas from interfering with the OpenGL rendering.
-
setupPrint
public void setupPrint(double scaleMatX, double scaleMatY, int numSamples, int tileWidth, int tileHeight)Description copied from interface:com.jogamp.nativewindow.awt.AWTPrintLifecycleShall be called beforePrinterJob.print().See Usage.
- Specified by:
setupPrintin interfaceAWTPrintLifecycle- Parameters:
scaleMatX-Graphics2Dscaling factor, i.e. rendering 1/scaleMatX * width pixelsscaleMatY-Graphics2Dscaling factor, i.e. rendering 1/scaleMatY * height pixelsnumSamples- multisampling value: < 0 turns off, == 0 leaves as-is, > 0 enables using given num samplestileWidth- custom tile width fortile renderer, pass -1 for default.tileHeight- custom tile height fortile renderer, pass -1 for default. FIXME: Add border size !
-
releasePrint
public void releasePrint()
Description copied from interface:com.jogamp.nativewindow.awt.AWTPrintLifecycleShall be called afterPrinterJob.print().See Usage.
- Specified by:
releasePrintin interfaceAWTPrintLifecycle
-
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 index, 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:
index- Position where the listener will be inserted. Should be within (0 <= index && index <= size()). An index value of -1 is interpreted as the end of the list, size().listener- The GLEventListener object to be inserted- 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
-
setAnimator
public void setAnimator(GLAnimatorControl animatorControl)
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:
animatorControl-nullreference indicates no animator is using thisGLAutoDrawable,
a valid reference indicates an animator is using thisGLAutoDrawable.- See Also:
GLAutoDrawable.display(),GLAutoDrawable.invoke(boolean, GLRunnable),GLAnimatorControl
-
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)
-
invoke
public boolean invoke(boolean wait, GLRunnable glRunnable) 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 waitingglRunnable- 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> glRunnables) 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 waitingglRunnables- 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)
-
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
-
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
-
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
-
setGL
public GL setGL(GL gl)
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
-
setAutoSwapBufferMode
public void setAutoSwapBufferMode(boolean onOrOff)
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
-
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
-
swapBuffers
public void swapBuffers()
Description 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
-
setContextCreationFlags
public void setContextCreationFlags(int flags)
- Specified by:
setContextCreationFlagsin interfaceGLAutoDrawable- Parameters:
flags- Additional context creation flags.- See Also:
GLContext.setContextCreationFlags(int),GLContext.enableGLDebugMessage(boolean)
-
getContextCreationFlags
public int getContextCreationFlags()
- Specified by:
getContextCreationFlagsin interfaceGLAutoDrawable- Returns:
- Additional context creation flags
-
getGLProfile
public GLProfile getGLProfile()
Description copied from interface:GLDrawableFetches theGLProfilefor this drawable. Returns the GLProfile object, no copy.- Specified by:
getGLProfilein 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()
-
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
-
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()
-
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()
-
getFactory
public GLDrawableFactory getFactory()
Description copied from interface:GLDrawableReturn theGLDrawableFactorybeing used to create this instance.- Specified by:
getFactoryin interfaceGLDrawable
-
toString
public String toString()
- Specified by:
toStringin interfaceGLDrawable- Overrides:
toStringin classComponent
-
main
public static void main(String[] args)
A most simple JOGL AWT test entry
-
-