javax.media.opengl.awt

Class GLJPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

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.

Notes specific to the Reference Implementation: This component attempts to use hardware-accelerated rendering via pbuffers and falls back on to software rendering if problems occur. Note that because this component attempts to use pbuffers for rendering, and because pbuffers can not be resized, somewhat surprising behavior may occur during resize operations; the GLEventListener.init(javax.media.opengl.GLAutoDrawable) method may be called multiple times as the pbuffer is resized to be able to cover the size of the GLJPanel. This behavior is correct, as the textures and display lists for the GLJPanel will have been lost during the resize operation. The application should attempt to make its GLEventListener.init() methods as side-effect-free as possible.

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

Constructors

Constructor and Description
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

Methods

Modifier and Type	Method and Description
void	addGLEventListener(GLEventListener listener) Adds a GLEventListener to the end of this drawable queue.
void	addGLEventListener(int index, GLEventListener listener) Adds a GLEventListener 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.
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()
WindowClosingProtocol.WindowClosingMode	getDefaultCloseOperation()
GLDrawable	getDelegatedDrawable() If the implementation uses delegation, return the delegated GLDrawable instance, otherwise return this instance.
GLDrawableFactory	getFactory() Return the GLDrawableFactory being used to create this instance.
GL	getGL() Returns the GL pipeline object this GLAutoDrawable uses.
GLProfile	getGLProfile() Fetches the GLProfile for this drawable.
long	getHandle() This is the GL/Windowing drawable handle. It is usually the NativeSurface.getSurfaceHandle(), ie the native surface handle of the underlying windowing toolkit. However, on X11/GLX this reflects a GLXDrawable, which represents a GLXWindow, GLXPixmap, or GLXPbuffer. On EGL, this represents the EGLSurface.
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 has been called.
boolean	isRealized()
void	removeGLEventListener(GLEventListener listener) Removes a GLEventListener from this drawable.
GLEventListener	removeGLEventListener(int index) Removes a GLEventListener at the given index from this drawable.
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) Associate a new context to this drawable and also propagates the context/drawable switch by calling newCtx.setGLDrawable(drawable, true);.
void	setContextCreationFlags(int flags)
WindowClosingProtocol.WindowClosingMode	setDefaultCloseOperation(WindowClosingProtocol.WindowClosingMode op)
GL	setGL(GL gl) Sets the GL pipeline object this GLAutoDrawable uses.
void	setOpaque(boolean opaque)
void	setRealized(boolean realized) Indicates to on-screen GLDrawable implementations whether the underlying window 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

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	GLWindow	has a	Window
SWT	GLCanvas	is a	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:

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

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.

reshape in class java.awt.Component

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 a GLEventListener to the end of this drawable queue. The listeners are notified of events in the order of the queue.

Specified by:

addGLEventListener in interface GLAutoDrawable

addGLEventListener

public void addGLEventListener(int index,
                      GLEventListener listener)

Description copied from interface: GLAutoDrawable

Adds a GLEventListener at the given index of this drawable queue. The listeners are notified of events in the order of the queue.

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

removeGLEventListener

public void removeGLEventListener(GLEventListener listener)

Description copied from interface: GLAutoDrawable

Removes a GLEventListener from this drawable. 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

removeGLEventListener

public GLEventListener removeGLEventListener(int index)
                                      throws IndexOutOfBoundsException

Description copied from interface: GLAutoDrawable

Removes a GLEventListener at the given index from this drawable. 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:

index - Position of the listener to be removed. Should be within (0 <= index && index < size()). An index value of -1 is interpreted as last listener, size()-1.

Returns:

The removed GLEventListener object

Throws:

IndexOutOfBoundsException - If the index is not within (0 <= index && index < size()), or -1

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

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 has 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.
No extra synchronization is performed in case wait is true, since it is executed in the current thread.

If an GLAnimatorControl is animating,
no GLAutoDrawable.display() call is issued, since the animator thread performs it.

If wait is true the call blocks until the glRunnable has been executed.

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

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

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 on-screen GLDrawable implementations whether the underlying window has been created and can be drawn into. End users do not need to call this method; it is not necessary to call setRealized on a GLCanvas, a GLJPanel, or a GLPbuffer, 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.getGLDrawable() 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 successfull:

• Update the GLCapabilities, which are associated with the attached NativeSurface's AbstractGraphicsConfiguration.
• Release the lock with NativeSurface's unlockSurface().

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

isRealized

public boolean isRealized()

Specified by:

isRealized in interface GLDrawable

Returns:

true if this drawable is realized, otherwise false

setContext

public GLContext setContext(GLContext newCtx)

Description copied from interface: GLAutoDrawable

Associate a new context to this drawable and also propagates the context/drawable switch by calling newCtx.setGLDrawable(drawable, true);. drawable might be an inner GLDrawable instance if using a delegation pattern, or this GLAutoDrawable instance.

If the old or new context was current on this thread, it is being released before switching the drawable. 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.

Be aware that the old context is still bound to the drawable, and that one context can only be bound to one drawable at one time!

In case you do not intend to use the old context anymore, i.e. not assigning it to another drawable, it shall be destroyed before setting the new context, i.e.:

            GLContext oldCtx = glad.getContext();
            if(null != oldCtx) {
                oldCtx.destroy();
            }
            glad.setContext(newCtx);            
 

This is required, since a context must have a valid drawable at all times and this API shall not restrict the user in any way.

Specified by:

setContext in interface GLAutoDrawable

Parameters:

newCtx - the new context

Returns:

the replaced GLContext, maybe null

See Also:

GLContext.setGLDrawable(GLDrawable, boolean), GLContext.setGLReadDrawable(GLDrawable), GLDrawableHelper.switchContext(GLDrawable, GLContext, 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.

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

This is the GL/Windowing drawable handle.
It is usually the NativeSurface.getSurfaceHandle(), ie the native surface handle of the underlying windowing toolkit.
However, on X11/GLX this reflects a GLXDrawable, which represents a GLXWindow, GLXPixmap, or GLXPbuffer.
On EGL, this represents the EGLSurface.

Specified by:

getHandle in interface GLDrawable

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

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:

setDefaultCloseOperation in interface WindowClosingProtocol

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

toString

public String toString()

Specified by:

toString in interface GLDrawable

Overrides:

toString in class Component