JOGL 2.3.2 · com.jogamp.nativewindow.ProxySurface

Field Summary

Modifier and Type	Field and Description
public static final boolean	DEBUG
public static final int	OPT_PROXY_OWNS_UPSTREAM_DEVICE Implementation specific bit-value stating this `ProxySurface` owns the upstream's `AbstractGraphicsDevice`.
public static final int	OPT_PROXY_OWNS_UPSTREAM_SURFACE Implementation specific bit-value stating this `ProxySurface` owns the upstream's surface handle
public static final int	OPT_UPSTREAM_SURFACELESS Implementation specific bitvalue stating the upstream's `NativeSurface`'s zero handle is valid.
public static final int	OPT_UPSTREAM_WINDOW_INVISIBLE Implementation specific bitvalue stating the upstream's `NativeSurface` is an invisible window, i.e. maybe incomplete.

Method Summary

Modifier and Type	Method and Description
public void	addUpstreamOptionBits(int v) Add the given bit-mask to this instance upstream-option-bits using bit-or w/ `v`.
public void	clearUpstreamOptionBits(int v) Clear the given bit-mask from this instance upstream-option-bits using bit-and w/ `~v`
public boolean	containsUpstreamOptionBits(int v) Returns `true` if the give bit-mask `v` is set in this instance upstream-option-bits, otherwise `false`.
public void	createNotify() `UpstreamSurfaceHook#create(ProxySurface)` is being issued and the proxy surface/window handles shall be set.
public void	destroyNotify() `UpstreamSurfaceHook#destroy(ProxySurface)` is being issued and all proxy surface/window handles shall be cleared.
public void	enableUpstreamSurfaceHookLifecycle(boolean enable) Enables or disables the `UpstreamSurfaceHook` lifecycle functions `UpstreamSurfaceHook#create(ProxySurface)` and `UpstreamSurfaceHook#destroy(ProxySurface)`.
public StringBuilder	getUpstreamOptionBits(StringBuilder sink)
public int	getUpstreamOptionBits()
public NativeSurface	getUpstreamSurface() Returns the optional upstream `NativeSurface` if used by implementation, otherwise `null`.
public UpstreamSurfaceHook	getUpstreamSurfaceHook() Returns the `UpstreamSurfaceHook` if `set`, otherwise `null`.
public void	setGraphicsConfiguration(AbstractGraphicsConfiguration cfg) Allow redefining the AbstractGraphicsConfiguration
public void	setUpstreamSurfaceHook(UpstreamSurfaceHook hook) Overrides the `UpstreamSurfaceHook`.
public StringBuilder	toString(StringBuilder sink)
public String	toString()

Inherited from com.jogamp.nativewindow.MutableSurface:: setSurfaceHandle

Field Detail

DEBUG	back to summary
public static final boolean DEBUG

OPT_PROXY_OWNS_UPSTREAM_DEVICE back to summary

OPT_PROXY_OWNS_UPSTREAM_DEVICE	back to summary
public static final int OPT_PROXY_OWNS_UPSTREAM_DEVICE Implementation specific bit-value stating this `ProxySurface` owns the upstream's `AbstractGraphicsDevice`. See Also `addUpstreamOptionBits(int)`, `clearUpstreamOptionBits(int)`, `getUpstreamOptionBits()`

public static final int OPT_PROXY_OWNS_UPSTREAM_DEVICE

Implementation specific bit-value stating this ProxySurface owns the upstream's AbstractGraphicsDevice.

See Also: addUpstreamOptionBits(int), clearUpstreamOptionBits(int), getUpstreamOptionBits()

OPT_PROXY_OWNS_UPSTREAM_SURFACE back to summary

OPT_PROXY_OWNS_UPSTREAM_SURFACE	back to summary
public static final int OPT_PROXY_OWNS_UPSTREAM_SURFACE Implementation specific bit-value stating this `ProxySurface` owns the upstream's surface handle See Also `addUpstreamOptionBits(int)`, `clearUpstreamOptionBits(int)`, `getUpstreamOptionBits()`

public static final int OPT_PROXY_OWNS_UPSTREAM_SURFACE

Implementation specific bit-value stating this ProxySurface owns the upstream's surface handle

See Also: addUpstreamOptionBits(int), clearUpstreamOptionBits(int), getUpstreamOptionBits()

OPT_UPSTREAM_SURFACELESS back to summary

OPT_UPSTREAM_SURFACELESS	back to summary
public static final int OPT_UPSTREAM_SURFACELESS Implementation specific bitvalue stating the upstream's `NativeSurface`'s zero handle is valid. See Also `addUpstreamOptionBits(int)`, `clearUpstreamOptionBits(int)`, `getUpstreamOptionBits()`

public static final int OPT_UPSTREAM_SURFACELESS

Implementation specific bitvalue stating the upstream's NativeSurface's zero handle is valid.

See Also: addUpstreamOptionBits(int), clearUpstreamOptionBits(int), getUpstreamOptionBits()

OPT_UPSTREAM_WINDOW_INVISIBLE back to summary

OPT_UPSTREAM_WINDOW_INVISIBLE	back to summary
public static final int OPT_UPSTREAM_WINDOW_INVISIBLE Implementation specific bitvalue stating the upstream's `NativeSurface` is an invisible window, i.e. maybe incomplete. See Also `addUpstreamOptionBits(int)`, `clearUpstreamOptionBits(int)`, `getUpstreamOptionBits()`

public static final int OPT_UPSTREAM_WINDOW_INVISIBLE

Implementation specific bitvalue stating the upstream's NativeSurface is an invisible window, i.e. maybe incomplete.

See Also: addUpstreamOptionBits(int), clearUpstreamOptionBits(int), getUpstreamOptionBits()

Method Detail

addUpstreamOptionBits	back to summary
public void addUpstreamOptionBits(int v) Add the given bit-mask to this instance upstream-option-bits using bit-or w/ `v`.

clearUpstreamOptionBits	back to summary
public void clearUpstreamOptionBits(int v) Clear the given bit-mask from this instance upstream-option-bits using bit-and w/ `~v`

containsUpstreamOptionBits	back to summary
public boolean containsUpstreamOptionBits(int v) Returns `true` if the give bit-mask `v` is set in this instance upstream-option-bits, otherwise `false`.

createNotify	back to summary
public void createNotify() `UpstreamSurfaceHook#create(ProxySurface)` is being issued and the proxy surface/window handles shall be set.

destroyNotify	back to summary
public void destroyNotify() `UpstreamSurfaceHook#destroy(ProxySurface)` is being issued and all proxy surface/window handles shall be cleared.

enableUpstreamSurfaceHookLifecycle back to summary

enableUpstreamSurfaceHookLifecycle	back to summary
public void enableUpstreamSurfaceHookLifecycle(boolean enable) Enables or disables the `UpstreamSurfaceHook` lifecycle functions `UpstreamSurfaceHook#create(ProxySurface)` and `UpstreamSurfaceHook#destroy(ProxySurface)`. Use this for small code blocks where the native resources shall not change, i.e. resizing a derived (OpenGL) drawable.

public void enableUpstreamSurfaceHookLifecycle(boolean enable)

Enables or disables the UpstreamSurfaceHook lifecycle functions UpstreamSurfaceHook#create(ProxySurface) and UpstreamSurfaceHook#destroy(ProxySurface).

Use this for small code blocks where the native resources shall not change, i.e. resizing a derived (OpenGL) drawable.

getUpstreamOptionBits	back to summary
public StringBuilder getUpstreamOptionBits(StringBuilder sink)

getUpstreamOptionBits	back to summary
public int getUpstreamOptionBits()

getUpstreamSurface back to summary

getUpstreamSurface	back to summary
public NativeSurface getUpstreamSurface() Returns the optional upstream `NativeSurface` if used by implementation, otherwise `null`. The upstream `NativeSurface` is retrieved via `the UpstreamSurfaceHook`, i.e. `UpstreamSurfaceHook#getUpstreamSurface()`. One example is the JOGL EGLWrappedSurface, which might be backed up by a native platform NativeSurface (X11, WGL, CGL, ..).

public NativeSurface getUpstreamSurface()

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

The upstream NativeSurface is retrieved via the UpstreamSurfaceHook, i.e. UpstreamSurfaceHook#getUpstreamSurface().

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

getUpstreamSurfaceHook	back to summary
public UpstreamSurfaceHook getUpstreamSurfaceHook() Returns the `UpstreamSurfaceHook` if `set`, otherwise `null`.

setGraphicsConfiguration	back to summary
public void setGraphicsConfiguration(AbstractGraphicsConfiguration cfg) Allow redefining the AbstractGraphicsConfiguration

setUpstreamSurfaceHook	back to summary
public void setUpstreamSurfaceHook(UpstreamSurfaceHook hook) Overrides the `UpstreamSurfaceHook`.

toString	back to summary
public StringBuilder toString(StringBuilder sink)

toString	back to summary
public String toString() Annotations @Override

public Interface ProxySurface

Field Summary

Method Summary

Field Detail

Method Detail