com.jogamp.opengl.swt
Class GLCanvas

java.lang.Object
  extended by org.eclipse.swt.widgets.Widget
      extended by org.eclipse.swt.widgets.Control
          extended by org.eclipse.swt.widgets.Scrollable
              extended by org.eclipse.swt.widgets.Composite
                  extended by org.eclipse.swt.widgets.Canvas
                      extended by com.jogamp.opengl.swt.GLCanvas
All Implemented Interfaces:
GLAutoDrawable, GLDrawable, org.eclipse.swt.graphics.Drawable

public class GLCanvas
extends org.eclipse.swt.widgets.Canvas
implements GLAutoDrawable

Native SWT Canvas implementing GLAutoDrawable

FIXME: Still needs AWT for threading impl., ie. will issue a 'wrong thread' error if runs in headless mode!


Field Summary
 
Fields inherited from class org.eclipse.swt.widgets.Composite
embeddedHandle
 
Fields inherited from class org.eclipse.swt.widgets.Widget
handle
 
Fields inherited from interface javax.media.opengl.GLAutoDrawable
SCREEN_CHANGE_ACTION_ENABLED
 
Constructor Summary
GLCanvas(org.eclipse.swt.widgets.Composite parent, int style, GLCapabilitiesImmutable caps, GLCapabilitiesChooser chooser, GLContext shareWith)
          Creates a new SWT GLCanvas.
 
Method Summary
 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.
 GLContext createContext(GLContext arg0)
          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 GLEventListeners.
 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()
           
 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).
 int getWidth()
          Returns the current width of this GLDrawable.
 void invoke(boolean wait, GLRunnable run)
           Enqueues a one-shot GLRunnable, which will be executed with the next GLAutoDrawable.display() call.
 boolean isRealized()
           
static void main(String[] args)
           
 void removeGLEventListener(GLEventListener arg0)
          Removes a GLEventListener 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.
 void setContext(GLContext ctx)
          Associate a new context to this drawable.
 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()
           
 
Methods inherited from class org.eclipse.swt.widgets.Canvas
drawBackground, getCaret, getIME, scroll, setCaret, setFont, setIME
 
Methods inherited from class org.eclipse.swt.widgets.Composite
changed, computeSize, drawBackground, getBackgroundMode, getChildren, getClientArea, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList
 
Methods inherited from class org.eclipse.swt.widgets.Scrollable
computeTrim, getBorderWidth, getHorizontalBar, getVerticalBar
 
Methods inherited from class org.eclipse.swt.widgets.Control
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
 
Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, reskin, setData, setData, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.media.opengl.GLDrawable
toString
 

Constructor Detail

GLCanvas

public GLCanvas(org.eclipse.swt.widgets.Composite parent,
                int style,
                GLCapabilitiesImmutable caps,
                GLCapabilitiesChooser chooser,
                GLContext shareWith)
Creates a new SWT GLCanvas.

Parameters:
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.
Method Detail

addGLEventListener

public void addGLEventListener(GLEventListener arg0)
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 arg0,
                               GLEventListener arg1)
                        throws IndexOutOfBoundsException
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:
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 inserted
Throws:
IndexOutOfBoundsException - If the index is not within (0 <= index && index <= size()), or -1

destroy

public void destroy()
Destroys all resources associated with this GLAutoDrawable, inclusive the GLContext. If a window is attached to it's implementation, it shall be closed. Causes disposing of all OpenGL resources by calling dispose(..) for all registered GLEventListeners. Called automatically by the window system toolkit upon receiving a destroy notification. This routine may be called manually.

Also disposes of the SWT component.

Specified by:
destroy in interface GLAutoDrawable

display

public void display()
Description copied from interface: GLAutoDrawable

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

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

Called automatically by the window system toolkit upon receiving a repaint() request,
except an GLAnimatorControl implementation GLAnimatorControl.isAnimating().

This routine may also be called manually for better control over the rendering process. It is legal to call another GLAutoDrawable's display method from within the display(..) callback.

In case of a new generated OpenGL context, the implementation shall call init(..) for all registered GLEventListeners before making the actual display(..) calls, in case this has not been done yet.

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

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

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

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

getContextCreationFlags

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

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

invoke

public void invoke(boolean wait,
                   GLRunnable run)
Description copied from interface: GLAutoDrawable

Enqueues a one-shot GLRunnable, which will be executed with the next GLAutoDrawable.display() call.

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 implementation waits until the GLRunnable is executed.


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

removeGLEventListener

public void removeGLEventListener(GLEventListener arg0)
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

setAnimator

public void setAnimator(GLAnimatorControl arg0)
                 throws GLException
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
Throws:
GLException - if an animator is already registered.
See Also:
GLAutoDrawable.display(), GLAutoDrawable.invoke(boolean, GLRunnable), GLAnimatorControl

setAutoSwapBufferMode

public void setAutoSwapBufferMode(boolean arg0)
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

setContext

public void setContext(GLContext ctx)
Description copied from interface: GLAutoDrawable
Associate a new context to this drawable.

Specified by:
setContext in interface GLAutoDrawable

setContextCreationFlags

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

setGL

public GL setGL(GL arg0)
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

createContext

public GLContext createContext(GLContext arg0)
Description copied from interface: GLDrawable
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.

Specified by:
createContext in interface GLDrawable

getChosenGLCapabilities

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

Specified by:
getChosenGLCapabilities in interface GLDrawable
Returns:
A copy of the queried object.

getRequestedGLCapabilities

public GLCapabilitiesImmutable getRequestedGLCapabilities()
Accessor for the GLCapabilities that were requested (via the constructor parameter).

Returns:
Non-null GLCapabilities.

getFactory

public GLDrawableFactory getFactory()
Specified by:
getFactory in interface GLDrawable

getGLProfile

public 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

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

getHeight

public int getHeight()
Description copied from interface: GLDrawable
Returns the current height of this GLDrawable.

Specified by:
getHeight 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()

getWidth

public int getWidth()
Description copied from interface: GLDrawable
Returns the current width of this GLDrawable.

Specified by:
getWidth in interface GLDrawable

isRealized

public boolean isRealized()
Specified by:
isRealized in interface GLDrawable
Returns:
true if this drawable is realized, otherwise false

setRealized

public void setRealized(boolean arg0)
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:


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

swapBuffers

public void swapBuffers()
                 throws GLException
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
Throws:
GLException

update

public void update()
Overrides:
update in class org.eclipse.swt.widgets.Control

dispose

public void dispose()
Overrides:
dispose in class org.eclipse.swt.widgets.Widget

main

public static void main(String[] args)


Copyright 2010 JogAmp Community.