com.jogamp.opengl.impl
Class GLPbufferImpl

java.lang.Object
  extended by com.jogamp.opengl.impl.GLPbufferImpl
All Implemented Interfaces:
GLAutoDrawable, GLDrawable, GLPbuffer

public class GLPbufferImpl
extends Object
implements GLPbuffer

Platform-independent class exposing pbuffer functionality to applications. This class is not exposed in the public API as it would probably add no value; however it implements the GLDrawable interface so can be interacted with via its display() method.


Field Summary
 
Fields inherited from interface javax.media.opengl.GLPbuffer
APPLE_FLOAT, ATI_FLOAT, NV_FLOAT
 
Fields inherited from interface javax.media.opengl.GLAutoDrawable
SCREEN_CHANGE_ACTION_ENABLED
 
Constructor Summary
GLPbufferImpl(GLDrawableImpl pbufferDrawable, GLContext parentContext)
           
 
Method Summary
 void addGLEventListener(GLEventListener listener)
          Adds a GLEventListener to the end of this drawable queue.
 void addGLEventListener(int index, GLEventListener listener)
          Adds a GLEventListener at the given index of this drawable queue.
 void bindTexture()
          Binds this pbuffer to its internal texture target.
 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 the native resources associated with this pbuffer.
 void display()
           Causes OpenGL rendering to be performed for this GLAutoDrawable in the following order: Calling display(..) for all registered GLEventListeners.
 GLAnimatorControl getAnimator()
           
 boolean getAutoSwapBufferMode()
          Indicates whether automatic buffer swapping is enabled for this drawable.
 GLCapabilitiesImmutable getChosenGLCapabilities()
          Fetches the GLCapabilitiesImmutable corresponding to the chosen OpenGL capabilities (pixel format / visual / GLProfile) for this drawable.
On some platforms, the pixel format is not directly associated with the drawable; a best attempt is made to return a reasonable value in this case.
 GLContext getContext()
          Returns the context associated with this drawable.
 GLDrawable getDrawable()
           
 GLDrawableFactory getFactory()
           
 int getFloatingPointMode()
          Indicates which vendor's extension is being used to support floating point channels in this pbuffer if that capability was requested in the NWCapabilities during pbuffer creation.
 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.
 Throwable getLockedStack()
           
 NativeSurface getNativeSurface()
           
 GLCapabilitiesImmutable getRequestedGLCapabilities()
           
 int getWidth()
          Returns the current width of this GLDrawable.
 void invoke(boolean wait, GLRunnable glRunnable)
           Enqueues a one-shot GLRunnable, which will be executed with the next GLAutoDrawable.display() call.
 boolean isRealized()
           
 boolean isSurfaceLocked()
           
 int lockSurface()
           
 void releaseTexture()
          Unbinds the pbuffer from its internal texture target.
 void removeGLEventListener(GLEventListener listener)
          Removes a GLEventListener from this drawable.
 void repaint()
           
 void setAnimator(GLAnimatorControl animatorControl)
           Registers the usage of an animator, an GLAnimatorControl implementation.
 void setAutoSwapBufferMode(boolean onOrOff)
          Enables or disables automatic buffer swapping for this drawable.
 void setContext(GLContext ctx)
          Associate a new context to this drawable.
 GL setGL(GL gl)
          Sets the GL pipeline object this GLAutoDrawable uses.
 void setRealized(boolean realized)
          Indicates to on-screen GLDrawable implementations whether the underlying window has been created and can be drawn into.
 void setSize(int width, int height)
           
 void swapBuffers()
          Swaps the front and back buffers of this drawable.
 void unlockSurface()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.media.opengl.GLDrawable
toString
 

Constructor Detail

GLPbufferImpl

public GLPbufferImpl(GLDrawableImpl pbufferDrawable,
                     GLContext parentContext)
Method Detail

createContext

public GLContext createContext(GLContext shareWith)
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

setRealized

public void setRealized(boolean realized)
Description copied from interface: GLDrawable
Indicates to on-screen GLDrawable implementations whether the underlying window has been created and can be drawn into. End users do not need to call this method; it is not necessary to call setRealized on a GLCanvas, a GLJPanel, or a GLPbuffer, as these perform the appropriate calls on their underlying GLDrawables internally.

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

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

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


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

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

Specified by:
setRealized in interface GLDrawable

isRealized

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

setSize

public void setSize(int width,
                    int height)

getNativeSurface

public NativeSurface getNativeSurface()
Specified by:
getNativeSurface 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

getFactory

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

getWidth

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

Specified by:
getWidth 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

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)

repaint

public void repaint()

addGLEventListener

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

Specified by:
addGLEventListener in interface GLAutoDrawable

addGLEventListener

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

Specified by:
addGLEventListener in interface GLAutoDrawable
Parameters:
index - Position where the listener will be inserted. Should be within (0 <= index && index <= size()). An index value of -1 is interpreted as the end of the list, size().
listener - The GLEventListener object to be inserted

removeGLEventListener

public void removeGLEventListener(GLEventListener listener)
Description copied from interface: GLAutoDrawable
Removes a GLEventListener from this drawable. Note that if this is done from within a particular drawable's GLEventListener handler (reshape, display, etc.) that it is not guaranteed that all other listeners will be evaluated properly during this update cycle.

Specified by:
removeGLEventListener in interface GLAutoDrawable

setAnimator

public void setAnimator(GLAnimatorControl animatorControl)
Description copied from interface: GLAutoDrawable

Registers the usage of an animator, an GLAnimatorControl implementation. The animator will be queried whether it's animating, ie periodically issuing GLAutoDrawable.display() calls or not.


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


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


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

getAnimator

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

invoke

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

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

If a GLAnimatorControl is registered, or if it's not animating, the default situation,
or if the current thread is the animator thread,
a GLAutoDrawable.display() call has to be issued after enqueue the GLRunnable.
No extra synchronization must be performed in case wait is true, since it is executed in the current thread.

If GLAnimatorControl is registered and is animating,
no call of GLAutoDrawable.display() must be issued, since the animator thread will performs it.
If wait is true, the implementation must wait until the GLRunnable is executed.


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

setContext

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

Specified by:
setContext 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

getDrawable

public GLDrawable getDrawable()

getGL

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

Specified by:
getGL in interface GLAutoDrawable

setGL

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

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

setAutoSwapBufferMode

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

Specified by:
setAutoSwapBufferMode in interface GLAutoDrawable

getAutoSwapBufferMode

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

Specified by:
getAutoSwapBufferMode in interface GLAutoDrawable

swapBuffers

public void swapBuffers()
Description copied from interface: GLDrawable
Swaps the front and back buffers of this drawable. For GLAutoDrawable implementations, when automatic buffer swapping is enabled (as is the default), this method is called automatically and should not be called by the end user.

Specified by:
swapBuffers in interface GLDrawable

bindTexture

public void bindTexture()
Description copied from interface: GLPbuffer
Binds this pbuffer to its internal texture target. Only valid to call if offscreen render-to-texture has been specified in the NWCapabilities for this GLPbuffer. If the render-to-texture-rectangle capability has also been specified, this will use e.g. wglBindTexImageARB as its implementation and cause the texture to be bound to e.g. the GL_TEXTURE_RECTANGLE_NV state; otherwise, during the display() phase the pixels will have been copied into an internal texture target and this will cause that to be bound to the GL_TEXTURE_2D state.

Specified by:
bindTexture in interface GLPbuffer

releaseTexture

public void releaseTexture()
Description copied from interface: GLPbuffer
Unbinds the pbuffer from its internal texture target.

Specified by:
releaseTexture in interface GLPbuffer

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

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

lockSurface

public int lockSurface()
                throws GLException
Throws:
GLException

unlockSurface

public void unlockSurface()

isSurfaceLocked

public boolean isSurfaceLocked()

getLockedStack

public Throwable getLockedStack()

destroy

public void destroy()
Description copied from interface: GLPbuffer
Destroys the native resources associated with this pbuffer. It is not valid to call display() or any other routines on this pbuffer after it has been destroyed. Before destroying the pbuffer, the application must destroy any additional OpenGL contexts which have been created for the pbuffer via GLDrawable.createContext(javax.media.opengl.GLContext).

Specified by:
destroy in interface GLAutoDrawable
Specified by:
destroy in interface GLPbuffer

getFloatingPointMode

public int getFloatingPointMode()
Description copied from interface: GLPbuffer
Indicates which vendor's extension is being used to support floating point channels in this pbuffer if that capability was requested in the NWCapabilities during pbuffer creation. Returns one of NV_FLOAT, ATI_FLOAT or APPLE_FLOAT, or throws GLException if floating-point channels were not requested for this pbuffer. This function may only be called once the init method for this pbuffer's GLEventListener has been called.

Specified by:
getFloatingPointMode in interface GLPbuffer


Copyright 2010 JogAmp Community.