JOGL v2.6.0-rc-20250706
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.opengl.GLOffscreenAutoDrawable Interface Reference

Platform-independent GLAutoDrawable specialization, exposing offscreen functionality. More...

Inheritance diagram for com.jogamp.opengl.GLOffscreenAutoDrawable:
Collaboration diagram for com.jogamp.opengl.GLOffscreenAutoDrawable:

Classes

interface  FBO
 FBObject based GLOffscreenAutoDrawable specialization More...
 

Public Member Functions

void setSurfaceSize (int newWidth, int newHeight) throws NativeWindowException, GLException
 Resize this GLAutoDrawable's surface. More...
 
void setUpstreamWidget (Object newUpstreamWidget)
 Set the upstream UI toolkit object. More...
 
- Public Member Functions inherited from com.jogamp.opengl.GLAutoDrawable
GLDrawable getDelegatedDrawable ()
 If the implementation uses delegation, return the delegated GLDrawable instance, otherwise return this instance. More...
 
GLContext getContext ()
 Returns the context associated with this drawable. More...
 
GLContext setContext (GLContext newCtx, boolean destroyPrevCtx)
 Associate the new context, newtCtx, to this auto-drawable. More...
 
void addGLEventListener (GLEventListener listener)
 Adds the given listener to the end of this drawable queue. More...
 
void addGLEventListener (int index, GLEventListener listener) throws IndexOutOfBoundsException
 Adds the given listener at the given index of this drawable queue. More...
 
int getGLEventListenerCount ()
 Returns the number of GLEventListener of this drawable queue. More...
 
boolean areAllGLEventListenerInitialized ()
 Returns true if all added GLEventListener are initialized, otherwise false. More...
 
GLEventListener getGLEventListener (int index) throws IndexOutOfBoundsException
 Returns the GLEventListener at the given index of this drawable queue. More...
 
boolean getGLEventListenerInitState (GLEventListener listener)
 Retrieves whether the given listener is initialized or not. More...
 
void setGLEventListenerInitState (GLEventListener listener, boolean initialized)
 Sets the given listener's initialized state. More...
 
GLEventListener disposeGLEventListener (GLEventListener listener, boolean remove)
 Disposes the given listener via dispose(..) if it has been initialized and added to this queue. More...
 
GLEventListener removeGLEventListener (GLEventListener listener)
 Removes the given listener from this drawable queue. More...
 
abstract void setAnimator (GLAnimatorControl animatorControl) throws GLException
 Registers the usage of an animator, an com.jogamp.opengl.GLAnimatorControl implementation. More...
 
GLAnimatorControl getAnimator ()
 
Thread setExclusiveContextThread (Thread t) throws GLException
 Dedicates this instance's GLContext to the given thread. More...
 
Thread getExclusiveContextThread ()
 
boolean invoke (boolean wait, GLRunnable glRunnable) throws IllegalStateException
 Enqueues a one-shot GLRunnable, which will be executed within the next display() call after all registered GLEventListeners display(GLAutoDrawable) methods have been called. More...
 
boolean invoke (boolean wait, List< GLRunnable > glRunnables) throws IllegalStateException
 Extends invoke(boolean, GLRunnable) functionality allowing to inject a list of GLRunnables. More...
 
void flushGLRunnables ()
 Flushes all enqueued GLRunnable of this GLAutoDrawable including notifying waiting executor. More...
 
void destroy ()
 Destroys all resources associated with this GLAutoDrawable, inclusive the GLContext. More...
 
void display ()
 
void setAutoSwapBufferMode (boolean enable)
 Enables or disables automatic buffer swapping for this drawable. More...
 
boolean getAutoSwapBufferMode ()
 Indicates whether automatic buffer swapping is enabled for this drawable. More...
 
void setContextCreationFlags (int flags)
 
int getContextCreationFlags ()
 
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.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. More...
 
GL getGL ()
 Returns the GL pipeline object this GLAutoDrawable uses. More...
 
GL setGL (GL gl)
 Sets the GL pipeline object this GLAutoDrawable uses. More...
 
Object getUpstreamWidget ()
 Method may return the upstream UI toolkit object holding this GLAutoDrawable instance, if exist. More...
 
RecursiveLock getUpstreamLock ()
 Returns the recursive lock object of the upstream widget to synchronize multithreaded access on top of NativeSurface#lockSurface(). More...
 
boolean isThreadGLCapable ()
 Indicates whether the current thread is capable of performing OpenGL-related work. More...
 
- Public Member Functions inherited from com.jogamp.opengl.GLDrawable
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. More...
 
void setRealized (boolean realized)
 Indicates to GLDrawable implementations whether the underlying surface has been created and can be drawn into. More...
 
boolean isRealized ()
 Returns true if this drawable is realized, otherwise false. More...
 
int getSurfaceWidth ()
 Returns the width of this GLDrawable's surface client area in pixel units. More...
 
int getSurfaceHeight ()
 Returns the height of this GLDrawable's surface client area in pixel units. More...
 
boolean isGLOriented ()
 Returns true if the drawable is rendered in OpenGL's coordinate system, origin at bottom left. More...
 
void swapBuffers () throws GLException
 Swaps the front and back buffers of this drawable. More...
 
GLCapabilitiesImmutable getChosenGLCapabilities ()
 Fetches the GLCapabilitiesImmutable corresponding to the chosen OpenGL capabilities (pixel format / visual / GLProfile) for this drawable. More...
 
GLCapabilitiesImmutable getRequestedGLCapabilities ()
 Fetches the GLCapabilitiesImmutable corresponding to the user requested OpenGL capabilities (pixel format / visual / GLProfile) for this drawable. More...
 
GLProfile getGLProfile ()
 Fetches the GLProfile for this drawable. More...
 
NativeSurface getNativeSurface ()
 Returns the associated NativeSurface of this NativeSurfaceHolder. More...
 
long getHandle ()
 Returns the GL drawable handle, guaranteed to be valid after realization and while it's surface is being locked. More...
 
GLDrawableFactory getFactory ()
 Return the GLDrawableFactory being used to create this instance. More...
 
String toString ()
 
NativeSurface getNativeSurface ()
 Returns the associated NativeSurface of this NativeSurfaceHolder. More...
 
- Public Member Functions inherited from com.jogamp.opengl.GLSharedContextSetter
void setSharedContext (GLContext sharedContext) throws IllegalStateException
 Specifies an OpenGL context, which shall be shared by this GLAutoDrawable's GLContext. More...
 
void setSharedAutoDrawable (GLAutoDrawable sharedAutoDrawable) throws IllegalStateException
 Specifies an GLAutoDrawable, which OpenGL context shall be shared by this GLAutoDrawable's GLContext. More...
 

Additional Inherited Members

- Static Public Attributes inherited from com.jogamp.opengl.GLAutoDrawable
static final boolean SCREEN_CHANGE_ACTION_ENABLED = Debug.getBooleanProperty("jogl.screenchange.action", true)
 Flag reflecting whether the GLDrawable reconfiguration will be issued in case a screen device change occurred, e.g. More...
 

Detailed Description

Platform-independent GLAutoDrawable specialization, exposing offscreen functionality.

This class distinguishes itself from GLAutoDrawable with it's setSurfaceSize(int, int) functionality.

OpenGL Context Sharing

To share a GLContext see the following note in the documentation overview: context sharing as well as GLSharedContextSetter.

Definition at line 47 of file GLOffscreenAutoDrawable.java.

Member Function Documentation

◆ setSurfaceSize()

void com.jogamp.opengl.GLOffscreenAutoDrawable.setSurfaceSize ( int  newWidth,
int  newHeight 
) throws NativeWindowException, GLException

Resize this GLAutoDrawable's surface.

Parameters
newWidthnew width in pixel units
newHeightnew height in pixel units
Exceptions
NativeWindowExceptionin case the surface could no be locked
GLExceptionin case of an error during the resize operation

◆ setUpstreamWidget()

void com.jogamp.opengl.GLOffscreenAutoDrawable.setUpstreamWidget ( Object  newUpstreamWidget)

Set the upstream UI toolkit object.

See also
getUpstreamWidget()

The documentation for this interface was generated from the following file: