public class GLJPanel extends JPanel implements AWTGLAutoDrawable, WindowClosingProtocol, AWTPrintLifecycle, GLSharedContextSetter, ScalableSurface
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(..).
A vertical-flip is required, if the drawable isGLOriented() and vertical flip is not skipped.
In this case this component performs the required vertical flip to bring the content from OpenGL's orientation into AWT's orientation.
In case GLSL based vertical-flip is not available,
the CPU intensive System.arraycopy(..) is used line by line.
See details about FBO and GLSL vertical flipping.
For performance reasons, as well as for GL state sideeffects,
skipping vertical flip is highly recommended!
The OpenGL path is concluded by copying the rendered pixels an BufferedImage via glReadPixels(..)
for later Java2D composition.
Finally the Java2D compositioning takes place via via Graphics.drawImage(...)
on the prepared BufferedImage as described above.
Please read Java2D OpenGL Remarks.
vertical flip is not skipped, 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 FBO / GLSL code path uses one texture-unit and binds the FBO texture to it's active texture-target,
see setTextureUnit(int) and getTextureUnit().
The active and dedicated texture-unit's GL.GL_TEXTURE_2D state is preserved via TextureState.
See also Order of Texture Commands.
The current gl-viewport is preserved.
Warning (Bug 842): Certain GL states other than viewport and texture (see above)
influencing rendering, will also influence the GLSL vertical flip, e.g. glFrontFace(GL.GL_CCW).
It is recommended to reset those states to default when leaving the GLEventListener.display(GLAutoDrawable) method!
We may change this behavior in the future, i.e. preserve all influencing states.
OpenGL Context Sharing
To share a GLContext see the following note in the documentation overview:
context sharing
as well as GLSharedContextSetter.
JComponent.AccessibleJComponentComponent.BaselineResizeBehaviorWindowClosingProtocol.WindowClosingModeAWTPrintLifecycle.ContextTOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWBOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTDEFAULT_PRINT_TILE_SIZESCREEN_CHANGE_ACTION_ENABLEDAUTOMAX_PIXELSCALE, IDENTITY_PIXELSCALEABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH| 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)
Creates a new GLJPanel component.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
boolean |
areAllGLEventListenerInitialized()
Returns true if all added
GLEventListener are initialized, otherwise false. |
GLContext |
createContext(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.
|
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. |
void |
flushGLRunnables()
|
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. |
GLContext |
getContext()
Returns the context associated with this drawable.
|
int |
getContextCreationFlags() |
float[] |
getCurrentSurfaceScale(float[] result)
Returns the current pixel scale of the associated
NativeSurface. |
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. |
float[] |
getMaximumSurfaceScale(float[] result)
Returns the maximum pixel scale of the associated
NativeSurface. |
float[] |
getMinimumSurfaceScale(float[] result)
Returns the minimum pixel scale of the associated
NativeSurface. |
NativeSurface |
getNativeSurface()
Returns the associated
NativeSurface of this NativeSurfaceHolder. |
GLCapabilitiesImmutable |
getRequestedGLCapabilities()
Fetches the
GLCapabilitiesImmutable corresponding to the user requested
OpenGL capabilities (pixel format / visual / GLProfile) for this drawable. |
float[] |
getRequestedSurfaceScale(float[] result)
Returns the
requested pixel scale of the associated NativeSurface. |
boolean |
getSkipGLOrientationVerticalFlip()
|
int |
getSurfaceHeight()
Returns the height of this
GLDrawable's surface client area in pixel units. |
int |
getSurfaceWidth()
Returns the width of this
GLDrawable's surface client area in pixel units. |
int |
getTextureUnit()
Returns the used texture unit, i.e.
|
RecursiveLock |
getUpstreamLock()
Returns the recursive lock object of the
upstream widget
to synchronize multithreaded access on top of NativeSurface.lockSurface(). |
Object |
getUpstreamWidget()
Method may return the upstream UI toolkit object
holding this
GLAutoDrawable instance, if exist. |
boolean |
initializeBackend(boolean offthread)
Attempts to initialize the backend, if not initialized yet.
|
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. |
boolean |
isThreadGLCapable()
Indicates whether the current thread is capable of
performing OpenGL-related work.
|
void |
print(Graphics graphics) |
void |
releasePrint()
Shall be called after
PrinterJob.print(). |
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(com.jogamp.opengl.GLAutoDrawable, int, int, int, int) to be
called on all registered GLEventListeners. |
void |
setAnimator(GLAnimatorControl animatorControl)
Registers the usage of an animator, an
GLAnimatorControl implementation. |
void |
setAutoSwapBufferMode(boolean enable)
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(AWTGLPixelBuffer.AWTGLPixelBufferProvider custom) |
void |
setRealized(boolean realized)
Indicates to GLDrawable implementations whether the
underlying
surface has been created and can be drawn into. |
void |
setRequestedGLCapabilities(GLCapabilitiesImmutable caps)
Set a new requested
GLCapabilitiesImmutable for this GLJPanel
allowing reconfiguration. |
void |
setSharedAutoDrawable(GLAutoDrawable sharedAutoDrawable)
Specifies an
GLAutoDrawable, which OpenGL context shall be shared by this GLAutoDrawable's GLContext. |
void |
setSharedContext(GLContext sharedContext)
|
void |
setSkipGLOrientationVerticalFlip(boolean v)
Skip
isGLOriented() based vertical flip,
which usually is required by the offscreen backend,
see details about vertical flip
and FBO / GLSL vertical flip. |
boolean |
setSurfaceScale(float[] pixelScale)
Request a pixel scale in x- and y-direction for the associated
NativeSurface,
where size_in_pixel_units = pixel_scale * size_in_window_units. |
void |
setTextureUnit(int v)
Allows user to request a texture unit to be used,
must be called before the first initialization, i.e.
|
void |
setupPrint(double scaleMatX,
double scaleMatY,
int numSamples,
int tileWidth,
int tileHeight)
Shall be called before
PrinterJob.print(). |
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() |
getAccessibleContext, getUI, getUIClassID, setUI, updateUIaddAncestorListener, 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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, 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, updateadd, 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, validateaction, 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, 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, transferFocusUpCycleequals, getClass, hashCode, notify, notifyAll, wait, wait, waitrepaint, setSizeaddComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListenerpublic GLJPanel()
throws GLException
See details about OpenGL context sharing.
GLException - if no default profile is available for the default desktop device.public GLJPanel(GLCapabilitiesImmutable userCapsRequest) throws GLException
See details about OpenGL context sharing.
GLException - if no GLCapabilities are given and no default profile is available for the default desktop device.public GLJPanel(GLCapabilitiesImmutable userCapsRequest, GLCapabilitiesChooser chooser) throws GLException
See details about OpenGL context sharing.
GLException - if no GLCapabilities are given and no default profile is available for the default desktop device.public final boolean initializeBackend(boolean offthread)
If backend is already initialized method returns true.
If offthread is true, initialization will kicked off
on a short lived arbitrary thread and method returns immediately.
If platform supports such arbitrary thread initialization method returns
true, otherwise false.
If offthread is false, initialization be performed
on the current thread and method returns after initialization.
Method returns true if initialization was successful, otherwise false.
offthread - public final void setSharedContext(GLContext sharedContext) throws IllegalStateException
GLSharedContextSetterOpenGL context, which shall be shared by this GLAutoDrawable's GLContext.
Since the drawable and context is created
at GLAutoDrawable initialization
this method shall be called beforehand to have any effect.
A set sharedContext will block context creation, i.e. GLAutoDrawable initialization,
as long it is not created natively.
The preferred method of assigning a shared context is
to set the shared GLAutoDrawable,
since this method also takes the GLEventListener
initialization into account.
setSharedContext in interface GLSharedContextSettersharedContext - The OpenGL context to be shared by this GLAutoDrawable's GLContext.IllegalStateException - if a shared GLContext
or shared GLAutoDrawable is already set,
the given sharedContext is null or equal to this GLAutoDrawable's context.GLSharedContextSetter.setSharedAutoDrawable(GLAutoDrawable)public final void setSharedAutoDrawable(GLAutoDrawable sharedAutoDrawable) throws IllegalStateException
GLSharedContextSetterGLAutoDrawable, which OpenGL context shall be shared by this GLAutoDrawable's GLContext.
Since the drawable and context is created
at GLAutoDrawable initialization
this method shall be called beforehand to have any effect.
A set sharedAutoDrawable will block context creation, i.e. initialization as long it's
GLContext is null, orGLContext has not been created natively, orGLEventListener are not completely initializedsetSharedAutoDrawable in interface GLSharedContextSetterIllegalStateException - if a shared GLContext
or shared GLAutoDrawable is already set,
the given sharedAutoDrawable is null or equal to this GLAutoDrawable.GLSharedContextSetter.setSharedContext(GLContext)public AWTGLPixelBuffer.AWTGLPixelBufferProvider getCustomPixelBufferProvider()
public void setPixelBufferProvider(AWTGLPixelBuffer.AWTGLPixelBufferProvider custom) throws IllegalArgumentException, IllegalStateException
custom - custom AWTGLPixelBuffer.AWTGLPixelBufferProviderIllegalArgumentException - if custom is nullIllegalStateException - if backend is already realized, i.e. this instanced already painted once.public final Object getUpstreamWidget()
GLAutoDrawableGLAutoDrawable 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
|
This method may also return null if no UI toolkit is being used,
as common for offscreen rendering.
getUpstreamWidget in interface GLAutoDrawablepublic final RecursiveLock getUpstreamLock()
GLAutoDrawableupstream widget
to synchronize multithreaded access on top of NativeSurface.lockSurface().
getUpstreamLock in interface GLAutoDrawablepublic final boolean isThreadGLCapable()
GLAutoDrawable
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.
isThreadGLCapable in interface GLAutoDrawablepublic void display()
GLAutoDrawableCauses OpenGL rendering to be performed for this GLAutoDrawable in the following order:
display(..) for all
registered GLEventListeners. GLRunnable,
enqueued via GLAutoDrawable.invoke(boolean, GLRunnable).
May be called periodically by a running GLAnimatorControl implementation,
which must register itself with GLAutoDrawable.setAnimator(com.jogamp.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.
display in interface GLAutoDrawableGLAutoDrawable.setAnimator(com.jogamp.opengl.GLAnimatorControl)public void destroy()
destroy in interface GLAutoDrawablepublic final boolean setSurfaceScale(float[] pixelScale)
ScalableSurfaceNativeSurface,
where size_in_pixel_units = pixel_scale * size_in_window_units.
Default pixel scale request for both directions is ScalableSurface.AUTOMAX_PIXELSCALE.
In case platform only supports uniform pixel scale, i.e. one scale for both directions,
either ScalableSurface.AUTOMAX_PIXELSCALE or 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_PIXELSCALE if not supported or clipped to the platform maximum.
It can be queried via ScalableSurface.getRequestedSurfaceScale(float[]).
The actual realized pixel scale values of the NativeSurface
can be queried via ScalableSurface.getCurrentSurfaceScale(float[]) or
computed via surface.
convertToPixelUnits(new int[] { 1, 1 })
setSurfaceScale in interface ScalableSurfacepixelScale - requested surface pixel scale float[2] values for x- and y-direction.true if the current pixel scale has changed, otherwise false.ScalableSurface.getRequestedSurfaceScale(float[])public final float[] getRequestedSurfaceScale(float[] result)
ScalableSurfacerequested pixel scale of the associated NativeSurface.getRequestedSurfaceScale in interface ScalableSurfaceresult - float[2] storage for the resultScalableSurface.setSurfaceScale(float[])public final float[] getCurrentSurfaceScale(float[] result)
ScalableSurfaceNativeSurface.getCurrentSurfaceScale in interface ScalableSurfaceresult - float[2] storage for the resultpublic float[] getMinimumSurfaceScale(float[] result)
ScalableSurfaceNativeSurface.getMinimumSurfaceScale in interface ScalableSurfaceresult - float[2] storage for the resultpublic float[] getMaximumSurfaceScale(float[] result)
ScalableSurfaceNativeSurface.
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 millimeter
getMaximumSurfaceScale in interface ScalableSurfaceresult - float[2] storage for the resultpublic void addNotify()
addNotify in class java.awt.ComponentaddNotify in class JComponentpublic void removeNotify()
removeNotify in class java.awt.ComponentremoveNotify in class JComponentpublic void reshape(int x,
int y,
int width,
int height)
GLDrawableHelper.reshape(com.jogamp.opengl.GLAutoDrawable, int, int, int, int) 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 JComponentpublic void setupPrint(double scaleMatX,
double scaleMatY,
int numSamples,
int tileWidth,
int tileHeight)
AWTPrintLifecyclePrinterJob.print().
See Usage.
setupPrint in interface AWTPrintLifecyclescaleMatX - Graphics2D scaling factor, i.e. rendering 1/scaleMatX * width pixelsscaleMatY - Graphics2D scaling 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 for tile renderer, pass -1 for default.tileHeight - custom tile height for tile renderer, pass -1 for default.
FIXME: Add border size !public void releasePrint()
AWTPrintLifecyclePrinterJob.print().
See Usage.
releasePrint in interface AWTPrintLifecyclepublic void print(Graphics graphics)
print in class JComponentpublic void setOpaque(boolean opaque)
setOpaque in class JComponentpublic void addGLEventListener(GLEventListener listener)
GLAutoDrawablelistener 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.
addGLEventListener in interface GLAutoDrawablelistener - The GLEventListener object to be insertedpublic void addGLEventListener(int index,
GLEventListener listener)
GLAutoDrawablelistener 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.
addGLEventListener in interface GLAutoDrawableindex - 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 insertedpublic int getGLEventListenerCount()
GLAutoDrawableGLEventListener of this drawable queue.getGLEventListenerCount in interface GLAutoDrawablepublic GLEventListener getGLEventListener(int index) throws IndexOutOfBoundsException
GLAutoDrawableGLEventListener at the given index of this drawable queue.getGLEventListener in interface GLAutoDrawableindex - 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.IndexOutOfBoundsException - If the index is not within (0 <= index && index < size()), or -1public boolean areAllGLEventListenerInitialized()
GLAutoDrawableGLEventListener are initialized, otherwise false.areAllGLEventListenerInitialized in interface GLAutoDrawablepublic boolean getGLEventListenerInitState(GLEventListener listener)
GLAutoDrawablelistener 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.
getGLEventListenerInitState in interface GLAutoDrawablelistener - the GLEventListener object to query it's initialized state.public void setGLEventListenerInitState(GLEventListener listener, boolean initialized)
GLAutoDrawablelistener'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(..).
setGLEventListenerInitState in interface GLAutoDrawablelistener - the GLEventListener object to perform a state change.initialized - if true, mark the listener initialized, otherwise uninitialized.public GLEventListener disposeGLEventListener(GLEventListener listener, boolean remove)
GLAutoDrawablelistener 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.
disposeGLEventListener in interface GLAutoDrawablelistener - The GLEventListener object to be disposed and removed if remove is trueremove - pass true to have the listener removed from this drawable queue, otherwise pass falsepublic GLEventListener removeGLEventListener(GLEventListener listener)
GLAutoDrawablelistener 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.
removeGLEventListener in interface GLAutoDrawablelistener - The GLEventListener object to be removedpublic void setAnimator(GLAnimatorControl animatorControl)
GLAutoDrawableGLAnimatorControl 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(com.jogamp.opengl.GLAutoDrawable), passing it's control implementation,
and AnimatorBase.remove(com.jogamp.opengl.GLAutoDrawable), passing null.
Impacts GLAutoDrawable.display() and GLAutoDrawable.invoke(boolean, GLRunnable) semantics.
setAnimator in interface GLAutoDrawableanimatorControl - null reference indicates no animator is using
this GLAutoDrawable,GLAutoDrawable.GLAutoDrawable.display(),
GLAutoDrawable.invoke(boolean, GLRunnable),
GLAnimatorControlpublic GLAnimatorControl getAnimator()
getAnimator in interface GLAutoDrawableGLAnimatorControl implementation, using this GLAutoDrawable.GLAutoDrawable.setAnimator(com.jogamp.opengl.GLAnimatorControl),
GLAnimatorControlpublic final Thread setExclusiveContextThread(Thread t) throws GLException
GLAutoDrawableGLContext to the given thread.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).
setExclusiveContextThread in interface GLAutoDrawablet - the exclusive thread to claim the context, or null for default operation.GLException - If an exclusive thread is still active but a new one is attempted to be setAnimatorBase.setExclusiveContext(boolean)public final Thread getExclusiveContextThread()
getExclusiveContextThread in interface GLAutoDrawableGLAutoDrawable.setExclusiveContextThread(Thread)public boolean invoke(boolean wait,
GLRunnable glRunnable)
throws IllegalStateException
GLAutoDrawableGLRunnable,
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.
To avoid a deadlock situation which causes an IllegalStateException one should
avoid issuing invoke while this GLAutoDrawable is being locked.
Detected deadlock situations throwing an IllegalStateException are:
invoke in interface GLAutoDrawablewait - if true block until execution of glRunnable is finished, otherwise return immediately w/o waitingglRunnable - the GLRunnable to execute within GLAutoDrawable.display()true if the GLRunnable has been processed or queued, otherwise false.IllegalStateException - in case of a detected deadlock situation ahead, see above.GLAutoDrawable.setAnimator(GLAnimatorControl),
GLAutoDrawable.display(),
GLRunnable,
GLAutoDrawable.invoke(boolean, List),
GLAutoDrawable.flushGLRunnables()public boolean invoke(boolean wait,
List<GLRunnable> glRunnables)
throws IllegalStateException
GLAutoDrawableGLAutoDrawable.invoke(boolean, GLRunnable) functionality
allowing to inject a list of GLRunnables.invoke in interface GLAutoDrawablewait - if true block until execution of the last glRunnable is finished, otherwise return immediately w/o waitingglRunnables - the GLRunnables to execute within GLAutoDrawable.display()true if the GLRunnables has been processed or queued, otherwise false.IllegalStateException - in case of a detected deadlock situation ahead, see GLAutoDrawable.invoke(boolean, GLRunnable).GLAutoDrawable.invoke(boolean, GLRunnable),
GLAutoDrawable.flushGLRunnables()public void flushGLRunnables()
GLAutoDrawableenqueued GLRunnable of this GLAutoDrawable
including notifying waiting executor.
The executor which might have been blocked until notified will be unblocked and all tasks removed from the queue.
flushGLRunnables in interface GLAutoDrawableGLAutoDrawable.invoke(boolean, GLRunnable)public GLContext createContext(GLContext shareWith)
GLAutoDrawable
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
context sharing
as well as GLSharedContextSetter.
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).
createContext in interface GLAutoDrawablecreateContext in interface GLDrawablepublic void setRealized(boolean realized)
GLDrawablesurface 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:
GLCapabilities, which are associated with
the attached NativeSurface's AbstractGraphicsConfiguration.NativeSurface's unlockSurface().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.
setRealized in interface GLDrawableGLDrawable.isRealized(),
GLDrawable.getHandle(),
NativeSurface.lockSurface()public boolean isRealized()
GLDrawabletrue if this drawable is realized, otherwise true.
A drawable can be realized and unrealized via GLDrawable.setRealized(boolean).
isRealized in interface GLDrawableGLDrawable.setRealized(boolean)public GLContext setContext(GLContext newCtx, boolean destroyPrevCtx)
GLAutoDrawablenewtCtx, to this auto-drawable.
Remarks:
destroyPrevCtx is true,
otherwise it will be disassociated from this auto-drawable
via setGLDrawable(null, true); including glFinish().newCtx.setGLDrawable(drawable, true);.#makeCurrent() and #release() while drawable reassociation.auto-drawable's
upstream-locks and surfaces
to avoid a race condition. See GLAutoDrawable Locking.setContext in interface GLAutoDrawablenewCtx - the new context, maybe null for dis-association.destroyPrevCtx - if true, destroy the previous context if existsnullGLContext.setGLDrawable(GLDrawable, boolean),
GLContext.setGLReadDrawable(GLDrawable),
GLDrawableHelper.switchContext(GLDrawable, GLContext, boolean, GLContext, int)public final GLDrawable getDelegatedDrawable()
GLAutoDrawableGLDrawable instance,
otherwise return this instance.getDelegatedDrawable in interface GLAutoDrawablepublic GLContext getContext()
GLAutoDrawablegetContext in interface GLAutoDrawablepublic GL getGL()
GLAutoDrawableGL 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.getGL in interface GLAutoDrawablepublic GL setGL(GL gl)
GLAutoDrawableGL 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.setGL in interface GLAutoDrawablepublic void setAutoSwapBufferMode(boolean enable)
GLAutoDrawableGLDrawable.swapBuffers(..) manually.setAutoSwapBufferMode in interface GLAutoDrawablepublic boolean getAutoSwapBufferMode()
GLAutoDrawableGLAutoDrawable.setAutoSwapBufferMode(boolean).getAutoSwapBufferMode in interface GLAutoDrawablepublic void swapBuffers()
GLDrawableGLAutoDrawable 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.swapBuffers in interface GLDrawablepublic void setContextCreationFlags(int flags)
setContextCreationFlags in interface GLAutoDrawableflags - Additional context creation flags.GLContext.setContextCreationFlags(int),
GLContext.enableGLDebugMessage(boolean)public int getContextCreationFlags()
getContextCreationFlags in interface GLAutoDrawablepublic boolean shouldPreserveColorBufferIfTranslucent()
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.public int getSurfaceWidth()
GLDrawableGLDrawable's surface client area in pixel units.getSurfaceWidth in interface GLDrawableNativeSurface.getSurfaceWidth()public int getSurfaceHeight()
GLDrawableGLDrawable's surface client area in pixel units.getSurfaceHeight in interface GLDrawableNativeSurface.getSurfaceHeight()public boolean isGLOriented()
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.
Method returns a valid value only after
the backend has been initialized, either eagerly
or manually via the first display call.
Method always returns a valid value when called from within a GLEventListener.
isGLOriented in interface GLDrawablepublic final void setSkipGLOrientationVerticalFlip(boolean v)
isGLOriented() based vertical flip,
which usually is required by the offscreen backend,
see details about vertical flip
and FBO / GLSL vertical flip.
If set to true, user needs to flip the OpenGL rendered scene
if isGLOriented() == true, e.g. via the projection matrix.
See constraints of isGLOriented().
public final boolean getSkipGLOrientationVerticalFlip()
public GLCapabilitiesImmutable getChosenGLCapabilities()
GLDrawableGLCapabilitiesImmutable corresponding 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's
AbstractGraphicsConfiguration, and if changes are necessary,
they should reflect those as well.
getChosenGLCapabilities in interface GLDrawableGLDrawable.getRequestedGLCapabilities()public final GLCapabilitiesImmutable getRequestedGLCapabilities()
GLDrawableGLCapabilitiesImmutable corresponding to the user requested
OpenGL capabilities (pixel format / visual / GLProfile) for this drawable.
If realized, the chosen capabilities
reflect the actual selected OpenGL capabilities.
getRequestedGLCapabilities in interface GLDrawableGLDrawable.getChosenGLCapabilities()public final void setRequestedGLCapabilities(GLCapabilitiesImmutable caps)
GLCapabilitiesImmutable for this GLJPanel
allowing reconfiguration.
Method shall be invoked from the AWT-EDT thread.
In case it is not invoked on the AWT-EDT thread, an attempt is made to do so.
Method will dispose a previous realized GLContext and offscreen backend!
caps - new capabilities.public final GLProfile getGLProfile()
GLDrawableGLProfile for this drawable.
Returns the GLProfile object, no copy.getGLProfile in interface GLDrawablepublic NativeSurface getNativeSurface()
GLDrawableNativeSurface of this NativeSurfaceHolder.
Returns the underlying NativeSurface which native handle
represents this OpenGL drawable's native resource.
getNativeSurface in interface NativeSurfaceHoldergetNativeSurface in interface GLDrawableGLDrawable.getHandle()public long getHandle()
GLDrawablerealization
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 NativeSurface.lockSurface().
getHandle in interface GLDrawableGLDrawable.setRealized(boolean),
NativeSurface.lockSurface(),
NativeSurface.unlockSurface()public final GLDrawableFactory getFactory()
GLDrawableGLDrawableFactory being used to create this instance.getFactory in interface GLDrawablepublic final int getTextureUnit()
If implementation uses a texture-unit, it will be known only after the first initialization, i.e. display call.
public final void setTextureUnit(int v)
display() call.
Defaults to 0.
v - requested texture unitgetTextureUnit()public WindowClosingProtocol.WindowClosingMode getDefaultCloseOperation()
getDefaultCloseOperation in interface WindowClosingProtocolWindowClosingProtocol.WindowClosingMode.DISPOSE_ON_CLOSE,
WindowClosingProtocol.WindowClosingMode.DO_NOTHING_ON_CLOSEpublic WindowClosingProtocol.WindowClosingMode setDefaultCloseOperation(WindowClosingProtocol.WindowClosingMode op)
setDefaultCloseOperation in interface WindowClosingProtocolop - the new close operation valueWindowClosingProtocol.WindowClosingMode.DISPOSE_ON_CLOSE,
WindowClosingProtocol.WindowClosingMode.DO_NOTHING_ON_CLOSEpublic String toString()
toString in interface GLDrawabletoString in class ComponentCopyright 2010 JogAmp Community.