javax.media.opengl.awt
Class GLJPanel

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by javax.media.opengl.awt.GLJPanel
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, WindowClosingProtocol, AWTGLAutoDrawable, ComponentEvents, GLAutoDrawable, GLDrawable

public class GLJPanel
extends JPanel
implements AWTGLAutoDrawable, WindowClosingProtocol

A lightweight Swing component which provides OpenGL rendering support. Provided for compatibility with Swing user interfaces when adding a heavyweight doesn't work either because of Z-ordering or LayoutManager problems.

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

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

In case FBO is used and GLSL is available, a fragment shader is utilized to flip the FBO texture vertically. This hardware-accelerated step can be disabled via system property jogl.gljpanel.noglsl.

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

In case the above mentioned GLSL vertical-flipping is not performed, System.arraycopy(..) is used line by line. This step causes more CPU load per frame and is not hardware-accelerated.

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

Please read Java2D OpenGL Remarks.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
 
Nested classes/interfaces inherited from interface javax.media.nativewindow.WindowClosingProtocol
WindowClosingProtocol.WindowClosingMode
 
Field Summary
 
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface javax.media.opengl.GLAutoDrawable
SCREEN_CHANGE_ACTION_ENABLED
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
GLJPanel()
          Creates a new GLJPanel component with a default set of OpenGL capabilities and using the default OpenGL capabilities selection mechanism.
GLJPanel(GLCapabilitiesImmutable userCapsRequest)
          Creates a new GLJPanel component with the requested set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism.
GLJPanel(GLCapabilitiesImmutable userCapsRequest, GLCapabilitiesChooser chooser, GLContext shareWith)
          Creates a new GLJPanel component.
 
Method Summary
 void addGLEventListener(GLEventListener listener)
          Adds the given listener to the end of this drawable queue.
 void addGLEventListener(int index, GLEventListener listener)
          Adds the given listener at the given index of this drawable queue.
 void addNotify()
          Overridden to track when this component is added to a container.
 GLContext createContext(GLContext shareWith)
          Creates a new context for drawing to this drawable that will optionally share display lists and other server-side OpenGL objects with the specified GLContext.
 void destroy()
          Just an alias for removeNotify
 void display()
           Causes OpenGL rendering to be performed for this GLAutoDrawable in the following order: Calling display(..) for all registered GLEventListeners.
 GLEventListener disposeGLEventListener(GLEventListener listener, boolean remove)
          Disposes the given listener via dispose(..) if it has been initialized and added to this queue.
 GLAnimatorControl getAnimator()
           
 boolean getAutoSwapBufferMode()
          Indicates whether automatic buffer swapping is enabled for this drawable.
 GLCapabilitiesImmutable getChosenGLCapabilities()
          Fetches the GLCapabilitiesImmutable corresponding to the chosen OpenGL capabilities (pixel format / visual / GLProfile) for this drawable.
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.
 GLContext getContext()
          Returns the context associated with this drawable.
 int getContextCreationFlags()
           
 com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider getCustomPixelBufferProvider()
           
 WindowClosingProtocol.WindowClosingMode getDefaultCloseOperation()
           
 GLDrawable getDelegatedDrawable()
          If the implementation uses delegation, return the delegated GLDrawable instance, otherwise return this instance.
 Thread getExclusiveContextThread()
           
 GLDrawableFactory getFactory()
          Return the GLDrawableFactory being used to create this instance.
 GL getGL()
          Returns the GL pipeline object this GLAutoDrawable uses.
 GLEventListener getGLEventListener(int index)
          Returns the GLEventListener at the given index of this drawable queue.
 int getGLEventListenerCount()
          Returns the number of GLEventListener of this drawable queue.
 boolean getGLEventListenerInitState(GLEventListener listener)
          Retrieves whether the given listener is initialized or not.
 GLProfile getGLProfile()
          Fetches the GLProfile for this drawable.
 long getHandle()
          Returns the GL drawable handle, guaranteed to be valid after realization and while it's surface is being locked.
 NativeSurface getNativeSurface()
          Returns the underlying native surface which surface handle represents this OpenGL drawable's native resource.
 Object getUpstreamWidget()
          Method may return the upstream UI toolkit object holding this GLAutoDrawable instance, if exist.
 boolean invoke(boolean wait, GLRunnable glRunnable)
          Enqueues a one-shot GLRunnable, which will be executed within the next GLAutoDrawable.display() call after all registered GLEventListeners display(GLAutoDrawable) methods have been called.
 boolean invoke(boolean wait, List<GLRunnable> glRunnables)
          Extends GLAutoDrawable.invoke(boolean, GLRunnable) functionality allowing to inject a list of GLRunnables.
 boolean isGLOriented()
          Returns true if the drawable is rendered in OpenGL's coordinate system, origin at bottom left.
 boolean isRealized()
          Returns true if this drawable is realized, otherwise true.
 GLEventListener removeGLEventListener(GLEventListener listener)
          Removes the given listener from this drawable queue.
 void removeNotify()
          Overridden to track when this component is removed from a container.
 void reshape(int x, int y, int width, int height)
          Overridden to cause GLDrawableHelper.reshape(javax.media.opengl.GLEventListener, javax.media.opengl.GLAutoDrawable, int, int, int, int, boolean, boolean) to be called on all registered GLEventListeners.
 void setAnimator(GLAnimatorControl animatorControl)
          Registers the usage of an animator, an GLAnimatorControl implementation.
 void setAutoSwapBufferMode(boolean onOrOff)
          Enables or disables automatic buffer swapping for this drawable.
 GLContext setContext(GLContext newCtx, boolean destroyPrevCtx)
          Associate the new context, newtCtx, to this auto-drawable.
 void setContextCreationFlags(int flags)
           
 WindowClosingProtocol.WindowClosingMode setDefaultCloseOperation(WindowClosingProtocol.WindowClosingMode op)
           
 Thread setExclusiveContextThread(Thread t)
          Dedicates this instance's GLContext to the given thread.
The thread will exclusively claim the GLContext via GLAutoDrawable.display() and not release it until GLAutoDrawable.destroy() or setExclusiveContextThread(null) has been called.
 GL setGL(GL gl)
          Sets the GL pipeline object this GLAutoDrawable uses.
 void setGLEventListenerInitState(GLEventListener listener, boolean initialized)
          Sets the given listener's initialized state.
 void setOpaque(boolean opaque)
           
 void setPixelBufferProvider(com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider custom)
           
 void setRealized(boolean realized)
          Indicates to GLDrawable implementations whether the underlying surface has been created and can be drawn into.
 boolean shouldPreserveColorBufferIfTranslucent()
          For a translucent GLJPanel (one for which setOpaque(false) has been called), indicates whether the application should preserve the OpenGL color buffer (GL_COLOR_BUFFER_BIT) for correct rendering of the GLJPanel and underlying widgets which may show through portions of the GLJPanel with alpha values less than 1.
 void swapBuffers()
          Swaps the front and back buffers of this drawable.
 String toString()
           
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.media.opengl.awt.AWTGLAutoDrawable
repaint, setSize
 
Methods inherited from interface javax.media.opengl.GLDrawable
getHeight, getWidth
 
Methods inherited from interface javax.media.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

GLJPanel

public GLJPanel()
         throws GLException
Creates a new GLJPanel component with a default set of OpenGL capabilities and using the default OpenGL capabilities selection mechanism.

Throws:
GLException - if no default profile is available for the default desktop device.

GLJPanel

public GLJPanel(GLCapabilitiesImmutable userCapsRequest)
         throws GLException
Creates a new GLJPanel component with the requested set of OpenGL capabilities, using the default OpenGL capabilities selection mechanism.

Throws:
GLException - if no GLCapabilities are given and no default profile is available for the default desktop device.

GLJPanel

public GLJPanel(GLCapabilitiesImmutable userCapsRequest,
                GLCapabilitiesChooser chooser,
                GLContext shareWith)
         throws GLException
Creates a new GLJPanel component. The passed GLCapabilities specifies the OpenGL capabilities for the component; if null, a default set of capabilities is used. The GLCapabilitiesChooser specifies the algorithm for selecting one of the available GLCapabilities for the component; a DefaultGLCapabilitesChooser is used if null is passed for this argument. The passed GLContext specifies an OpenGL context with which to share textures, display lists and other OpenGL state, and may be null if sharing is not desired. See the note in the overview documentation on context sharing.

Note: Sharing cannot be enabled using J2D OpenGL FBO sharing, since J2D GL Context must be shared and we can only share one context.

Throws:
GLException - if no GLCapabilities are given and no default profile is available for the default desktop device.
Method Detail

getCustomPixelBufferProvider

public com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider getCustomPixelBufferProvider()

setPixelBufferProvider

public void setPixelBufferProvider(com.jogamp.opengl.util.awt.AWTGLPixelBuffer.AWTGLPixelBufferProvider custom)
                            throws IllegalArgumentException,
                                   IllegalStateException
Parameters:
custom - custom AWTGLPixelBuffer.AWTGLPixelBufferProvider
Throws:
IllegalArgumentException - if custom is null
IllegalStateException - if backend is already realized, i.e. this instanced already painted once.

getUpstreamWidget

public final Object getUpstreamWidget()
Description copied from interface: GLAutoDrawable
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 GLCanvas is a Canvas
AWT GLJPanel is a 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.

Specified by:
getUpstreamWidget in interface GLAutoDrawable
Returns:

display

public void display()
Description copied from interface: GLAutoDrawable

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

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

Called automatically by the window system toolkit upon receiving a repaint() request,
except an GLAnimatorControl implementation 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.

Specified by:
display in interface GLAutoDrawable
See Also:
GLAutoDrawable.setAnimator(javax.media.opengl.GLAnimatorControl)

destroy

public void destroy()
Just an alias for removeNotify

Specified by:
destroy in interface GLAutoDrawable

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.

addNotify in class java.awt.Component

Overrides:
addNotify in class JComponent

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.

removeNotify in class java.awt.Component

Overrides:
removeNotify in class JComponent

reshape

public void reshape(int x,
                    int y,
                    int width,
                    int height)
Overridden to cause GLDrawableHelper.reshape(javax.media.opengl.GLEventListener, javax.media.opengl.GLAutoDrawable, int, int, int, int, boolean, boolean) to be called on all registered GLEventListeners. Subclasses which override this method must call super.reshape() in their reshape() method in order to function properly.

Overrides:
reshape in class JComponent

setOpaque

public void setOpaque(boolean opaque)
Overrides:
setOpaque in class JComponent

addGLEventListener

public void addGLEventListener(GLEventListener listener)
Description copied from interface: GLAutoDrawable
Adds the given listener to the end of this drawable queue. The listeners are notified of events in the order of the queue.

The newly added listener's init(..) method will be called once before any other of it's callback methods. See GLAutoDrawable.getGLEventListenerInitState(GLEventListener) for details.

Specified by:
addGLEventListener in interface GLAutoDrawable
Parameters:
listener - The GLEventListener object to be inserted

addGLEventListener

public void addGLEventListener(int index,
                               GLEventListener listener)
Description copied from interface: GLAutoDrawable
Adds the given listener at the given index of this drawable queue. The listeners are notified of events in the order of the queue.

The newly added listener's init(..) method will be called once before any other of it's callback methods. See GLAutoDrawable.getGLEventListenerInitState(GLEventListener) for details.

Specified by:
addGLEventListener in interface GLAutoDrawable
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

getGLEventListenerCount

public int getGLEventListenerCount()
Description copied from interface: GLAutoDrawable
Returns the number of GLEventListener of this drawable queue.

Specified by:
getGLEventListenerCount in interface GLAutoDrawable
Returns:
The number of GLEventListener objects of this drawable queue.

getGLEventListener

public GLEventListener getGLEventListener(int index)
                                   throws IndexOutOfBoundsException
Description copied from interface: GLAutoDrawable
Returns the GLEventListener at the given index of this drawable queue.

Specified by:
getGLEventListener in interface GLAutoDrawable
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

getGLEventListenerInitState

public boolean getGLEventListenerInitState(GLEventListener listener)
Description copied from interface: GLAutoDrawable
Retrieves whether the given listener is initialized or not.

After adding a GLEventListener it is marked uninitialized and added to a list of to be initialized GLEventListener. If such uninitialized GLEventListener's handler methods (reshape, display) are about to be invoked, it's init(..) method is invoked first. Afterwards the GLEventListener is marked initialized and removed from the list of to be initialized GLEventListener.

This methods returns the GLEventListener initialized state, i.e. returns false if it is included in the list of to be initialized GLEventListener, otherwise true.

Specified by:
getGLEventListenerInitState in interface GLAutoDrawable
Parameters:
listener - the GLEventListener object to query it's initialized state.

setGLEventListenerInitState

public void setGLEventListenerInitState(GLEventListener listener,
                                        boolean initialized)
Description copied from interface: GLAutoDrawable
Sets the given listener's initialized state.

This methods allows manually setting the GLEventListener initialized state, i.e. adding it to, or removing it from the list of to be initialized GLEventListener. See GLAutoDrawable.getGLEventListenerInitState(GLEventListener) for details.

Warning: This method does not validate whether the given listener's is member of this drawable queue, i.e. added.

This method is only exposed to allow users full control over the GLEventListener's state and is usually not recommended to change.

One use case is moving a GLContext and their initialized GLEventListener from one GLAutoDrawable to another, where a subsequent init(..) call after adding it to the new owner is neither required nor desired. See swapGLContextAndAllGLEventListener(..).

Specified by:
setGLEventListenerInitState in interface GLAutoDrawable
Parameters:
listener - the GLEventListener object to perform a state change.
initialized - if true, mark the listener initialized, otherwise uninitialized.

disposeGLEventListener

public GLEventListener disposeGLEventListener(GLEventListener listener,
                                              boolean remove)
Description copied from interface: GLAutoDrawable
Disposes the given listener via dispose(..) if it has been initialized and added to this queue.

If remove is true, the GLEventListener is removed from this drawable queue before disposal, otherwise marked uninitialized.

If an GLAnimatorControl is being attached and the current thread is different than the animator's thread, it is paused during the operation.

Note that this is an expensive operation, since dispose(..) is decorated by GLContext.makeCurrent() and GLContext.release().

Use removeGLEventListener(listener) instead if you just want to remove the listener and don't care about the disposal of the it's (OpenGL) resources.

Also note that this is done from within a particular drawable's GLEventListener handler (reshape, display, etc.), that it is not guaranteed that all other listeners will be evaluated properly during this update cycle.

Specified by:
disposeGLEventListener in interface GLAutoDrawable
Parameters:
listener - The GLEventListener object to be disposed and removed if remove is true
remove - pass true to have the listener removed from this drawable queue, otherwise pass false
Returns:
the disposed and/or removed GLEventListener, or null if no action was performed, i.e. listener was not added

removeGLEventListener

public GLEventListener removeGLEventListener(GLEventListener listener)
Description copied from interface: GLAutoDrawable
Removes the given listener from this drawable queue.

This is an inexpensive operation, since the removed listener's dispose(..) method will not be called.

Use disposeGLEventListener(listener, true) instead to ensure disposal of the listener's (OpenGL) resources.

Note that if this is done from within a particular drawable's GLEventListener handler (reshape, display, etc.), that it is not guaranteed that all other listeners will be evaluated properly during this update cycle.

Specified by:
removeGLEventListener in interface GLAutoDrawable
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: GLAutoDrawable
Registers the usage of an animator, an GLAnimatorControl implementation. The animator will be queried whether it's animating, ie periodically issuing GLAutoDrawable.display() calls or not.

This method shall be called by an animator implementation only,
e.g. AnimatorBase.add(javax.media.opengl.GLAutoDrawable), passing it's control implementation,
and AnimatorBase.remove(javax.media.opengl.GLAutoDrawable), passing null.

Impacts GLAutoDrawable.display() and GLAutoDrawable.invoke(boolean, GLRunnable) semantics.


Specified by:
setAnimator in interface GLAutoDrawable
See Also:
GLAutoDrawable.display(), GLAutoDrawable.invoke(boolean, GLRunnable), GLAnimatorControl

getAnimator

public GLAnimatorControl getAnimator()
Specified by:
getAnimator in interface GLAutoDrawable
Returns:
the registered GLAnimatorControl implementation, using this GLAutoDrawable.
See Also:
GLAutoDrawable.setAnimator(javax.media.opengl.GLAnimatorControl), GLAnimatorControl

setExclusiveContextThread

public final Thread setExclusiveContextThread(Thread t)
                                       throws GLException
Description copied from interface: GLAutoDrawable
Dedicates this instance's GLContext to the given thread.
The thread will exclusively claim the GLContext via GLAutoDrawable.display() and not release it until GLAutoDrawable.destroy() or setExclusiveContextThread(null) has been called.

Default non-exclusive behavior is requested via setExclusiveContextThread(null), which will cause the next call of GLAutoDrawable.display() on the exclusive thread to release the GLContext. Only after it's async release, GLAutoDrawable.getExclusiveContextThread() will return null.

To release a previous made exclusive thread, a user issues setExclusiveContextThread(null) and may poll GLAutoDrawable.getExclusiveContextThread() until it returns null, while the exclusive thread is still running.

Note: Setting a new exclusive thread without properly releasing a previous one will throw an GLException.

Note: Utilizing this feature w/ AWT could lead to an AWT-EDT deadlock, depending on the AWT implementation. Hence it is advised not to use it with native AWT GLAutoDrawable like GLCanvas.

One scenario could be to dedicate the context to the animator thread and spare redundant context switches, see AnimatorBase.setExclusiveContext(boolean).

Specified by:
setExclusiveContextThread in interface GLAutoDrawable
Parameters:
t - the exclusive thread to claim the context, or null for 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:
getExclusiveContextThread in interface GLAutoDrawable
See Also:
GLAutoDrawable.setExclusiveContextThread(Thread)

invoke

public boolean invoke(boolean wait,
                      GLRunnable glRunnable)
Description copied from interface: GLAutoDrawable
Enqueues a one-shot GLRunnable, which will be executed within the next GLAutoDrawable.display() call after all registered GLEventListeners display(GLAutoDrawable) methods have been called.

If no GLAnimatorControl is animating (default),
or if the current thread is the animator thread,
a GLAutoDrawable.display() call is issued after enqueue the GLRunnable, hence the GLRunnable will be executed right away.

If an animator is running,
no explicit GLAutoDrawable.display() call is issued, allowing the animator to perform at due time.

If wait is true the call blocks until the glRunnable has been executed by the animator, otherwise the method returns immediately.

If wait is true and GLDrawable.isRealized() returns false or GLAutoDrawable.getContext() returns null, the call is ignored and returns false.
This helps avoiding deadlocking the caller.

The internal queue of GLRunnable's is being flushed with GLAutoDrawable.destroy() where all blocked callers are being notified.

Specified by:
invoke in interface GLAutoDrawable
Parameters:
wait - if true block until execution of glRunnable is finished, otherwise return immediately w/o waiting
glRunnable - the GLRunnable to execute within GLAutoDrawable.display()
Returns:
true if the GLRunnable has been processed or queued, otherwise false.
See Also:
GLAutoDrawable.setAnimator(GLAnimatorControl), GLAutoDrawable.display(), GLRunnable, #enqueue(GLRunnable)

invoke

public boolean invoke(boolean wait,
                      List<GLRunnable> glRunnables)
Description copied from interface: GLAutoDrawable
Extends GLAutoDrawable.invoke(boolean, GLRunnable) functionality allowing to inject a list of GLRunnables.

Specified by:
invoke in interface GLAutoDrawable
Parameters:
wait - if true block until execution of the last glRunnable is finished, otherwise return immediately w/o waiting
glRunnables - the GLRunnables to execute within GLAutoDrawable.display()
Returns:
true if the GLRunnables has been processed or queued, otherwise false.

createContext

public GLContext createContext(GLContext shareWith)
Description copied from interface: GLAutoDrawable
Creates a new context for drawing to this drawable that will optionally share display lists and other server-side OpenGL objects with the specified GLContext.

The GLContext share need not be associated with this GLDrawable and may be null if sharing of display lists and other objects is not desired. See the note in the overview documentation on context sharing.

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:
createContext in interface GLAutoDrawable
Specified by:
createContext in interface GLDrawable

setRealized

public void setRealized(boolean realized)
Description copied from interface: GLDrawable
Indicates to GLDrawable implementations whether the underlying surface has been created and can be drawn into.

If realized, the drawable handle may become valid while it's surface is being locked.

End users do not need to call this method; it is not necessary to call setRealized on a GLAutoDrawable as these perform the appropriate calls on their underlying GLDrawables internally.

Developers implementing new OpenGL components for various window toolkits need to call this method against GLDrawables obtained from the GLDrawableFactory via the GLDrawableFactory.createGLDrawable(NativeSurface) method. It must typically be called with an argument of true when the component associated with the GLDrawable is realized and with an argument of false just before the component is unrealized. For the AWT, this means calling setRealized(true) in the addNotify method and with an argument of false in the removeNotify method.

GLDrawable implementations should handle multiple cycles of setRealized(true) / setRealized(false) calls. Most, if not all, Java window toolkits have a persistent object associated with a given component, regardless of whether that component is currently realized. The GLDrawable object associated with a particular component is intended to be similarly persistent. A GLDrawable is intended to be created for a given component when it is constructed and live as long as that component. setRealized allows the GLDrawable to re-initialize and destroy any associated resources as the component becomes realized and unrealized, respectively.

With an argument of true, the minimum implementation shall call NativeSurface's lockSurface() and if successful:


This is important since NativeSurface's lockSurface() ensures resolving the window/surface handles, and the drawable's GLCapabilities might have changed.

Calling this method has no other effects. For example, if removeNotify is called on a Canvas implementation for which a GLDrawable has been created, it is also necessary to destroy all OpenGL contexts associated with that GLDrawable. This is not done automatically by the implementation.

Specified by:
setRealized in interface GLDrawable
See Also:
GLDrawable.isRealized(), GLDrawable.getHandle(), NativeSurface.lockSurface()

isRealized

public boolean isRealized()
Description copied from interface: GLDrawable
Returns true if this drawable is realized, otherwise true.

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

Specified by:
isRealized in interface GLDrawable
See Also:
GLDrawable.setRealized(boolean)

setContext

public GLContext setContext(GLContext newCtx,
                            boolean destroyPrevCtx)
Description copied from interface: GLAutoDrawable
Associate the new context, newtCtx, to this auto-drawable.

The current context will be destroyed if destroyPrevCtx is true, otherwise it will be dis-associated from this auto-drawable via setGLDrawable(null, true); first.

The new context will be associated with this auto-drawable via newCtx.setGLDrawable(drawable, true);.

If the old or new context was current on this thread, it is being released before switching the association. The new context will be made current afterwards, if it was current before. However the user shall take extra care that no other thread attempts to make this context current.

Specified by:
setContext in interface GLAutoDrawable
Parameters:
newCtx - the new context, maybe null for dis-association.
destroyPrevCtx - if true, 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)

getDelegatedDrawable

public final GLDrawable getDelegatedDrawable()
Description copied from interface: GLAutoDrawable
If the implementation uses delegation, return the delegated GLDrawable instance, otherwise return this instance.

Specified by:
getDelegatedDrawable in interface GLAutoDrawable

getContext

public GLContext getContext()
Description copied from interface: GLAutoDrawable
Returns 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:
getContext in interface GLAutoDrawable

getGL

public GL getGL()
Description copied from interface: GLAutoDrawable
Returns the GL pipeline object this GLAutoDrawable uses. If this method is called outside of the GLEventListener's callback methods (init, display, etc.) it may return null. Users should not rely on the identity of the returned GL object; for example, users should not maintain a hash table with the GL object as the key. Additionally, the GL object should not be cached in client code, but should be re-fetched from the GLAutoDrawable at the beginning of each call to init, display, etc.

Specified by:
getGL in interface GLAutoDrawable

setGL

public GL setGL(GL gl)
Description copied from interface: GLAutoDrawable
Sets the GL pipeline object this GLAutoDrawable uses. This should only be called from within the GLEventListener's callback methods, and usually only from within the init() method, in order to install a composable pipeline. See the JOGL demos for examples.

Specified by:
setGL in interface GLAutoDrawable
Returns:
the set GL pipeline or null if not successful

setAutoSwapBufferMode

public void setAutoSwapBufferMode(boolean onOrOff)
Description copied from interface: GLAutoDrawable
Enables or disables automatic buffer swapping for this drawable. By default this property is set to true; when true, after all GLEventListeners have been called for a display() event, the front and back buffers are swapped, displaying the results of the render. When disabled, the user is responsible for calling GLDrawable.swapBuffers(..) manually.

Specified by:
setAutoSwapBufferMode in interface GLAutoDrawable

getAutoSwapBufferMode

public boolean getAutoSwapBufferMode()
Description copied from interface: GLAutoDrawable
Indicates whether automatic buffer swapping is enabled for this drawable. See GLAutoDrawable.setAutoSwapBufferMode(boolean).

Specified by:
getAutoSwapBufferMode in interface GLAutoDrawable

swapBuffers

public void swapBuffers()
Description copied from interface: GLDrawable
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.

Specified by:
swapBuffers in interface GLDrawable

setContextCreationFlags

public void setContextCreationFlags(int flags)
Specified by:
setContextCreationFlags in interface GLAutoDrawable
Parameters:
flags - Additional context creation flags.
See Also:
GLContext.setContextCreationFlags(int), GLContext.enableGLDebugMessage(boolean)

getContextCreationFlags

public int getContextCreationFlags()
Specified by:
getContextCreationFlags in interface GLAutoDrawable
Returns:
Additional context creation flags

shouldPreserveColorBufferIfTranslucent

public boolean shouldPreserveColorBufferIfTranslucent()
For a translucent GLJPanel (one for which setOpaque(false) has been called), indicates whether the application should preserve the OpenGL color buffer (GL_COLOR_BUFFER_BIT) for correct rendering of the GLJPanel and underlying widgets which may show through portions of the GLJPanel with alpha values less than 1. Most Swing implementations currently expect the GLJPanel to be completely cleared (e.g., by glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT)), but for certain optimized Swing implementations which use OpenGL internally, it may be possible to perform OpenGL rendering using the GLJPanel into the same OpenGL drawable as the Swing implementation uses.


isGLOriented

public boolean isGLOriented()
Description copied from interface: GLDrawable
Returns true if the drawable is rendered in OpenGL's coordinate system, origin at bottom left. Otherwise returns false, i.e. origin at top left.

Default impl. is true, i.e. OpenGL coordinate system.

Currently only MS-Windows bitmap offscreen drawable uses a non OpenGL orientation and hence returns false.
This removes the need of a vertical flip when used in AWT or Windows applications.

Specified by:
isGLOriented in interface GLDrawable

getChosenGLCapabilities

public GLCapabilitiesImmutable getChosenGLCapabilities()
Description copied from interface: GLDrawable
Fetches the GLCapabilitiesImmutable corresponding to the chosen OpenGL capabilities (pixel format / visual / GLProfile) for this drawable.
On some platforms, the pixel format is not directly associated with the drawable; a best attempt is made to return a reasonable value in this case.
This object shall be directly associated to the attached NativeSurface's AbstractGraphicsConfiguration, and if changes are necessary, they should reflect those as well.

Specified by:
getChosenGLCapabilities in interface GLDrawable
Returns:
The immutable queried instance.

getGLProfile

public final GLProfile getGLProfile()
Description copied from interface: GLDrawable
Fetches the GLProfile for this drawable. Returns the GLProfile object, no copy.

Specified by:
getGLProfile in interface GLDrawable

getNativeSurface

public NativeSurface getNativeSurface()
Description copied from interface: GLDrawable
Returns the underlying native surface which surface handle represents this OpenGL drawable's native resource.

Specified by:
getNativeSurface in interface GLDrawable
See Also:
GLDrawable.getHandle()

getHandle

public long getHandle()
Description copied from interface: GLDrawable
Returns the GL drawable handle, guaranteed to be valid after realization and while it's surface is being locked.

It is usually identical to the underlying windowing toolkit surface's handle or an intermediate layer to suite GL, e.g. an EGL surface.

On EGL it is represented by the EGLSurface.
On X11/GLX it is represented by either the Window XID, GLXPixmap, or GLXPbuffer.
On Windows it is represented by the HDC, which may change with each #lockSurface().

Specified by:
getHandle in interface GLDrawable
See Also:
GLDrawable.setRealized(boolean), NativeSurface.lockSurface(), NativeSurface.unlockSurface()

getFactory

public final GLDrawableFactory getFactory()
Description copied from interface: GLDrawable
Return the GLDrawableFactory being used to create this instance.

Specified by:
getFactory in interface GLDrawable

getDefaultCloseOperation

public WindowClosingProtocol.WindowClosingMode getDefaultCloseOperation()
Specified by:
getDefaultCloseOperation in interface WindowClosingProtocol

setDefaultCloseOperation

public WindowClosingProtocol.WindowClosingMode setDefaultCloseOperation(WindowClosingProtocol.WindowClosingMode op)
Specified by:
setDefaultCloseOperation in interface WindowClosingProtocol

toString

public String toString()
Specified by:
toString in interface GLDrawable
Overrides:
toString in class Component


Copyright 2010 JogAmp Community.