JOGL 2.3.2 · com.jogamp.nativewindow.DefaultGraphicsDevice

Modifier and Type	Field and Description
protected final String	connection
protected long	handle
private static final String	separator
protected ToolkitLock	toolkitLock
private final String	type
protected final String	uniqueID
protected final int	unitID

Access	Constructor and Description
public	DefaultGraphicsDevice(final String type, final String connection, final int unitID) Create an instance with the system default `ToolkitLock`, gathered via `NativeWindowFactory#getDefaultToolkitLock(String)`.
public	DefaultGraphicsDevice(final String type, final String connection, final int unitID, final long handle) Create an instance with the system default `ToolkitLock`.
public	DefaultGraphicsDevice(final String type, final String connection, final int unitID, final long handle, final ToolkitLock if null, a non blocking null lock is used. locker) Create an instance with the given `ToolkitLock` instance, or null `ToolkitLock` if null.

Method Summary

Modifier and Type	Method and Description
public void	clearHandleOwner() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.clearHandleOwner.
public Object	clone() Overrides java.lang.Object.clone. Implements com.jogamp.nativewindow.AbstractGraphicsDevice.clone. Creates and returns a copy of this object.
public boolean	close() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.close. Optionally closing the device if handle is not `null`.
public final String	getConnection() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.getConnection. Returns the semantic GraphicsDevice connection.
public static String	getDefaultDisplayConnection() Return the default display connection for the given windowing toolkit type gathered via `NativeWindowFactory#getDefaultDisplayConnection()`.
public static String	getDefaultDisplayConnection(final String type) Return the default display connection for the given windowing toolkit type gathered via `NativeWindowFactory#getDefaultDisplayConnection(String)`.
public final long	getHandle() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.getHandle. Returns the native handle of the underlying native device, if such thing exist.
protected Object	getHandleOwnership()
public final ToolkitLock	Returns: the used ToolkitLock getToolkitLock()
public final String	getType() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.getType. Returns the type of the underlying subsystem, ie NativeWindowFactory.TYPE_KD, NativeWindowFactory.TYPE_X11, ..
public final String	getUniqueID() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.getUniqueID. Returns a unique ID object of this device using `type`, `connection` and `unitID` as it's key components.
private static String	getUniqueID(final String type, final String connection, final int unitID) Returns a unique String object using `String#intern()` for the given arguments, which object reference itself can be used as a key.
public final int	getUnitID() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.getUnitID. Returns the graphics device `unit ID`.
public boolean	isHandleOwner() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.isHandleOwner.
public final void	lock() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.lock. Optionally locking the device, utilizing eg `com.jogamp.nativewindow.ToolkitLock#lock()`.
public boolean	open() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.open. Optionally [re]opening the device if handle is `null`.
protected final long	setHandle(final long newHandle) Set the native handle of the underlying native device and return the previous one.
protected Object	setHandleOwnership(final Object newOwnership)
protected ToolkitLock	Returns: the previous ToolkitLock instance setToolkitLock(final ToolkitLock the ToolkitLock, if null, `jogamp.nativewindow.NullToolkitLock` is being used locker) Set the internal ToolkitLock, which is used within the `lock()` and `unlock()` implementation.
public static final void	swapDeviceHandleAndOwnership(final DefaultGraphicsDevice aDevice1, final DefaultGraphicsDevice aDevice2)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public final void	unlock() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.unlock. Optionally unlocking the device, utilizing eg `com.jogamp.nativewindow.ToolkitLock#unlock()`.
public final void	validateLocked() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.validateLocked.

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

connection	back to summary
protected final String connection

handle	back to summary
protected long handle

separator	back to summary
private static final String separator

toolkitLock	back to summary
protected ToolkitLock toolkitLock

type	back to summary
private final String type

uniqueID	back to summary
protected final String uniqueID

unitID	back to summary
protected final int unitID

DefaultGraphicsDevice	back to summary
public DefaultGraphicsDevice(final String type, final String connection, final int unitID) Create an instance with the system default `ToolkitLock`, gathered via `NativeWindowFactory#getDefaultToolkitLock(String)`.

DefaultGraphicsDevice	back to summary
public DefaultGraphicsDevice(final String type, final String connection, final int unitID, final long handle) Create an instance with the system default `ToolkitLock`. gathered via `NativeWindowFactory#getDefaultToolkitLock(String, long)`.

DefaultGraphicsDevice	back to summary
public DefaultGraphicsDevice(final String type, final String connection, final int unitID, final long handle, final ToolkitLock locker) Create an instance with the given `ToolkitLock` instance, or null `ToolkitLock` if null. Parameters locker:ToolkitLock if null, a non blocking null lock is used.

Method Detail

clearHandleOwner	back to summary
public void clearHandleOwner() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.clearHandleOwner. Annotations @Override

clearHandleOwner

back to summary

public void clearHandleOwner()

Implements com.jogamp.nativewindow.AbstractGraphicsDevice.clearHandleOwner.

Annotations

@Override

clone back to summary

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Implements com.jogamp.nativewindow.AbstractGraphicsDevice.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:Object a clone of this instance. Annotations @Override

public Object clone()

Overrides java.lang.Object.clone.

Implements com.jogamp.nativewindow.AbstractGraphicsDevice.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Object

a clone of this instance.

Annotations

@Override

close back to summary

close	back to summary
public boolean close() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.close. Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.close. Optionally closing the device if handle is not `null`. The default implementation `dispose` it's `ToolkitLock` and sets the handle to `null`. Example implementations like `com.jogamp.nativewindow.x11.X11GraphicsDevice` or `com.jogamp.nativewindow.egl.EGLGraphicsDevice` issue the native close operation or skip it depending on the `handles's ownership`. Returns:boolean true if the handle was not `null` and closing was successful, otherwise false. Annotations @Override

public boolean close()

Implements com.jogamp.nativewindow.AbstractGraphicsDevice.close.

Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.close.

Optionally closing the device if handle is not null.

The default implementation dispose it's ToolkitLock and sets the handle to null.

Example implementations like com.jogamp.nativewindow.x11.X11GraphicsDevice or com.jogamp.nativewindow.egl.EGLGraphicsDevice issue the native close operation or skip it depending on the handles's ownership.

Returns:boolean

true if the handle was not null and closing was successful, otherwise false.

Annotations

@Override

getConnection back to summary

getConnection	back to summary
public final String getConnection() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.getConnection. Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.getConnection. Returns the semantic GraphicsDevice connection. On platforms supporting remote devices, eg via tcp/ip network, the implementation shall return a unique name for each remote address. On X11 for example, the connection string should be as the following example. `:0.0` for a local connection `remote.host.net:0.0` for a remote connection To support multiple local device, see `getUnitID()`. Annotations @Override

public final String getConnection()

Implements com.jogamp.nativewindow.AbstractGraphicsDevice.getConnection.

Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.getConnection.

Returns the semantic GraphicsDevice connection.
On platforms supporting remote devices, eg via tcp/ip network, the implementation shall return a unique name for each remote address.
On X11 for example, the connection string should be as the following example.

:0.0 for a local connection
remote.host.net:0.0 for a remote connection

To support multiple local device, see getUnitID().

Annotations

@Override

getDefaultDisplayConnection	back to summary
public static String getDefaultDisplayConnection() Return the default display connection for the given windowing toolkit type gathered via `NativeWindowFactory#getDefaultDisplayConnection()`.

getDefaultDisplayConnection	back to summary
public static String getDefaultDisplayConnection(final String type) Return the default display connection for the given windowing toolkit type gathered via `NativeWindowFactory#getDefaultDisplayConnection(String)`.

getHandle	back to summary
public final long getHandle() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.getHandle. Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.getHandle. Returns the native handle of the underlying native device, if such thing exist. Annotations @Override

getHandle

back to summary

public final long getHandle()

Implements com.jogamp.nativewindow.AbstractGraphicsDevice.getHandle.

Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.getHandle.

Returns the native handle of the underlying native device, if such thing exist.

Annotations

@Override

getHandleOwnership	back to summary
protected Object getHandleOwnership()

getToolkitLock	back to summary
public final ToolkitLock getToolkitLock() Returns:ToolkitLock the used ToolkitLock See Also `DefaultGraphicsDevice#DefaultGraphicsDevice(java.lang.String, long)`, `DefaultGraphicsDevice#DefaultGraphicsDevice(java.lang.String, long, com.jogamp.nativewindow.ToolkitLock)`

getType	back to summary
public final String getType() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.getType. Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.getType. Returns the type of the underlying subsystem, ie NativeWindowFactory.TYPE_KD, NativeWindowFactory.TYPE_X11, .. Annotations @Override

getType

back to summary

public final String getType()

Implements com.jogamp.nativewindow.AbstractGraphicsDevice.getType.

Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.getType.

Returns the type of the underlying subsystem, ie NativeWindowFactory.TYPE_KD, NativeWindowFactory.TYPE_X11, ..

Annotations

@Override

getUniqueID back to summary

getUniqueID	back to summary
public final String getUniqueID() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.getUniqueID. Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.getUniqueID. Returns a unique ID object of this device using `type`, `connection` and `unitID` as it's key components. The unique ID does not reflect the instance of the device, hence the handle is not included. The unique ID may be used as a key for semantic device mapping. The returned string object reference is unique using `String#intern()` and hence can be used as a key itself. Annotations @Override

public final String getUniqueID()

Implements com.jogamp.nativewindow.AbstractGraphicsDevice.getUniqueID.

Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.getUniqueID.

Returns a unique ID object of this device using type, connection and unitID as it's key components.

The unique ID does not reflect the instance of the device, hence the handle is not included. The unique ID may be used as a key for semantic device mapping.

The returned string object reference is unique using String#intern() and hence can be used as a key itself.

Annotations

@Override

getUniqueID	back to summary
private static String getUniqueID(final String type, final String connection, final int unitID) Returns a unique String object using `String#intern()` for the given arguments, which object reference itself can be used as a key.

getUnitID back to summary

getUnitID	back to summary
public final int getUnitID() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.getUnitID. Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.getUnitID. Returns the graphics device `unit ID`. The `unit ID` support multiple graphics device configurations on a local machine. To support remote device, see `getConnection()`. Annotations @Override

public final int getUnitID()

Implements com.jogamp.nativewindow.AbstractGraphicsDevice.getUnitID.

Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.getUnitID.

Returns the graphics device unit ID.
The unit ID support multiple graphics device configurations on a local machine.
To support remote device, see getConnection().

Annotations

@Override

isHandleOwner back to summary

isHandleOwner	back to summary
public boolean isHandleOwner() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.isHandleOwner. Returns:boolean Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.isHandleOwner. `true` if instance owns the handle to issue `close()`, otherwise `false`. Annotations @Override

public boolean isHandleOwner()

Implements com.jogamp.nativewindow.AbstractGraphicsDevice.isHandleOwner.

Returns:boolean

Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.isHandleOwner.

true if instance owns the handle to issue close(), otherwise false.

Annotations

@Override

lock back to summary

lock	back to summary
public final void lock() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.lock. Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.lock. Optionally locking the device, utilizing eg `com.jogamp.nativewindow.ToolkitLock#lock()`. The lock implementation must be recursive. Locking is perfomed via delegation to `ToolkitLock#lock()`, `ToolkitLock#unlock()`. Annotations @Override See Also `DefaultGraphicsDevice#DefaultGraphicsDevice(java.lang.String, long)`, `DefaultGraphicsDevice#DefaultGraphicsDevice(java.lang.String, long, com.jogamp.nativewindow.ToolkitLock)`

public final void lock()

Implements com.jogamp.nativewindow.AbstractGraphicsDevice.lock.

Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.lock.

Optionally locking the device, utilizing eg com.jogamp.nativewindow.ToolkitLock#lock(). The lock implementation must be recursive.

Locking is perfomed via delegation to ToolkitLock#lock(), ToolkitLock#unlock().

Annotations

@Override

open back to summary

open	back to summary
public boolean open() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.open. Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.open. Optionally [re]opening the device if handle is `null`. The default implementation is a `NOP`. Example implementations like `com.jogamp.nativewindow.x11.X11GraphicsDevice` or `com.jogamp.nativewindow.egl.EGLGraphicsDevice` issue the native open operation in case handle is `null`. Returns:boolean true if the handle was `null` and opening was successful, otherwise false. Annotations @Override

public boolean open()

Implements com.jogamp.nativewindow.AbstractGraphicsDevice.open.

Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.open.

Optionally [re]opening the device if handle is null.

The default implementation is a NOP.

Example implementations like com.jogamp.nativewindow.x11.X11GraphicsDevice or com.jogamp.nativewindow.egl.EGLGraphicsDevice issue the native open operation in case handle is null.

Returns:boolean

true if the handle was null and opening was successful, otherwise false.

Annotations

@Override

setHandle	back to summary
protected final long setHandle(final long newHandle) Set the native handle of the underlying native device and return the previous one.

setHandleOwnership	back to summary
protected Object setHandleOwnership(final Object newOwnership)

setToolkitLock back to summary

setToolkitLock	back to summary
protected ToolkitLock setToolkitLock(final ToolkitLock locker) Set the internal ToolkitLock, which is used within the `lock()` and `unlock()` implementation. The current ToolkitLock is being locked/unlocked while swapping the reference, ensuring no concurrent access can occur during the swap. Parameters locker:ToolkitLock the ToolkitLock, if null, `jogamp.nativewindow.NullToolkitLock` is being used Returns:ToolkitLock the previous ToolkitLock instance

protected ToolkitLock setToolkitLock(final ToolkitLock locker)

Set the internal ToolkitLock, which is used within the lock() and unlock() implementation.

The current ToolkitLock is being locked/unlocked while swapping the reference, ensuring no concurrent access can occur during the swap.

Parameters

locker:ToolkitLock: the ToolkitLock, if null, jogamp.nativewindow.NullToolkitLock is being used

Returns:ToolkitLock

the previous ToolkitLock instance

swapDeviceHandleAndOwnership	back to summary
public static final void swapDeviceHandleAndOwnership(final DefaultGraphicsDevice aDevice1, final DefaultGraphicsDevice aDevice2)

toString	back to summary
public String toString() Overrides java.lang.Object.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.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

unlock back to summary

unlock	back to summary
public final void unlock() Implements com.jogamp.nativewindow.AbstractGraphicsDevice.unlock. Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.unlock. Optionally unlocking the device, utilizing eg `com.jogamp.nativewindow.ToolkitLock#unlock()`. The lock implementation must be recursive. Locking is perfomed via delegation to `ToolkitLock#lock()`, `ToolkitLock#unlock()`. Annotations @Override See Also `DefaultGraphicsDevice#DefaultGraphicsDevice(java.lang.String, long)`, `DefaultGraphicsDevice#DefaultGraphicsDevice(java.lang.String, long, com.jogamp.nativewindow.ToolkitLock)`

public final void unlock()

Implements com.jogamp.nativewindow.AbstractGraphicsDevice.unlock.

Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.unlock.

Optionally unlocking the device, utilizing eg com.jogamp.nativewindow.ToolkitLock#unlock(). The lock implementation must be recursive.

Locking is perfomed via delegation to ToolkitLock#lock(), ToolkitLock#unlock().

Annotations

@Override

validateLocked	back to summary
public final void validateLocked() throws RuntimeException Implements com.jogamp.nativewindow.AbstractGraphicsDevice.validateLocked. Annotations @Override Exceptions RuntimeException: Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.validateLocked. if current thread does not hold the lock

validateLocked

back to summary

public final void validateLocked() throws RuntimeException

Implements com.jogamp.nativewindow.AbstractGraphicsDevice.validateLocked.

Annotations

@Override

Exceptions

RuntimeException:

Doc from com.jogamp.nativewindow.AbstractGraphicsDevice.validateLocked.

if current thread does not hold the lock

public Class DefaultGraphicsDevice

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail