JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.nativewindow.OffscreenLayerOption Interface Reference

Handling requests for using an OffscreenLayerSurface within the implementation. More...

Inheritance diagram for com.jogamp.nativewindow.OffscreenLayerOption:
Collaboration diagram for com.jogamp.nativewindow.OffscreenLayerOption:

Public Member Functions

void setShallUseOffscreenLayer (boolean v)
 Request an offscreen layer, if supported. More...
 
boolean getShallUseOffscreenLayer ()
 Returns the property set by setShallUseOffscreenLayer(boolean). More...
 
boolean isOffscreenLayerSurfaceEnabled ()
 Returns true if this instance uses an offscreen layer, otherwise false. More...
 

Detailed Description

Handling requests for using an OffscreenLayerSurface within the implementation.

Definition at line 34 of file OffscreenLayerOption.java.

Member Function Documentation

◆ getShallUseOffscreenLayer()

boolean com.jogamp.nativewindow.OffscreenLayerOption.getShallUseOffscreenLayer ( )

◆ isOffscreenLayerSurfaceEnabled()

boolean com.jogamp.nativewindow.OffscreenLayerOption.isOffscreenLayerSurfaceEnabled ( )

Returns true if this instance uses an offscreen layer, otherwise false.

This instance is an offscreen layer, if setShallUseOffscreenLayer(true) has been called before it's realization and first lock and the underlying implementation supports it.

The return value is undefined before issuing the first NativeWindow#lockSurface().

See also
setShallUseOffscreenLayer(boolean)

Implemented in com.jogamp.opengl.awt.GLCanvas, com.jogamp.nativewindow.awt.JAWTWindow, and com.jogamp.newt.awt.NewtCanvasAWT.

◆ setShallUseOffscreenLayer()

void com.jogamp.nativewindow.OffscreenLayerOption.setShallUseOffscreenLayer ( boolean  v)

Request an offscreen layer, if supported.

Shall be called before the first NativeWindow#lockSurface(), and hence before realization.

See also
getShallUseOffscreenLayer()
isOffscreenLayerSurfaceEnabled()

Implemented in com.jogamp.opengl.awt.GLCanvas, com.jogamp.nativewindow.awt.JAWTWindow, and com.jogamp.newt.awt.NewtCanvasAWT.


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