|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.media.nativewindow.ProxySurface
public abstract class ProxySurface
| Field Summary | |
|---|---|
static boolean |
DEBUG
|
| Fields inherited from interface javax.media.nativewindow.NativeSurface |
|---|
LOCK_SUCCESS, LOCK_SURFACE_CHANGED, LOCK_SURFACE_NOT_READY, LOCK_SURFACE_UNLOCKED |
| Constructor Summary | |
|---|---|
ProxySurface(AbstractGraphicsConfiguration cfg)
|
|
| Method Summary | |
|---|---|
void |
addSurfaceUpdatedListener(int index,
SurfaceUpdatedListener l)
Inserts the given SurfaceUpdatedListener at the
specified position in the list. |
void |
addSurfaceUpdatedListener(SurfaceUpdatedListener l)
Appends the given SurfaceUpdatedListener to the end of the list. |
long |
getDisplayHandle()
Convenience: Get display handle from AbstractGraphicsConfiguration . |
AbstractGraphicsConfiguration |
getGraphicsConfiguration()
Returns the graphics configuration corresponding to this window. |
int |
getHeight()
Returns the height of the client area excluding insets (window decorations). |
int |
getScreenIndex()
Convenience: Get display handle from AbstractGraphicsConfiguration . |
abstract long |
getSurfaceHandle()
Returns the handle to the surface for this NativeSurface. |
Thread |
getSurfaceLockOwner()
Return the locking owner's Thread, or null if not locked. |
int |
getWidth()
Returns the width of the client area excluding insets (window decorations). |
boolean |
isSurfaceLocked()
Return if surface is locked |
boolean |
isSurfaceLockedByOtherThread()
Return if surface is locked by another thread, ie not the current one |
int |
lockSurface()
Lock the surface of this native window. |
void |
removeSurfaceUpdatedListener(SurfaceUpdatedListener l)
Remove the specified SurfaceUpdatedListener from the list. |
void |
surfaceSizeChanged(int width,
int height)
|
boolean |
surfaceSwap()
Provide a mechanism to utilize custom (pre-) swap surface code. |
void |
surfaceUpdated(Object updater,
NativeSurface ns,
long when)
Notification of a surface update event, eg. |
abstract String |
toString()
|
void |
unlockSurface()
Unlock the surface of this native window Shall not modify the surface handle, see NativeSurface.lockSurface() |
void |
validateSurfaceLocked()
|
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final boolean DEBUG
| Constructor Detail |
|---|
public ProxySurface(AbstractGraphicsConfiguration cfg)
| Method Detail |
|---|
public final long getDisplayHandle()
NativeSurface
getDisplayHandle in interface NativeSurfacepublic final AbstractGraphicsConfiguration getGraphicsConfiguration()
NativeSurface
In case the implementation utilizes a delegation pattern to wrap abstract toolkits,
this method shall return the native AbstractGraphicsConfiguration via AbstractGraphicsConfiguration.getNativeGraphicsConfiguration().
getGraphicsConfiguration in interface NativeSurfaceAbstractGraphicsConfiguration.getNativeGraphicsConfiguration(),
javax.media.nativewindow.GraphicsConfigurationFactory#chooseGraphicsConfiguration(Capabilities, CapabilitiesChooser, AbstractGraphicsScreen)public final int getScreenIndex()
NativeSurface
getScreenIndex in interface NativeSurfacepublic abstract long getSurfaceHandle()
NativeSurface
The surface handle should be set/update by NativeSurface.lockSurface(),
where NativeSurface.unlockSurface() is not allowed to modify it.
After NativeSurface.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.
getSurfaceHandle in interface NativeSurfacepublic final int getWidth()
NativeSurface
getWidth in interface NativeSurfacepublic final int getHeight()
NativeSurface
getHeight in interface NativeSurface
public void surfaceSizeChanged(int width,
int height)
public boolean surfaceSwap()
NativeSurface
surfaceSwap in interface NativeSurfacepublic void addSurfaceUpdatedListener(SurfaceUpdatedListener l)
NativeSurfaceSurfaceUpdatedListener to the end of the list.
addSurfaceUpdatedListener in interface NativeSurface
public void addSurfaceUpdatedListener(int index,
SurfaceUpdatedListener l)
throws IndexOutOfBoundsException
NativeSurfaceSurfaceUpdatedListener at the
specified position in the list.
addSurfaceUpdatedListener in interface NativeSurfaceindex - 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 - The listener object to be inserted
IndexOutOfBoundsException - If the index is not within (0 <= index && index <= size()), or -1public void removeSurfaceUpdatedListener(SurfaceUpdatedListener l)
NativeSurfaceSurfaceUpdatedListener from the list.
removeSurfaceUpdatedListener in interface NativeSurface
public void surfaceUpdated(Object updater,
NativeSurface ns,
long when)
SurfaceUpdatedListener
surfaceUpdated in interface SurfaceUpdatedListenerupdater - is the caller object who updated the surface,
e.g. a JOGL GLDrawable.ns - the updated NativeSurfacewhen - the time in ms, when the surface was updated
public int lockSurface()
throws NativeWindowException
NativeSurface
The surface handle shall be valid after a successfull call,
ie return a value other than NativeSurface.LOCK_SURFACE_UNLOCKED and NativeSurface.LOCK_SURFACE_NOT_READY,
which is
boolean ok = lockSurface() > LOCK_SURFACE_NOT_READY;
The caller may need to take care of the result NativeSurface.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 RecursiveLock
first before proceeding with a native surface lock.
The implementation shall also invoke AbstractGraphicsDevice.lock()
for the initial lock (recursive count zero).
lockSurface in interface NativeSurfaceNativeSurface.LOCK_SUCCESS, NativeSurface.LOCK_SURFACE_CHANGED or NativeSurface.LOCK_SURFACE_NOT_READY.
NativeWindowExceptionRecursiveLockpublic final void unlockSurface()
NativeSurfaceNativeSurface.lockSurface()
The implementation shall also invoke AbstractGraphicsDevice.unlock()
for the final unlock (recursive count zero).
unlockSurface in interface NativeSurfaceNativeSurface.lockSurface(),
RecursiveLockpublic final void validateSurfaceLocked()
public final boolean isSurfaceLocked()
NativeSurface
isSurfaceLocked in interface NativeSurfacepublic final boolean isSurfaceLockedByOtherThread()
NativeSurface
isSurfaceLockedByOtherThread in interface NativeSurfacepublic final Thread getSurfaceLockOwner()
NativeSurface
getSurfaceLockOwner in interface NativeSurfacepublic abstract String toString()
toString in class Object
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||