public class GLCanvas extends org.eclipse.swt.widgets.Canvas implements GLAutoDrawable
Note: To employ custom GLCapabilities, NewtCanvasSWT shall be used instead.
SCREEN_CHANGE_ACTION_ENABLED
Constructor and Description |
---|
GLCanvas(org.eclipse.swt.widgets.Composite parent,
int style,
GLCapabilitiesImmutable caps,
GLCapabilitiesChooser chooser,
GLContext shareWith)
Creates a new SWT GLCanvas.
|
Modifier and Type | Method and Description |
---|---|
void |
addGLEventListener(GLEventListener arg0)
Adds a
GLEventListener to the end of this drawable queue. |
void |
addGLEventListener(int arg0,
GLEventListener arg1)
Adds a
GLEventListener at the given index of this drawable queue. |
static GLCanvas |
create(org.eclipse.swt.widgets.Composite parent,
int style,
GLCapabilitiesImmutable caps,
GLCapabilitiesChooser chooser,
GLContext shareWith)
Creates an instance using
GLCanvas(Composite, int, GLCapabilitiesImmutable, GLCapabilitiesChooser, GLContext)
on the SWT thread. |
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()
Destroys all resources associated with this GLAutoDrawable,
inclusive the GLContext.
|
void |
display()
Causes OpenGL rendering to be performed for this GLAutoDrawable
in the following order:
Calling
display(..) for all
registered GLEventListener s. |
void |
dispose() |
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() |
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. |
int |
getHeight()
Returns the current height of this GLDrawable.
|
NativeSurface |
getNativeSurface()
Returns the underlying native surface which surface handle
represents this OpenGL drawable's native resource.
|
GLCapabilitiesImmutable |
getRequestedGLCapabilities()
Accessor for the GLCapabilities that were requested (via the constructor parameter).
|
Object |
getUpstreamWidget()
Method may return the upstream UI toolkit object
holding this
GLAutoDrawable instance, if exist. |
int |
getWidth()
Returns the current width of this GLDrawable.
|
boolean |
invoke(boolean wait,
GLRunnable run)
Enqueues a one-shot
GLRunnable ,
which will be executed within the next GLAutoDrawable.display() call
after all registered GLEventListener s
display(GLAutoDrawable)
methods has been called. |
boolean |
isRealized() |
static void |
main(String[] args) |
void |
removeGLEventListener(GLEventListener arg0)
Removes a
GLEventListener from this drawable. |
GLEventListener |
removeGLEventListener(int index)
Removes a
GLEventListener at the given index from this drawable. |
void |
setAnimator(GLAnimatorControl arg0)
Registers the usage of an animator, an
GLAnimatorControl implementation. |
void |
setAutoSwapBufferMode(boolean arg0)
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 arg0) |
GL |
setGL(GL arg0)
Sets the
GL pipeline object this GLAutoDrawable uses. |
void |
setRealized(boolean arg0)
Indicates to on-screen GLDrawable implementations whether the
underlying window has been created and can be drawn into.
|
void |
swapBuffers()
Swaps the front and back buffers of this drawable.
|
void |
update() |
drawBackground, getCaret, getIME, scroll, setCaret, setFont, setIME
changed, computeSize, drawBackground, getBackgroundMode, getChildren, getClientArea, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList
computeTrim, getBorderWidth, getHorizontalBar, getScrollbarsMode, getVerticalBar
addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse
addDisposeListener, addListener, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, reskin, setData, setData, toString
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
toString
public GLCanvas(org.eclipse.swt.widgets.Composite parent, int style, GLCapabilitiesImmutable caps, GLCapabilitiesChooser chooser, GLContext shareWith)
parent
- Required (non-null) parent Composite.style
- Optional SWT style bit-field. The SWT.NO_BACKGROUND
bit is set before passing this up to the
Canvas constructor, so OpenGL handles the background.caps
- Optional GLCapabilities. If not provided, the default capabilities for the default GLProfile for the
graphics device determined by the parent Composite are used. Note that the GLCapabilities that are
actually used may differ based on the capabilities of the graphics device.chooser
- Optional GLCapabilitiesChooser to customize the selection of the used GLCapabilities based on the
requested GLCapabilities, and the available capabilities of the graphics device.shareWith
- Optional GLContext to share state (textures, vbos, shaders, etc.) with.public static GLCanvas create(org.eclipse.swt.widgets.Composite parent, int style, GLCapabilitiesImmutable caps, GLCapabilitiesChooser chooser, GLContext shareWith)
GLCanvas(Composite, int, GLCapabilitiesImmutable, GLCapabilitiesChooser, GLContext)
on the SWT thread.parent
- Required (non-null) parent Composite.style
- Optional SWT style bit-field. The SWT.NO_BACKGROUND
bit is set before passing this up to the
Canvas constructor, so OpenGL handles the background.caps
- Optional GLCapabilities. If not provided, the default capabilities for the default GLProfile for the
graphics device determined by the parent Composite are used. Note that the GLCapabilities that are
actually used may differ based on the capabilities of the graphics device.chooser
- Optional GLCapabilitiesChooser to customize the selection of the used GLCapabilities based on the
requested GLCapabilities, and the available capabilities of the graphics device.shareWith
- Optional GLContext to share state (textures, vbos, shaders, etc.) with.public void display()
GLAutoDrawable
Causes OpenGL rendering to be performed for this GLAutoDrawable in the following order:
display(..)
for all
registered GLEventListener
s. 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 GLEventListener
s before making the
actual display(..)
calls,
in case this has not been done yet.
display
in interface GLAutoDrawable
GLAutoDrawable.setAnimator(javax.media.opengl.GLAnimatorControl)
public final Object getUpstreamWidget()
GLAutoDrawable
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 |
This method may also return null
if no UI toolkit is being used,
as common for offscreen rendering.
getUpstreamWidget
in interface GLAutoDrawable
public int getWidth()
GLDrawable
getWidth
in interface GLDrawable
public int getHeight()
GLDrawable
getHeight
in interface GLDrawable
public void addGLEventListener(GLEventListener arg0)
GLAutoDrawable
GLEventListener
to the end of this drawable queue.
The listeners are notified of events in the order of the queue.addGLEventListener
in interface GLAutoDrawable
public void addGLEventListener(int arg0, GLEventListener arg1) throws IndexOutOfBoundsException
GLAutoDrawable
GLEventListener
at the given index of this drawable queue.
The listeners are notified of events in the order of the queue.addGLEventListener
in interface GLAutoDrawable
arg0
- 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().arg1
- The GLEventListener object to be insertedIndexOutOfBoundsException
- If the index is not within (0 <= index && index <= size()), or -1public void destroy()
dispose(..)
for all
registered GLEventListener
s. Called automatically by the
window system toolkit upon receiving a destroy notification. This
routine may be called manually.
This impl. calls this class's dispose()
SWT override,
where the actual implementation resides.
destroy
in interface GLAutoDrawable
public GLAnimatorControl getAnimator()
getAnimator
in interface GLAutoDrawable
GLAnimatorControl
implementation, using this GLAutoDrawable
.GLAutoDrawable.setAnimator(javax.media.opengl.GLAnimatorControl)
,
GLAnimatorControl
public boolean getAutoSwapBufferMode()
GLAutoDrawable
GLAutoDrawable.setAutoSwapBufferMode(boolean)
.getAutoSwapBufferMode
in interface GLAutoDrawable
public GLContext getContext()
GLAutoDrawable
getContext
in interface GLAutoDrawable
public int getContextCreationFlags()
getContextCreationFlags
in interface GLAutoDrawable
public GL getGL()
GLAutoDrawable
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.getGL
in interface GLAutoDrawable
public boolean invoke(boolean wait, GLRunnable run)
GLAutoDrawable
Enqueues a one-shot GLRunnable
,
which will be executed within the next GLAutoDrawable.display()
call
after all registered GLEventListener
s
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.
invoke
in interface GLAutoDrawable
wait
- if true
block until execution of glRunnable
is finished, otherwise return immediatly w/o waitingrun
- the GLRunnable
to execute within GLAutoDrawable.display()
true
if the GLRunnable
has been processed or queued, otherwise false
.GLAutoDrawable.setAnimator(GLAnimatorControl)
,
GLAutoDrawable.display()
,
GLRunnable
public void removeGLEventListener(GLEventListener arg0)
GLAutoDrawable
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.removeGLEventListener
in interface GLAutoDrawable
arg0
- The GLEventListener object to be removedpublic GLEventListener removeGLEventListener(int index) throws IndexOutOfBoundsException
GLAutoDrawable
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.removeGLEventListener
in interface GLAutoDrawable
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.IndexOutOfBoundsException
- If the index is not within (0 <= index && index < size()), or -1public void setAnimator(GLAnimatorControl arg0) throws GLException
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.
setAnimator
in interface GLAutoDrawable
GLException
- if an animator is already registered.GLAutoDrawable.display()
,
GLAutoDrawable.invoke(boolean, GLRunnable)
,
GLAnimatorControl
public void setAutoSwapBufferMode(boolean arg0)
GLAutoDrawable
GLDrawable.swapBuffers(..)
manually.setAutoSwapBufferMode
in interface GLAutoDrawable
public GLContext setContext(GLContext newCtx)
GLAutoDrawable
newCtx.setGLDrawable(drawable, true);
.
drawable
might be an inner GLDrawable instance if using such a delegation pattern,
or this GLAutoDrawable itself.
If the old context's drawable was an GLAutoDrawable
, it's reference to the given drawable
is being cleared by calling
((GLAutoDrawable)oldCtx.getGLDrawable()).setContext(null)
.
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 not other thread attempts to make this context current. Otherwise a race condition may happen.
Disclaimer: Even though the API may allows this functionality in theory, your mileage may vary switching the drawable of an already established GLContext, i.e. which is already made current once. FIXME: Validate functionality!
setContext
in interface GLAutoDrawable
newCtx
- the new contextnull
GLContext.setGLDrawable(GLDrawable, boolean)
,
GLContext.setGLReadDrawable(GLDrawable)
,
GLDrawableHelper.switchContext(GLDrawable, GLContext, GLContext, int)
public void setContextCreationFlags(int arg0)
setContextCreationFlags
in interface GLAutoDrawable
arg0
- Additional context creation flags.GLContext.setContextCreationFlags(int)
,
GLContext.enableGLDebugMessage(boolean)
public GL setGL(GL arg0)
GLAutoDrawable
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.setGL
in interface GLAutoDrawable
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 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)
.
createContext
in interface GLAutoDrawable
createContext
in interface GLDrawable
public GLCapabilitiesImmutable getChosenGLCapabilities()
GLDrawable
GLCapabilitiesImmutable
corresponding to the chosen
OpenGL capabilities (pixel format / visual / GLProfile) for this drawable.NativeSurface
's
AbstractGraphicsConfiguration
, and if changes are necessary,
they should reflect those as well.getChosenGLCapabilities
in interface GLDrawable
public GLCapabilitiesImmutable getRequestedGLCapabilities()
public GLDrawableFactory getFactory()
GLDrawable
GLDrawableFactory
being used to create this instance.getFactory
in interface GLDrawable
public GLProfile getGLProfile()
GLDrawable
GLProfile
for this drawable.
Returns the GLProfile object, no copy.getGLProfile
in interface GLDrawable
public long getHandle()
GLDrawable
NativeSurface.getSurfaceHandle()
,
ie the native surface handle of the underlying windowing toolkit.getHandle
in interface GLDrawable
public NativeSurface getNativeSurface()
GLDrawable
getNativeSurface
in interface GLDrawable
GLDrawable.getHandle()
public boolean isRealized()
isRealized
in interface GLDrawable
public void setRealized(boolean arg0)
GLDrawable
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:
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 GLDrawable
public void swapBuffers() throws GLException
GLDrawable
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.swapBuffers
in interface GLDrawable
GLException
public void update()
update
in class org.eclipse.swt.widgets.Control
public void dispose()
dispose
in class org.eclipse.swt.widgets.Widget
public static void main(String[] args)
Copyright 2010 JogAmp Community.