JOGL 2.3.2 · jogamp.nativewindow.ProxySurfaceImpl

Modifier and Type	Field and Description
private AbstractGraphicsConfiguration	config
private int	implBitfield
private long	surfaceHandle_old
private final RecursiveLock	surfaceLock
private final SurfaceUpdatedHelper	surfaceUpdatedHelper
private UpstreamSurfaceHook	upstream
private boolean	upstreamSurfaceHookLifecycleEnabled

Access	Constructor and Description
protected	ProxySurfaceImpl(final AbstractGraphicsConfiguration the `AbstractGraphicsConfiguration` to be used cfg, final UpstreamSurfaceHook the `UpstreamSurfaceHook` to be used upstream, final boolean `true` if this `ProxySurface` instance owns the `AbstractGraphicsConfiguration`'s `AbstractGraphicsDevice`, otherwise `false`. Owning the device implies closing it at `destroyNotify()`. ownsDevice)

Method Summary

Modifier and Type	Method and Description
public void	addSurfaceUpdatedListener(final SurfaceUpdatedListener l) Implements com.jogamp.nativewindow.NativeSurface.addSurfaceUpdatedListener. Appends the given `SurfaceUpdatedListener` to the end of the list.
public void	addSurfaceUpdatedListener(final int Position where the listener will be inserted. Should be within (0 <= index && index <= size()). An index value of -1 is interpreted as the end of the list, size(). index, final SurfaceUpdatedListener The listener object to be inserted l) Implements com.jogamp.nativewindow.NativeSurface.addSurfaceUpdatedListener. Inserts the given `SurfaceUpdatedListener` at the specified position in the list.
public final void	addUpstreamOptionBits(final int v) Implements com.jogamp.nativewindow.ProxySurface.addUpstreamOptionBits. Add the given bit-mask to this instance upstream-option-bits using bit-or w/ `v`.
public final void	clearUpstreamOptionBits(final int v) Implements com.jogamp.nativewindow.ProxySurface.clearUpstreamOptionBits. Clear the given bit-mask from this instance upstream-option-bits using bit-and w/ `~v`
public final boolean	containsUpstreamOptionBits(final int v) Implements com.jogamp.nativewindow.ProxySurface.containsUpstreamOptionBits. Returns `true` if the give bit-mask `v` is set in this instance upstream-option-bits, otherwise `false`.
public void	createNotify() Implements com.jogamp.nativewindow.ProxySurface.createNotify. `UpstreamSurfaceHook#create(ProxySurface)` is being issued and the proxy surface/window handles shall be set.
public void	destroyNotify() Implements com.jogamp.nativewindow.ProxySurface.destroyNotify. `UpstreamSurfaceHook#destroy(ProxySurface)` is being issued and all proxy surface/window handles shall be cleared.
public static void	dumpHierarchy(final PrintStream out, final ProxySurface s)
private static void	dumpHierarchy(final PrintStream out, final NativeSurface s, String indentation)
public final void	enableUpstreamSurfaceHookLifecycle(final boolean enable) Implements com.jogamp.nativewindow.ProxySurface.enableUpstreamSurfaceHookLifecycle. Enables or disables the `UpstreamSurfaceHook` lifecycle functions `UpstreamSurfaceHook#create(ProxySurface)` and `UpstreamSurfaceHook#destroy(ProxySurface)`.
public final long	getDisplayHandle() Implements com.jogamp.nativewindow.NativeSurface.getDisplayHandle. Convenience: Get display handle from AbstractGraphicsConfiguration .
public final AbstractGraphicsConfiguration	getGraphicsConfiguration() Implements com.jogamp.nativewindow.NativeSurface.getGraphicsConfiguration. Returns the graphics configuration corresponding to this window.
public final int	getScreenIndex() Implements com.jogamp.nativewindow.NativeSurface.getScreenIndex. Convenience: Get display handle from AbstractGraphicsConfiguration .
public abstract long	getSurfaceHandle() Redeclares com.jogamp.nativewindow.NativeSurface.getSurfaceHandle. Returns the handle to the surface for this NativeSurface.
public final int	getSurfaceHeight() Implements com.jogamp.nativewindow.NativeSurface.getSurfaceHeight. Returns the height of the client area excluding insets (window decorations) in pixel units.
public final Thread	getSurfaceLockOwner() Implements com.jogamp.nativewindow.NativeSurface.getSurfaceLockOwner. Return the locking owner's Thread, or null if not locked.
public final int	getSurfaceWidth() Implements com.jogamp.nativewindow.NativeSurface.getSurfaceWidth. Returns the width of the client area excluding insets (window decorations) in pixel units.
public final StringBuilder	getUpstreamOptionBits(StringBuilder sink) Implements com.jogamp.nativewindow.ProxySurface.getUpstreamOptionBits.
public final int	getUpstreamOptionBits() Implements com.jogamp.nativewindow.ProxySurface.getUpstreamOptionBits.
public final NativeSurface	getUpstreamSurface() Implements com.jogamp.nativewindow.ProxySurface.getUpstreamSurface. Returns the optional upstream `NativeSurface` if used by implementation, otherwise `null`.
public final UpstreamSurfaceHook	getUpstreamSurfaceHook() Implements com.jogamp.nativewindow.ProxySurface.getUpstreamSurfaceHook. Returns the `UpstreamSurfaceHook` if `set`, otherwise `null`.
protected void	invalidateImpl() Must be overridden by implementations allowing having a `UpstreamSurfaceHook` being passed.
public final boolean	isSurfaceLockedByOtherThread() Implements com.jogamp.nativewindow.NativeSurface.isSurfaceLockedByOtherThread. Query if surface is locked by another thread, i.e. not the current one.
public int	lockSurface() Implements com.jogamp.nativewindow.NativeSurface.lockSurface. Lock the surface of this native window.
protected abstract int	lockSurfaceImpl()
public void	removeSurfaceUpdatedListener(final SurfaceUpdatedListener l) Implements com.jogamp.nativewindow.NativeSurface.removeSurfaceUpdatedListener. Remove the specified `SurfaceUpdatedListener` from the list.
public final void	setGraphicsConfiguration(final AbstractGraphicsConfiguration cfg) Implements com.jogamp.nativewindow.ProxySurface.setGraphicsConfiguration. Allow redefining the AbstractGraphicsConfiguration
public abstract void	setSurfaceHandle(long surfaceHandle) Redeclares com.jogamp.nativewindow.MutableSurface.setSurfaceHandle. Sets the surface handle which is created outside of this implementation.
public void	setUpstreamSurfaceHook(final UpstreamSurfaceHook hook) Implements com.jogamp.nativewindow.ProxySurface.setUpstreamSurfaceHook. Overrides the `UpstreamSurfaceHook`.
public boolean	surfaceSwap() Implements com.jogamp.nativewindow.NativeSurface.surfaceSwap. Provide a mechanism to utilize custom (pre-) swap surface code.
public void	surfaceUpdated(final Object is the caller object who updated the surface, e.g. a JOGL GLDrawable. updater, final NativeSurface the updated NativeSurface ns, final long the time in ms, when the surface was updated when) Implements com.jogamp.nativewindow.SurfaceUpdatedListener.surfaceUpdated. Notification of a surface update event, eg.
public StringBuilder	toString(StringBuilder sink) Implements com.jogamp.nativewindow.ProxySurface.toString.
public String	toString() Overrides java.lang.Object.toString. Implements com.jogamp.nativewindow.ProxySurface.toString. Returns a string representation of the object.
public final void	unlockSurface() Implements com.jogamp.nativewindow.NativeSurface.unlockSurface. Unlock the surface of this native window Shall not modify the surface handle, see `lockSurface()` The implementation shall also invoke `AbstractGraphicsDevice#unlock()` for the final unlock (recursive count zero).
protected abstract void	unlockSurfaceImpl()
public final void	validateSurfaceLocked()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

config	back to summary
private AbstractGraphicsConfiguration config

implBitfield	back to summary
private int implBitfield

surfaceHandle_old	back to summary
private long surfaceHandle_old

surfaceLock	back to summary
private final RecursiveLock surfaceLock

surfaceUpdatedHelper	back to summary
private final SurfaceUpdatedHelper surfaceUpdatedHelper

upstream	back to summary
private UpstreamSurfaceHook upstream

upstreamSurfaceHookLifecycleEnabled	back to summary
private boolean upstreamSurfaceHookLifecycleEnabled

ProxySurfaceImpl	back to summary
protected ProxySurfaceImpl(final AbstractGraphicsConfiguration cfg, final UpstreamSurfaceHook upstream, final boolean ownsDevice) Parameters cfg:AbstractGraphicsConfiguration the `AbstractGraphicsConfiguration` to be used upstream:UpstreamSurfaceHook the `UpstreamSurfaceHook` to be used ownsDevice:boolean `true` if this `ProxySurface` instance owns the `AbstractGraphicsConfiguration`'s `AbstractGraphicsDevice`, otherwise `false`. Owning the device implies closing it at `destroyNotify()`.

Method Detail

addSurfaceUpdatedListener back to summary

addSurfaceUpdatedListener	back to summary
public void addSurfaceUpdatedListener(final SurfaceUpdatedListener l) Implements com.jogamp.nativewindow.NativeSurface.addSurfaceUpdatedListener. Doc from com.jogamp.nativewindow.NativeSurface.addSurfaceUpdatedListener. Appends the given `SurfaceUpdatedListener` to the end of the list. Annotations @Override

public void addSurfaceUpdatedListener(final SurfaceUpdatedListener l)

Implements com.jogamp.nativewindow.NativeSurface.addSurfaceUpdatedListener.

Doc from com.jogamp.nativewindow.NativeSurface.addSurfaceUpdatedListener.

Appends the given SurfaceUpdatedListener to the end of the list.

Annotations

@Override

addSurfaceUpdatedListener back to summary

addSurfaceUpdatedListener	back to summary
public void addSurfaceUpdatedListener(final int index, final SurfaceUpdatedListener l) throws IndexOutOfBoundsException Implements com.jogamp.nativewindow.NativeSurface.addSurfaceUpdatedListener. Doc from com.jogamp.nativewindow.NativeSurface.addSurfaceUpdatedListener. Inserts the given `SurfaceUpdatedListener` at the specified position in the list. Parameters index:int Position where the listener will be inserted. Should be within (0 <= index && index <= size()). An index value of -1 is interpreted as the end of the list, size(). l:SurfaceUpdatedListener The listener object to be inserted Annotations @Override Exceptions IndexOutOfBoundsException: If the index is not within (0 <= index && index <= size()), or -1

public void addSurfaceUpdatedListener(final int index, final SurfaceUpdatedListener l) throws IndexOutOfBoundsException

Implements com.jogamp.nativewindow.NativeSurface.addSurfaceUpdatedListener.

Doc from com.jogamp.nativewindow.NativeSurface.addSurfaceUpdatedListener.

Inserts the given SurfaceUpdatedListener at the specified position in the list.

Parameters

index:int: Position where the listener will be inserted. Should be within (0 <= index && index <= size()). An index value of -1 is interpreted as the end of the list, size().
l:SurfaceUpdatedListener: The listener object to be inserted

Annotations

@Override

Exceptions

IndexOutOfBoundsException:: If the index is not within (0 <= index && index <= size()), or -1

addUpstreamOptionBits back to summary

addUpstreamOptionBits	back to summary
public final void addUpstreamOptionBits(final int v) Implements com.jogamp.nativewindow.ProxySurface.addUpstreamOptionBits. Doc from com.jogamp.nativewindow.ProxySurface.addUpstreamOptionBits. Add the given bit-mask to this instance upstream-option-bits using bit-or w/ `v`. Annotations @Override

public final void addUpstreamOptionBits(final int v)

Implements com.jogamp.nativewindow.ProxySurface.addUpstreamOptionBits.

Doc from com.jogamp.nativewindow.ProxySurface.addUpstreamOptionBits.

Add the given bit-mask to this instance upstream-option-bits using bit-or w/ v.

Annotations

@Override

clearUpstreamOptionBits back to summary

clearUpstreamOptionBits	back to summary
public final void clearUpstreamOptionBits(final int v) Implements com.jogamp.nativewindow.ProxySurface.clearUpstreamOptionBits. Doc from com.jogamp.nativewindow.ProxySurface.clearUpstreamOptionBits. Clear the given bit-mask from this instance upstream-option-bits using bit-and w/ `~v` Annotations @Override

public final void clearUpstreamOptionBits(final int v)

Implements com.jogamp.nativewindow.ProxySurface.clearUpstreamOptionBits.

Doc from com.jogamp.nativewindow.ProxySurface.clearUpstreamOptionBits.

Clear the given bit-mask from this instance upstream-option-bits using bit-and w/ ~v

Annotations

@Override

containsUpstreamOptionBits back to summary

containsUpstreamOptionBits	back to summary
public final boolean containsUpstreamOptionBits(final int v) Implements com.jogamp.nativewindow.ProxySurface.containsUpstreamOptionBits. Doc from com.jogamp.nativewindow.ProxySurface.containsUpstreamOptionBits. Returns `true` if the give bit-mask `v` is set in this instance upstream-option-bits, otherwise `false`. Annotations @Override

public final boolean containsUpstreamOptionBits(final int v)

Implements com.jogamp.nativewindow.ProxySurface.containsUpstreamOptionBits.

Doc from com.jogamp.nativewindow.ProxySurface.containsUpstreamOptionBits.

Returns true if the give bit-mask v is set in this instance upstream-option-bits, otherwise false.

Annotations

@Override

createNotify back to summary

createNotify	back to summary
public void createNotify() Implements com.jogamp.nativewindow.ProxySurface.createNotify. Doc from com.jogamp.nativewindow.ProxySurface.createNotify. `UpstreamSurfaceHook#create(ProxySurface)` is being issued and the proxy surface/window handles shall be set. Annotations @Override

public void createNotify()

Implements com.jogamp.nativewindow.ProxySurface.createNotify.

Doc from com.jogamp.nativewindow.ProxySurface.createNotify.

UpstreamSurfaceHook#create(ProxySurface) is being issued and the proxy surface/window handles shall be set.

Annotations

@Override

destroyNotify back to summary

destroyNotify	back to summary
public void destroyNotify() Implements com.jogamp.nativewindow.ProxySurface.destroyNotify. Doc from com.jogamp.nativewindow.ProxySurface.destroyNotify. `UpstreamSurfaceHook#destroy(ProxySurface)` is being issued and all proxy surface/window handles shall be cleared. Annotations @Override

public void destroyNotify()

Implements com.jogamp.nativewindow.ProxySurface.destroyNotify.

Doc from com.jogamp.nativewindow.ProxySurface.destroyNotify.

UpstreamSurfaceHook#destroy(ProxySurface) is being issued and all proxy surface/window handles shall be cleared.

Annotations

@Override

dumpHierarchy	back to summary
public static void dumpHierarchy(final PrintStream out, final ProxySurface s)

dumpHierarchy	back to summary
private static void dumpHierarchy(final PrintStream out, final NativeSurface s, String indentation)

enableUpstreamSurfaceHookLifecycle back to summary

enableUpstreamSurfaceHookLifecycle	back to summary
public final void enableUpstreamSurfaceHookLifecycle(final boolean enable) Implements com.jogamp.nativewindow.ProxySurface.enableUpstreamSurfaceHookLifecycle. Doc from com.jogamp.nativewindow.ProxySurface.enableUpstreamSurfaceHookLifecycle. 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. Annotations @Override

public final void enableUpstreamSurfaceHookLifecycle(final boolean enable)

Implements com.jogamp.nativewindow.ProxySurface.enableUpstreamSurfaceHookLifecycle.

Doc from com.jogamp.nativewindow.ProxySurface.enableUpstreamSurfaceHookLifecycle.

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.

Annotations

@Override

getDisplayHandle	back to summary
public final long getDisplayHandle() Implements com.jogamp.nativewindow.NativeSurface.getDisplayHandle. Doc from com.jogamp.nativewindow.NativeSurface.getDisplayHandle. Convenience: Get display handle from AbstractGraphicsConfiguration . AbstractGraphicsScreen . AbstractGraphicsDevice Annotations @Override

getDisplayHandle

back to summary

public final long getDisplayHandle()

Implements com.jogamp.nativewindow.NativeSurface.getDisplayHandle.

Doc from com.jogamp.nativewindow.NativeSurface.getDisplayHandle.

Convenience: Get display handle from AbstractGraphicsConfiguration . AbstractGraphicsScreen . AbstractGraphicsDevice

Annotations

@Override

getGraphicsConfiguration back to summary

getGraphicsConfiguration	back to summary
public final AbstractGraphicsConfiguration getGraphicsConfiguration() Implements com.jogamp.nativewindow.NativeSurface.getGraphicsConfiguration. Doc from com.jogamp.nativewindow.NativeSurface.getGraphicsConfiguration. Returns the graphics configuration corresponding to this window. In case the implementation utilizes a delegation pattern to wrap abstract toolkits, this method shall return the native `AbstractGraphicsConfiguration` via `AbstractGraphicsConfiguration#getNativeGraphicsConfiguration()`. Annotations @Override

public final AbstractGraphicsConfiguration getGraphicsConfiguration()

Implements com.jogamp.nativewindow.NativeSurface.getGraphicsConfiguration.

Doc from com.jogamp.nativewindow.NativeSurface.getGraphicsConfiguration.

Returns the graphics configuration corresponding to this window.

In case the implementation utilizes a delegation pattern to wrap abstract toolkits, this method shall return the native AbstractGraphicsConfiguration via AbstractGraphicsConfiguration#getNativeGraphicsConfiguration().

Annotations

@Override

getScreenIndex	back to summary
public final int getScreenIndex() Implements com.jogamp.nativewindow.NativeSurface.getScreenIndex. Doc from com.jogamp.nativewindow.NativeSurface.getScreenIndex. Convenience: Get display handle from AbstractGraphicsConfiguration . AbstractGraphicsScreen Annotations @Override

getScreenIndex

back to summary

public final int getScreenIndex()

Implements com.jogamp.nativewindow.NativeSurface.getScreenIndex.

Doc from com.jogamp.nativewindow.NativeSurface.getScreenIndex.

Convenience: Get display handle from AbstractGraphicsConfiguration . AbstractGraphicsScreen

Annotations

@Override

getSurfaceHandle back to summary

getSurfaceHandle	back to summary
public abstract long getSurfaceHandle() Redeclares com.jogamp.nativewindow.NativeSurface.getSurfaceHandle. Doc from com.jogamp.nativewindow.NativeSurface.getSurfaceHandle. Returns the handle to the surface for this NativeSurface. The surface handle should be set/update by `lockSurface()`, where `unlockSurface()` is not allowed to modify it. After `unlockSurface()` it is no more guaranteed that the surface handle is still valid. The surface handle shall reflect the platform one for all drawable surface operations, e.g. opengl, swap-buffer. On X11 this returns an entity of type Window, since there is no differentiation of surface and window there. On Microsoft Windows this returns an entity of type HDC. Annotations @Override

public abstract long getSurfaceHandle()

Redeclares com.jogamp.nativewindow.NativeSurface.getSurfaceHandle.

Doc from com.jogamp.nativewindow.NativeSurface.getSurfaceHandle.

Returns the handle to the surface for this NativeSurface.

The surface handle should be set/update by lockSurface(), where unlockSurface() is not allowed to modify it. After unlockSurface() it is no more guaranteed that the surface handle is still valid. The surface handle shall reflect the platform one for all drawable surface operations, e.g. opengl, swap-buffer.

On X11 this returns an entity of type Window, since there is no differentiation of surface and window there.
On Microsoft Windows this returns an entity of type HDC.

Annotations

@Override

getSurfaceHeight	back to summary
public final int getSurfaceHeight() Implements com.jogamp.nativewindow.NativeSurface.getSurfaceHeight. Doc from com.jogamp.nativewindow.NativeSurface.getSurfaceHeight. Returns the height of the client area excluding insets (window decorations) in pixel units. Returns:int height of the client area in pixel units Annotations @Override

getSurfaceHeight

back to summary

public final int getSurfaceHeight()

Implements com.jogamp.nativewindow.NativeSurface.getSurfaceHeight.

Doc from com.jogamp.nativewindow.NativeSurface.getSurfaceHeight.

Returns the height of the client area excluding insets (window decorations) in pixel units.

Returns:int

height of the client area in pixel units

Annotations

@Override

getSurfaceLockOwner	back to summary
public final Thread getSurfaceLockOwner() Implements com.jogamp.nativewindow.NativeSurface.getSurfaceLockOwner. Doc from com.jogamp.nativewindow.NativeSurface.getSurfaceLockOwner. Return the locking owner's Thread, or null if not locked. Annotations @Override

getSurfaceLockOwner

back to summary

public final Thread getSurfaceLockOwner()

Implements com.jogamp.nativewindow.NativeSurface.getSurfaceLockOwner.

Doc from com.jogamp.nativewindow.NativeSurface.getSurfaceLockOwner.

Return the locking owner's Thread, or null if not locked.

Annotations

@Override

getSurfaceWidth	back to summary
public final int getSurfaceWidth() Implements com.jogamp.nativewindow.NativeSurface.getSurfaceWidth. Doc from com.jogamp.nativewindow.NativeSurface.getSurfaceWidth. Returns the width of the client area excluding insets (window decorations) in pixel units. Returns:int width of the client area in pixel units Annotations @Override

getSurfaceWidth

back to summary

public final int getSurfaceWidth()

Implements com.jogamp.nativewindow.NativeSurface.getSurfaceWidth.

Doc from com.jogamp.nativewindow.NativeSurface.getSurfaceWidth.

Returns the width of the client area excluding insets (window decorations) in pixel units.

Returns:int

width of the client area in pixel units

Annotations

@Override

getUpstreamOptionBits	back to summary
public final StringBuilder getUpstreamOptionBits(StringBuilder sink) Implements com.jogamp.nativewindow.ProxySurface.getUpstreamOptionBits. Annotations @Override

getUpstreamOptionBits

back to summary

public final StringBuilder getUpstreamOptionBits(StringBuilder sink)

Implements com.jogamp.nativewindow.ProxySurface.getUpstreamOptionBits.

Annotations

@Override

getUpstreamOptionBits	back to summary
public final int getUpstreamOptionBits() Implements com.jogamp.nativewindow.ProxySurface.getUpstreamOptionBits. Annotations @Override

getUpstreamOptionBits

back to summary

public final int getUpstreamOptionBits()

Implements com.jogamp.nativewindow.ProxySurface.getUpstreamOptionBits.

Annotations

@Override

getUpstreamSurface back to summary

getUpstreamSurface	back to summary
public final NativeSurface getUpstreamSurface() Implements com.jogamp.nativewindow.ProxySurface.getUpstreamSurface. Doc from com.jogamp.nativewindow.ProxySurface.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, ..). Annotations @Override

public final NativeSurface getUpstreamSurface()

Implements com.jogamp.nativewindow.ProxySurface.getUpstreamSurface.

Doc from com.jogamp.nativewindow.ProxySurface.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, ..).

Annotations

@Override

getUpstreamSurfaceHook back to summary

getUpstreamSurfaceHook	back to summary
public final UpstreamSurfaceHook getUpstreamSurfaceHook() Implements com.jogamp.nativewindow.ProxySurface.getUpstreamSurfaceHook. Doc from com.jogamp.nativewindow.ProxySurface.getUpstreamSurfaceHook. Returns the `UpstreamSurfaceHook` if `set`, otherwise `null`. Annotations @Override

public final UpstreamSurfaceHook getUpstreamSurfaceHook()

Implements com.jogamp.nativewindow.ProxySurface.getUpstreamSurfaceHook.

Doc from com.jogamp.nativewindow.ProxySurface.getUpstreamSurfaceHook.

Returns the UpstreamSurfaceHook if set, otherwise null.

Annotations

@Override

invalidateImpl back to summary

invalidateImpl	back to summary
protected void invalidateImpl() Must be overridden by implementations allowing having a `UpstreamSurfaceHook` being passed. See Also `destroyNotify()`

protected void invalidateImpl()

Must be overridden by implementations allowing having a UpstreamSurfaceHook being passed.

See Also: destroyNotify()

isSurfaceLockedByOtherThread	back to summary
public final boolean isSurfaceLockedByOtherThread() Implements com.jogamp.nativewindow.NativeSurface.isSurfaceLockedByOtherThread. Doc from com.jogamp.nativewindow.NativeSurface.isSurfaceLockedByOtherThread. Query if surface is locked by another thread, i.e. not the current one. Convenient shortcut for: final Thread o = getSurfaceLockOwner(); if( null != o && Thread.currentThread() != o ) { .. } Annotations @Override

isSurfaceLockedByOtherThread

back to summary

public final boolean isSurfaceLockedByOtherThread()

Implements com.jogamp.nativewindow.NativeSurface.isSurfaceLockedByOtherThread.

Doc from com.jogamp.nativewindow.NativeSurface.isSurfaceLockedByOtherThread.

Query if surface is locked by another thread, i.e. not the current one.
Convenient shortcut for:

  final Thread o = getSurfaceLockOwner();
  if( null != o && Thread.currentThread() != o ) { .. }

Annotations

@Override

lockSurface back to summary

lockSurface	back to summary
public int lockSurface() throws NativeWindowException, RuntimeException Implements com.jogamp.nativewindow.NativeSurface.lockSurface. Doc from com.jogamp.nativewindow.NativeSurface.lockSurface. Lock the surface of this native window. The surface handle shall be valid after a successfull call, ie return a value other than `LOCK_SURFACE_UNLOCKED` and `LOCK_SURFACE_NOT_READY`, which is boolean ok = LOCK_SURFACE_NOT_READY < lockSurface(); The caller may need to take care of the result `LOCK_SURFACE_CHANGED`, where the surface handle is valid but has changed. This call is blocking until the surface has been locked or a timeout is reached. The latter will throw a runtime exception. This call allows recursion from the same thread. The implementation may want to aquire the application level `com.jogamp.common.util.locks.RecursiveLock` first before proceeding with a native surface lock. The implementation shall also invoke `AbstractGraphicsDevice#lock()` for the initial lock (recursive count zero). Returns:int `LOCK_SUCCESS`, `LOCK_SURFACE_CHANGED` or `LOCK_SURFACE_NOT_READY`. Annotations @Override Exceptions NativeWindowException: if native locking failed, maybe platform related RuntimeException: after timeout when waiting for the surface lock

public int lockSurface() throws NativeWindowException, RuntimeException

Implements com.jogamp.nativewindow.NativeSurface.lockSurface.

Doc from com.jogamp.nativewindow.NativeSurface.lockSurface.

Lock the surface of this native window.

The surface handle shall be valid after a successfull call, ie return a value other than LOCK_SURFACE_UNLOCKED and LOCK_SURFACE_NOT_READY, which is

   boolean ok = LOCK_SURFACE_NOT_READY < lockSurface();

The caller may need to take care of the result LOCK_SURFACE_CHANGED, where the surface handle is valid but has changed.

This call is blocking until the surface has been locked or a timeout is reached. The latter will throw a runtime exception.

This call allows recursion from the same thread.

The implementation may want to aquire the application level com.jogamp.common.util.locks.RecursiveLock first before proceeding with a native surface lock.

The implementation shall also invoke AbstractGraphicsDevice#lock() for the initial lock (recursive count zero).

Returns:int

LOCK_SUCCESS, LOCK_SURFACE_CHANGED or LOCK_SURFACE_NOT_READY.

Annotations

@Override

Exceptions

NativeWindowException:: if native locking failed, maybe platform related
RuntimeException:: after timeout when waiting for the surface lock

lockSurfaceImpl	back to summary
protected abstract int lockSurfaceImpl()

removeSurfaceUpdatedListener back to summary

removeSurfaceUpdatedListener	back to summary
public void removeSurfaceUpdatedListener(final SurfaceUpdatedListener l) Implements com.jogamp.nativewindow.NativeSurface.removeSurfaceUpdatedListener. Doc from com.jogamp.nativewindow.NativeSurface.removeSurfaceUpdatedListener. Remove the specified `SurfaceUpdatedListener` from the list. Annotations @Override

public void removeSurfaceUpdatedListener(final SurfaceUpdatedListener l)

Implements com.jogamp.nativewindow.NativeSurface.removeSurfaceUpdatedListener.

Doc from com.jogamp.nativewindow.NativeSurface.removeSurfaceUpdatedListener.

Remove the specified SurfaceUpdatedListener from the list.

Annotations

@Override

setGraphicsConfiguration	back to summary
public final void setGraphicsConfiguration(final AbstractGraphicsConfiguration cfg) Implements com.jogamp.nativewindow.ProxySurface.setGraphicsConfiguration. Doc from com.jogamp.nativewindow.ProxySurface.setGraphicsConfiguration. Allow redefining the AbstractGraphicsConfiguration Annotations @Override

setGraphicsConfiguration

back to summary

public final void setGraphicsConfiguration(final AbstractGraphicsConfiguration cfg)

Implements com.jogamp.nativewindow.ProxySurface.setGraphicsConfiguration.

Doc from com.jogamp.nativewindow.ProxySurface.setGraphicsConfiguration.

Allow redefining the AbstractGraphicsConfiguration

Annotations

@Override

setSurfaceHandle	back to summary
public abstract void setSurfaceHandle(long surfaceHandle) Redeclares com.jogamp.nativewindow.MutableSurface.setSurfaceHandle. Doc from com.jogamp.nativewindow.MutableSurface.setSurfaceHandle. Sets the surface handle which is created outside of this implementation. Annotations @Override

setSurfaceHandle

back to summary

public abstract void setSurfaceHandle(long surfaceHandle)

Redeclares com.jogamp.nativewindow.MutableSurface.setSurfaceHandle.

Doc from com.jogamp.nativewindow.MutableSurface.setSurfaceHandle.

Sets the surface handle which is created outside of this implementation.

Annotations

@Override

setUpstreamSurfaceHook back to summary

setUpstreamSurfaceHook	back to summary
public void setUpstreamSurfaceHook(final UpstreamSurfaceHook hook) Implements com.jogamp.nativewindow.ProxySurface.setUpstreamSurfaceHook. Doc from com.jogamp.nativewindow.ProxySurface.setUpstreamSurfaceHook. Overrides the `UpstreamSurfaceHook`. Annotations @Override

public void setUpstreamSurfaceHook(final UpstreamSurfaceHook hook)

Implements com.jogamp.nativewindow.ProxySurface.setUpstreamSurfaceHook.

Doc from com.jogamp.nativewindow.ProxySurface.setUpstreamSurfaceHook.

Overrides the UpstreamSurfaceHook.

Annotations

@Override

surfaceSwap	back to summary
public boolean surfaceSwap() Implements com.jogamp.nativewindow.NativeSurface.surfaceSwap. Doc from com.jogamp.nativewindow.NativeSurface.surfaceSwap. Provide a mechanism to utilize custom (pre-) swap surface code. This method is called before the render toolkit (e.g. JOGL) swaps the buffer/surface if double buffering is enabled. The implementation may itself apply the swapping, in which case true shall be returned. Returns:boolean true if this method completed swapping the surface, otherwise false, in which case eg the GLDrawable implementation has to swap the code. Annotations @Override

surfaceSwap

back to summary

public boolean surfaceSwap()

Implements com.jogamp.nativewindow.NativeSurface.surfaceSwap.

Doc from com.jogamp.nativewindow.NativeSurface.surfaceSwap.

Provide a mechanism to utilize custom (pre-) swap surface code. This method is called before the render toolkit (e.g. JOGL) swaps the buffer/surface if double buffering is enabled.

The implementation may itself apply the swapping, in which case true shall be returned.

Returns:boolean

true if this method completed swapping the surface, otherwise false, in which case eg the GLDrawable implementation has to swap the code.

Annotations

@Override

surfaceUpdated	back to summary
public void surfaceUpdated(final Object updater, final NativeSurface ns, final long when) Implements com.jogamp.nativewindow.SurfaceUpdatedListener.surfaceUpdated. Doc from com.jogamp.nativewindow.SurfaceUpdatedListener.surfaceUpdated. Notification of a surface update event, eg. after a swap buffer operation. Parameters updater:Object is the caller object who updated the surface, e.g. a JOGL GLDrawable. ns:NativeSurface the updated NativeSurface when:long the time in ms, when the surface was updated Annotations @Override

surfaceUpdated

back to summary

public void surfaceUpdated(final Object updater, final NativeSurface ns, final long when)

Implements com.jogamp.nativewindow.SurfaceUpdatedListener.surfaceUpdated.

Doc from com.jogamp.nativewindow.SurfaceUpdatedListener.surfaceUpdated.

Notification of a surface update event, eg. after a swap buffer operation.

Parameters

updater:Object: is the caller object who updated the surface, e.g. a JOGL GLDrawable.
ns:NativeSurface: the updated NativeSurface
when:long: the time in ms, when the surface was updated

Annotations

@Override

toString	back to summary
public StringBuilder toString(StringBuilder sink) Implements com.jogamp.nativewindow.ProxySurface.toString. Annotations @Override

toString

back to summary

public StringBuilder toString(StringBuilder sink)

Implements com.jogamp.nativewindow.ProxySurface.toString.

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Implements com.jogamp.nativewindow.ProxySurface.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Implements com.jogamp.nativewindow.ProxySurface.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

unlockSurface back to summary

unlockSurface	back to summary
public final void unlockSurface() Implements com.jogamp.nativewindow.NativeSurface.unlockSurface. Doc from com.jogamp.nativewindow.NativeSurface.unlockSurface. Unlock the surface of this native window Shall not modify the surface handle, see `lockSurface()` The implementation shall also invoke `AbstractGraphicsDevice#unlock()` for the final unlock (recursive count zero). The implementation shall be fail safe, i.e. tolerant in case the native resources are already released / unlocked. In this case the implementation shall simply ignore the call. Annotations @Override

public final void unlockSurface()

Implements com.jogamp.nativewindow.NativeSurface.unlockSurface.

Doc from com.jogamp.nativewindow.NativeSurface.unlockSurface.

Unlock the surface of this native window Shall not modify the surface handle, see lockSurface()

The implementation shall also invoke AbstractGraphicsDevice#unlock() for the final unlock (recursive count zero).

The implementation shall be fail safe, i.e. tolerant in case the native resources are already released / unlocked. In this case the implementation shall simply ignore the call.

Annotations

@Override

unlockSurfaceImpl	back to summary
protected abstract void unlockSurfaceImpl()

validateSurfaceLocked	back to summary
public final void validateSurfaceLocked()

public abstract Class ProxySurfaceImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail