Modifier and Type	Class and Description
public static interface	Display.PointerIcon Native PointerIcon handle.

Modifier and Type	Field and Description
public static final boolean	DEBUG
protected static final boolean	DEBUG_POINTER_ICON
protected static final ArrayList<WeakReference<Display>>	displayList
protected static int	displaysActive

Access	Constructor and Description
public	Display()

Method Summary

Modifier and Type	Method and Description
protected static void	addDisplay2List(final Display display)
public abstract int	Returns: number of references post operation addReference() The 1st call will initiate native creation, since we follow the lazy creation pattern.
public abstract void	createNative() Manual trigger the native creation, if it is not done yet.
public abstract Display.PointerIcon	createPointerIcon(final IOUtil.ClassResources single PNG resource for the `PointerIcon`. Only the first entry of `IOUtil.ClassResources#resourcePaths` is used. pngResource, final int pointer hotspot x-coord, origin is upper-left corner hotX, final int pointer hotspot y-coord, origin is upper-left corner hotY) Returns the newly created `PointerIcon` or `null` if not implemented on platform.
public abstract Display.PointerIcon	createPointerIcon(final PixelRectangle `PixelRectangle` source for the `PointerIcon` pixelrect, final int pointer hotspot x-coord, origin is upper-left corner hotX, final int pointer hotspot y-coord, origin is upper-left corner hotY) Returns the newly created `PointerIcon` or `null` if not implemented on platform.
public abstract void	destroy() Manually trigger the destruction, incl.
public abstract void	dispatchMessages()
public static void	dumpDisplayList(final String prefix)
public boolean	equals(final Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. return true if obj is of type Display and both FQN `getFQName()` equals
public static int	getActiveDisplayNumber()
public static Collection<Display>	getAllDisplays() Returns the global display collection
private static Display	getDisplayOfImpl(final String type, final String name, final int fromIndex, final int incr, final boolean shared)
public abstract EDTUtil	getEDTUtil()
public static Display	getFirstDisplayOf(final String type, final String name, final int start index, then increasing until found or end of list fromIndex, final boolean if true, only shared instances are found, otherwise also exclusive shared)
public abstract String	Returns: The fully qualified Display name, which is a key of `getType()` + `getName()` + `getId()`. getFQName()
public abstract AbstractGraphicsDevice	getGraphicsDevice() Return the `AbstractGraphicsDevice` used for depending resources lifecycle, i.e. `Screen` and `Window`, as well as the event dispatching (EDT).
public abstract long	getHandle() Return the handle of the `AbstractGraphicsDevice` as returned by `getGraphicsDevice()`.
public abstract int	Returns: this display internal serial id getId()
public static Display	getLastDisplayOf(final String type, final String name, final int start index, then decreasing until found or end of list. -1 is interpreted as size - 1. fromIndex, final boolean if true, only shared instances are found, otherwise also exclusive shared)
public abstract String	Returns: This display connection name as defined at creation time. The display connection name is a technical platform specific detail, see `AbstractGraphicsDevice#getConnection()`. getName()
public abstract boolean	getNativePointerIconForceDirectNIO() Returns the native platform's direct NIO buffer requirement pointer-icon pixel data.
public abstract PixelFormat	getNativePointerIconPixelFormat() Returns the native platform's `PixelFormat` for pointer-icon pixel data.
public abstract int	Returns: number of references getReferenceCount()
public static String	getThreadName()
public abstract String	Returns: the native display type, ie `com.jogamp.nativewindow.NativeWindowFactory#getNativeWindowType(boolean)` getType()
public abstract int	hashCode() Overrides java.lang.Object.hashCode. return precomputed hashCode from FQN `getFQName()`
public static int	hashCodeNullSafe(final Object o)
public abstract boolean	Returns: true if EDT is running and not subject to be stopped, otherwise false. isEDTRunning()
public abstract boolean	isExclusive() Return true if this instance is exclusive, i.e. will not be shared.
public abstract boolean	Returns: true if the native display handle is valid and ready to operate, otherwise false. isNativeValid()
public abstract int	Returns: number of references post operation removeReference() The last call may destroy this instance, if `getDestroyWhenUnused()` returns `true`.
public abstract EDTUtil	setEDTUtil(EDTUtil usrEDTUtil) Sets a new `EDTUtil` and returns the previous one.
public static String	toHexString(final int hex)
public static String	toHexString(final long hex)
public abstract boolean	Returns: true if EDT has been stopped (destroyed but running), otherwise false. validateEDTStopped() Validate EDT running state.

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

Field Detail

DEBUG	back to summary
public static final boolean DEBUG

DEBUG_POINTER_ICON	back to summary
protected static final boolean DEBUG_POINTER_ICON

displayList	back to summary
protected static final ArrayList<WeakReference<Display>> displayList

displaysActive	back to summary
protected static int displaysActive

Constructor Detail

Display	back to summary
public Display()

Method Detail

addDisplay2List	back to summary
protected static void addDisplay2List(final Display display)

addReference back to summary

addReference	back to summary
public abstract int addReference() throws NativeWindowException The 1st call will initiate native creation, since we follow the lazy creation pattern. Returns:int number of references post operation Exceptions NativeWindowException: if the native creation failed. See Also `removeReference()`

public abstract int addReference() throws NativeWindowException

The 1st call will initiate native creation, since we follow the lazy creation pattern.

Returns:int

number of references post operation

Exceptions

NativeWindowException:: if the native creation failed.

See Also

removeReference()

createNative back to summary

createNative	back to summary
public abstract void createNative() throws NativeWindowException Manual trigger the native creation, if it is not done yet. This is useful to be able to request the `com.jogamp.nativewindow.AbstractGraphicsDevice`, via `getGraphicsDevice()`. Otherwise the abstract device won't be available before the dependent components (Screen and Window) are realized. This method is usually invoke by `addReference()` Exceptions NativeWindowException: if the native creation failed.

public abstract void createNative() throws NativeWindowException

Manual trigger the native creation, if it is not done yet.
This is useful to be able to request the com.jogamp.nativewindow.AbstractGraphicsDevice, via getGraphicsDevice().
Otherwise the abstract device won't be available before the dependent components (Screen and Window) are realized.

This method is usually invoke by addReference()

Exceptions

NativeWindowException:: if the native creation failed.

createPointerIcon back to summary

createPointerIcon	back to summary
public abstract Display.PointerIcon createPointerIcon(final IOUtil.ClassResources pngResource, final int hotX, final int hotY) throws IllegalArgumentException, IllegalStateException, IOException Returns the newly created `PointerIcon` or `null` if not implemented on platform. See `PointerIcon` for lifecycle semantics. Parameters pngResource:IOUtil.ClassResources single PNG resource for the `PointerIcon`. Only the first entry of `IOUtil.ClassResources#resourcePaths` is used. hotX:int pointer hotspot x-coord, origin is upper-left corner hotY:int pointer hotspot y-coord, origin is upper-left corner Exceptions IllegalArgumentException: if pngResource is null or invalid IllegalStateException: if this Display instance is not `valid yet`. IOException: if the `pngResource` could not be `resolved` or via the PNG parser processing the input stream. See Also `PointerIcon`, `Window#setPointerIcon(PointerIcon)`

public abstract Display.PointerIcon createPointerIcon(final IOUtil.ClassResources pngResource, final int hotX, final int hotY) throws IllegalArgumentException, IllegalStateException, IOException

Returns the newly created PointerIcon or null if not implemented on platform.

See PointerIcon for lifecycle semantics.

Parameters

pngResource:IOUtil.ClassResources: single PNG resource for the PointerIcon. Only the first entry of IOUtil.ClassResources#resourcePaths is used.
hotX:int: pointer hotspot x-coord, origin is upper-left corner
hotY:int: pointer hotspot y-coord, origin is upper-left corner

Exceptions

IllegalArgumentException:: if pngResource is null or invalid
IllegalStateException:: if this Display instance is not valid yet.
IOException:: if the pngResource could not be resolved or via the PNG parser processing the input stream.

createPointerIcon back to summary

createPointerIcon	back to summary
public abstract Display.PointerIcon createPointerIcon(final PixelRectangle pixelrect, final int hotX, final int hotY) throws IllegalArgumentException, IllegalStateException Returns the newly created `PointerIcon` or `null` if not implemented on platform. See `PointerIcon` for lifecycle semantics. In case `getNativePointerIconPixelFormat()` or `getNativePointerIconForceDirectNIO()` is not matched by the given `pixelrect`, the `pixelrect` is converted into the required `PixelFormat` and NIO type. Parameters pixelrect:PixelRectangle `PixelRectangle` source for the `PointerIcon` hotX:int pointer hotspot x-coord, origin is upper-left corner hotY:int pointer hotspot y-coord, origin is upper-left corner Exceptions IllegalArgumentException: if pixelrect is null. IllegalStateException: if this Display instance is not `valid yet`. See Also `PointerIcon`, `Window#setPointerIcon(PointerIcon)`, `getNativePointerIconPixelFormat()`, `getNativePointerIconForceDirectNIO()`

public abstract Display.PointerIcon createPointerIcon(final PixelRectangle pixelrect, final int hotX, final int hotY) throws IllegalArgumentException, IllegalStateException

Returns the newly created PointerIcon or null if not implemented on platform.

See PointerIcon for lifecycle semantics.

In case getNativePointerIconPixelFormat() or getNativePointerIconForceDirectNIO() is not matched by the given pixelrect, the pixelrect is converted into the required PixelFormat and NIO type.

Parameters

pixelrect:PixelRectangle: PixelRectangle source for the PointerIcon
hotX:int: pointer hotspot x-coord, origin is upper-left corner
hotY:int: pointer hotspot y-coord, origin is upper-left corner

Exceptions

IllegalArgumentException:: if pixelrect is null.
IllegalStateException:: if this Display instance is not valid yet.

destroy back to summary

destroy	back to summary
public abstract void destroy() Manually trigger the destruction, incl. native destruction. This method is usually invoke by `removeReference()`

public abstract void destroy()

Manually trigger the destruction, incl. native destruction.

This method is usually invoke by removeReference()

dispatchMessages	back to summary
public abstract void dispatchMessages()

dumpDisplayList	back to summary
public static void dumpDisplayList(final String prefix)

equals back to summary

equals	back to summary
public boolean equals(final Object obj) Overrides java.lang.Object.equals. return true if obj is of type Display and both FQN `getFQName()` equals Parameters obj:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

return true if obj is of type Display and both FQN getFQName() equals

Parameters

obj:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getActiveDisplayNumber	back to summary
public static int getActiveDisplayNumber()

getAllDisplays	back to summary
public static Collection<Display> getAllDisplays() Returns the global display collection

getDisplayOfImpl	back to summary
private static Display getDisplayOfImpl(final String type, final String name, final int fromIndex, final int incr, final boolean shared)

getEDTUtil	back to summary
public abstract EDTUtil getEDTUtil()

getFirstDisplayOf	back to summary
public static Display getFirstDisplayOf(final String type, final String name, final int fromIndex, final boolean shared) Parameters fromIndex:int start index, then increasing until found or end of list shared:boolean if true, only shared instances are found, otherwise also exclusive

getFQName	back to summary
public abstract String getFQName() Returns:String The fully qualified Display name, which is a key of `getType()` + `getName()` + `getId()`.

getGraphicsDevice	back to summary
public abstract AbstractGraphicsDevice getGraphicsDevice() Return the `AbstractGraphicsDevice` used for depending resources lifecycle, i.e. `Screen` and `Window`, as well as the event dispatching (EDT).

getHandle	back to summary
public abstract long getHandle() Return the handle of the `AbstractGraphicsDevice` as returned by `getGraphicsDevice()`.

getId	back to summary
public abstract int getId() Returns:int this display internal serial id

getLastDisplayOf	back to summary
public static Display getLastDisplayOf(final String type, final String name, final int fromIndex, final boolean shared) Parameters fromIndex:int start index, then decreasing until found or end of list. -1 is interpreted as size - 1. shared:boolean if true, only shared instances are found, otherwise also exclusive

getName	back to summary
public abstract String getName() Returns:String This display connection name as defined at creation time. The display connection name is a technical platform specific detail, see `AbstractGraphicsDevice#getConnection()`. See Also `AbstractGraphicsDevice#getConnection()`

getNativePointerIconForceDirectNIO back to summary

getNativePointerIconForceDirectNIO	back to summary
public abstract boolean getNativePointerIconForceDirectNIO() Returns the native platform's direct NIO buffer requirement pointer-icon pixel data. Using this value will avoid conversion within `createPointerIcon(PixelRectangle, int, int)`.

public abstract boolean getNativePointerIconForceDirectNIO()

Returns the native platform's direct NIO buffer requirement pointer-icon pixel data.

Using this value will avoid conversion within createPointerIcon(PixelRectangle, int, int).

getNativePointerIconPixelFormat back to summary

getNativePointerIconPixelFormat	back to summary
public abstract PixelFormat getNativePointerIconPixelFormat() Returns the native platform's `PixelFormat` for pointer-icon pixel data. Using this value will avoid conversion within `createPointerIcon(PixelRectangle, int, int)`. Known native pixel formats are: X11: `PixelFormat#BGRA8888` Windows: `PixelFormat#BGRA8888` OSX: `PixelFormat#RGBA8888`

public abstract PixelFormat getNativePointerIconPixelFormat()

Returns the native platform's PixelFormat for pointer-icon pixel data.

Using this value will avoid conversion within createPointerIcon(PixelRectangle, int, int).

Known native pixel formats are:

getReferenceCount	back to summary
public abstract int getReferenceCount() Returns:int number of references

getThreadName	back to summary
public static String getThreadName()

getType	back to summary
public abstract String getType() Returns:String the native display type, ie `com.jogamp.nativewindow.NativeWindowFactory#getNativeWindowType(boolean)`

hashCode back to summary

hashCode	back to summary
public abstract int hashCode() Overrides java.lang.Object.hashCode. return precomputed hashCode from FQN `getFQName()` Returns:int Doc from java.lang.Object.hashCode. a hash code value for this object Annotations @Override

public abstract int hashCode()

Overrides java.lang.Object.hashCode.

return precomputed hashCode from FQN getFQName()

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object

Annotations

@Override

hashCodeNullSafe	back to summary
public static int hashCodeNullSafe(final Object o)

isEDTRunning	back to summary
public abstract boolean isEDTRunning() Returns:boolean true if EDT is running and not subject to be stopped, otherwise false.

isExclusive	back to summary
public abstract boolean isExclusive() Return true if this instance is exclusive, i.e. will not be shared.

isNativeValid	back to summary
public abstract boolean isNativeValid() Returns:boolean true if the native display handle is valid and ready to operate, otherwise false. See Also `destroy()`

removeReference back to summary

removeReference	back to summary
public abstract int removeReference() The last call may destroy this instance, if `getDestroyWhenUnused()` returns `true`. Returns:int number of references post operation See Also `addReference()`, `getDestroyWhenUnused()`, `setDestroyWhenUnused(boolean)`

public abstract int removeReference()

The last call may destroy this instance, if getDestroyWhenUnused() returns true.

Returns:int: number of references post operation
See Also: addReference(), getDestroyWhenUnused(), setDestroyWhenUnused(boolean)

setEDTUtil back to summary

setEDTUtil	back to summary
public abstract EDTUtil setEDTUtil(EDTUtil usrEDTUtil) Sets a new `EDTUtil` and returns the previous one. If `usrEDTUtil` is `null`, the device's default EDTUtil is created and used. If a previous one exists and it differs from `usrEDTUtil`, it's being stopped, wait-until-idle. If `usrEDTUtil` is not null and equals the previous one, no change is being made.

public abstract EDTUtil setEDTUtil(EDTUtil usrEDTUtil)

Sets a new EDTUtil and returns the previous one.

If usrEDTUtil is null, the device's default EDTUtil is created and used.

If a previous one exists and it differs from usrEDTUtil, it's being stopped, wait-until-idle.

If usrEDTUtil is not null and equals the previous one, no change is being made.

toHexString	back to summary
public static String toHexString(final int hex)

toHexString	back to summary
public static String toHexString(final long hex)

validateEDTStopped	back to summary
public abstract boolean validateEDTStopped() Validate EDT running state. Stop the running EDT in case this display is destroyed already. Returns:boolean true if EDT has been stopped (destroyed but running), otherwise false.

validateEDTStopped

back to summary

public abstract boolean validateEDTStopped()

Validate EDT running state.
Stop the running EDT in case this display is destroyed already.

Returns:boolean: true if EDT has been stopped (destroyed but running), otherwise false.

com.jogamp.newt back to summary

public Interface Display.PointerIcon

Known Direct Implementers: jogamp.newt.PointerIconImpl

Native PointerIcon handle.

Instances can be created via Display's createPointerIcon(pngResource, ..) or createPointerIcon(pixelrect, ..).

Instance is destroy()'ed automatically if it's associated Display is destroyed.

Instance can be re-validated after destruction via validate().

PointerIcon must not be destroyed while in use!

PointerIcon may be destroyed manually after use, i.e. when no Window uses them anymore. However, this is not required.

PointerIcons can be used via Window#setPointerIcon(PointerIcon).

Method Summary

Modifier and Type	Method and Description
public void	destroy() Destroys this instance.
public Display	Returns: the associated Display getDisplay()
public PointImmutable	getHotspot() Returns the hotspot.
public int	getStride() Redeclares com.jogamp.nativewindow.util.PixelRectangle.getStride. Always neatly packed, i.e. width * bytes_per_pixel.
public int	hashCode() Redeclares com.jogamp.nativewindow.util.PixelRectangle.hashCode. Computes a hash code over: display pixelformat size stride isGLOriented pixels hotspot
public boolean	isGLOriented() Redeclares com.jogamp.nativewindow.util.PixelRectangle.isGLOriented. Always false, i.e. origin is TOP-LEFT.
public boolean	isValid() Returns true if valid, otherwise false.
public boolean	validate() Returns true if instance `isValid()` or validation was successful, otherwise false.

Inherited from com.jogamp.nativewindow.util.PixelRectangle:: getPixelformat getPixels getSize toString

Method Detail

destroy back to summary

destroy	back to summary
public void destroy() Destroys this instance. Will be called automatically if it's `associated Display` is destroyed.

public void destroy()

Destroys this instance.

Will be called automatically if it's associated Display is destroyed.

getDisplay	back to summary
public Display getDisplay() Returns:Display the associated Display

getHotspot	back to summary
public PointImmutable getHotspot() Returns the hotspot.

getStride back to summary

getStride	back to summary
public int getStride() Redeclares com.jogamp.nativewindow.util.PixelRectangle.getStride. Doc from com.jogamp.nativewindow.util.PixelRectangle.getStride. Always neatly packed, i.e. width * bytes_per_pixel. Returns stride in byte-size, i.e. byte count from one line to the next. Must be >= `getPixelformat()`.`bytesPerPixel()` * `getSize()`.`getWidth()`. Annotations @Override

public int getStride()

Redeclares com.jogamp.nativewindow.util.PixelRectangle.getStride.

Doc from com.jogamp.nativewindow.util.PixelRectangle.getStride.

Always neatly packed, i.e. width * bytes_per_pixel.

Returns stride in byte-size, i.e. byte count from one line to the next.

Must be >= getPixelformat().bytesPerPixel() * getSize().getWidth().

Annotations

@Override

hashCode	back to summary
public int hashCode() Redeclares com.jogamp.nativewindow.util.PixelRectangle.hashCode. Doc from com.jogamp.nativewindow.util.PixelRectangle.hashCode. Computes a hash code over: display pixelformat size stride isGLOriented pixels hotspot Dismissing the native handle! The hashCode shall be computed only once with first call and stored for later retrieval to enhance performance. Computes a hash code over: pixelformat size stride isGLOriented pixels The hashCode shall be computed only once with first call and stored for later retrieval to enhance performance. Annotations @Override

hashCode

back to summary

public int hashCode()

Redeclares com.jogamp.nativewindow.util.PixelRectangle.hashCode.

Doc from com.jogamp.nativewindow.util.PixelRectangle.hashCode.

Computes a hash code over:

display
pixelformat
size
stride
isGLOriented
pixels
hotspot

Dismissing the native handle!

The hashCode shall be computed only once with first call and stored for later retrieval to enhance performance.

Computes a hash code over:

pixelformat
size
stride
isGLOriented
pixels

The hashCode shall be computed only once with first call and stored for later retrieval to enhance performance.

Annotations

@Override

isGLOriented back to summary

public boolean isGLOriented()

Redeclares com.jogamp.nativewindow.util.PixelRectangle.isGLOriented.

Doc from com.jogamp.nativewindow.util.PixelRectangle.isGLOriented.

Always false, i.e. origin is TOP-LEFT.

Returns true if the memory is laid out in OpenGL's coordinate system, origin at bottom left. Otherwise returns false, i.e. origin at top left.

isValid back to summary

public boolean isValid()

Returns true if valid, otherwise false.

A PointerIcon instance becomes invalid if it's associated Display is destroyed.

validate back to summary

public boolean validate()

Returns true if instance isValid() or validation was successful, otherwise false.

Validation, i.e. recreation, is required if instance became invalid, see isValid().

public abstract Class Display

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface Display.PointerIcon

Method Summary

Method Detail