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

Interface allowing upstream caller to pass lifecycle actions and size info to a ProxySurface instance. More...

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

Classes

interface  MutableSize
 UpstreamSurfaceHook w/ mutable size, allowing it's ProxySurface user to resize. More...
 

Public Member Functions

void create (ProxySurface s)
 called within ProxySurface#createNotify() within lock, before using surface. More...
 
void destroy (ProxySurface s)
 called within ProxySurface#destroyNotify() within lock, before clearing fields. More...
 
NativeSurface getUpstreamSurface ()
 Returns the optional upstream NativeSurface if used by implementation, otherwise null. More...
 
int getSurfaceWidth (ProxySurface s)
 Returns the width of the upstream surface in pixels, used if ProxySurface#UPSTREAM_PROVIDES_SIZE is set. More...
 
int getSurfaceHeight (ProxySurface s)
 Returns the height of the upstream surface in pixels, used if ProxySurface#UPSTREAM_PROVIDES_SIZE is set. More...
 

Detailed Description

Interface allowing upstream caller to pass lifecycle actions and size info to a ProxySurface instance.

Definition at line 35 of file UpstreamSurfaceHook.java.

Member Function Documentation

◆ create()

void com.jogamp.nativewindow.UpstreamSurfaceHook.create ( ProxySurface  s)

called within ProxySurface#createNotify() within lock, before using surface.

Implemented in com.jogamp.nativewindow.DelegatedUpstreamSurfaceHookMutableSize, com.jogamp.nativewindow.DelegatedUpstreamSurfaceHookWithSurfaceSize, com.jogamp.nativewindow.GenericUpstreamSurfacelessHook, and com.jogamp.nativewindow.UpstreamSurfaceHookMutableSize.

Here is the caller graph for this function:

◆ destroy()

void com.jogamp.nativewindow.UpstreamSurfaceHook.destroy ( ProxySurface  s)

called within ProxySurface#destroyNotify() within lock, before clearing fields.

Implemented in com.jogamp.nativewindow.DelegatedUpstreamSurfaceHookMutableSize, com.jogamp.nativewindow.DelegatedUpstreamSurfaceHookWithSurfaceSize, com.jogamp.nativewindow.GenericUpstreamSurfacelessHook, and com.jogamp.nativewindow.UpstreamSurfaceHookMutableSize.

Here is the caller graph for this function:

◆ getSurfaceHeight()

int com.jogamp.nativewindow.UpstreamSurfaceHook.getSurfaceHeight ( ProxySurface  s)

◆ getSurfaceWidth()

int com.jogamp.nativewindow.UpstreamSurfaceHook.getSurfaceWidth ( ProxySurface  s)

◆ getUpstreamSurface()

NativeSurface com.jogamp.nativewindow.UpstreamSurfaceHook.getUpstreamSurface ( )

Returns the optional upstream NativeSurface if used by implementation, otherwise null.

One example is the JOGL EGLWrappedSurface, which might be backed up by a native platform NativeSurface (X11, WGL, CGL, ..).

Implemented in com.jogamp.nativewindow.DelegatedUpstreamSurfaceHookWithSurfaceSize, and com.jogamp.nativewindow.UpstreamSurfaceHookMutableSize.


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