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

Interface specifying the offscreen layer surface protocol. More...

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

Public Member Functions

void attachSurfaceLayer (final long layerHandle) throws NativeWindowException
 Attach the offscreen layer to this offscreen layer surface. More...
 
void detachSurfaceLayer () throws NativeWindowException
 Detaches a previously attached offscreen layer from this offscreen layer surface. More...
 
long getAttachedSurfaceLayer ()
 Returns the attached surface layer or null if none is attached. More...
 
boolean isSurfaceLayerAttached ()
 Returns true if a surface layer is attached, otherwise false. More...
 
void setChosenCapabilities (CapabilitiesImmutable caps)
 Sets the capabilities of this instance, allowing upstream API's to refine it, i.e. More...
 
RecursiveLock getLock ()
 Returns the recursive lock object of this surface, which synchronizes multithreaded access. More...
 
boolean setCursor (PixelRectangle pixelrect, PointImmutable hotSpot)
 Optional method setting cursor in the corresponding on-screen surface/window, if exists. More...
 
boolean hideCursor ()
 Optional method hiding the cursor in the corresponding on-screen surface/window, if exists. More...
 

Detailed Description

Interface specifying the offscreen layer surface protocol.

Definition at line 38 of file OffscreenLayerSurface.java.

Member Function Documentation

◆ attachSurfaceLayer()

void com.jogamp.nativewindow.OffscreenLayerSurface.attachSurfaceLayer ( final long  layerHandle) throws NativeWindowException

Attach the offscreen layer to this offscreen layer surface.

Implementation may realize all required resources at this point.

See also
#isOffscreenLayerSurfaceEnabled()
Exceptions
NativeWindowExceptionif isOffscreenLayerSurfaceEnabled() == false

Implemented in com.jogamp.nativewindow.awt.JAWTWindow.

◆ detachSurfaceLayer()

void com.jogamp.nativewindow.OffscreenLayerSurface.detachSurfaceLayer ( ) throws NativeWindowException

Detaches a previously attached offscreen layer from this offscreen layer surface.

See also
attachSurfaceLayer(long)
#isOffscreenLayerSurfaceEnabled()
Exceptions
NativeWindowExceptionif isOffscreenLayerSurfaceEnabled() == false or no surface layer is attached.

Implemented in com.jogamp.nativewindow.awt.JAWTWindow.

◆ getAttachedSurfaceLayer()

long com.jogamp.nativewindow.OffscreenLayerSurface.getAttachedSurfaceLayer ( )

Returns the attached surface layer or null if none is attached.

Implemented in com.jogamp.nativewindow.awt.JAWTWindow.

◆ getLock()

RecursiveLock com.jogamp.nativewindow.OffscreenLayerSurface.getLock ( )

Returns the recursive lock object of this surface, which synchronizes multithreaded access.

Implemented in com.jogamp.nativewindow.awt.JAWTWindow.

◆ hideCursor()

boolean com.jogamp.nativewindow.OffscreenLayerSurface.hideCursor ( )

Optional method hiding the cursor in the corresponding on-screen surface/window, if exists.

Returns
true if successful, i.e. on-screen surface/window w/ cursor capabilities exists. Otherwise false.

Implemented in com.jogamp.nativewindow.awt.JAWTWindow.

◆ isSurfaceLayerAttached()

boolean com.jogamp.nativewindow.OffscreenLayerSurface.isSurfaceLayerAttached ( )

Returns true if a surface layer is attached, otherwise false.

Implemented in com.jogamp.nativewindow.awt.JAWTWindow.

◆ setChosenCapabilities()

void com.jogamp.nativewindow.OffscreenLayerSurface.setChosenCapabilities ( CapabilitiesImmutable  caps)

Sets the capabilities of this instance, allowing upstream API's to refine it, i.e.

OpenGL related settings.

Implemented in com.jogamp.nativewindow.awt.JAWTWindow.

◆ setCursor()

boolean com.jogamp.nativewindow.OffscreenLayerSurface.setCursor ( PixelRectangle  pixelrect,
PointImmutable  hotSpot 
)

Optional method setting cursor in the corresponding on-screen surface/window, if exists.

Parameters
pixelrectcursor pixels, maybe null for default cursor
hotSpotmaybe null for default cursor
Returns
true if successful, i.e. on-screen surface/window w/ cursor capabilities exists. Otherwise false.

Implemented in com.jogamp.nativewindow.awt.JAWTWindow.


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