Package com.jogamp.nativewindow.egl

Class EGLGraphicsDevice

java.lang.Object

com.jogamp.nativewindow.DefaultGraphicsDevice

com.jogamp.nativewindow.egl.EGLGraphicsDevice

All Implemented Interfaces:

AbstractGraphicsDevice, Cloneable

public class EGLGraphicsDevice
extends DefaultGraphicsDevice
implements Cloneable

Encapsulates a graphics device on EGL platforms.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EGLGraphicsDevice.EGLDisplayLifecycleCallback	Hack to allow inject a EGL termination call.

Field Summary

Fields

Modifier and Type	Field	Description
static int	EGL_DEFAULT_DISPLAY	EGL default native display ID
static int	EGL_NO_DISPLAY	EGL no display handle

Fields inherited from interface com.jogamp.nativewindow.AbstractGraphicsDevice

DEBUG, DEFAULT_CONNECTION, DEFAULT_UNIT, EXTERNAL_CONNECTION

Constructor Summary

Constructors

Constructor	Description
EGLGraphicsDevice()	Constructs a dummy EGLGraphicsDevice with default connection settings.
EGLGraphicsDevice(long nativeDisplayID, long eglDisplay, String connection, int unitID)	Constructs a new EGLGraphicsDevice reusing the given native display connection and handle
EGLGraphicsDevice(long nativeDisplayID, String connection, int unitID)	Constructs a new dummy EGLGraphicsDevice reusing the given native display connection with a EGL#EGL_NO_DISPLAY EGL display handle.
EGLGraphicsDevice(long nativeDisplayID, String connection, int unitID, EGLGraphicsDevice.EGLDisplayLifecycleCallback eglLifecycleCallback)	Constructs a new EGLGraphicsDevice using AbstractGraphicsDevice's native display ID and connection, using the EGLGraphicsDevice.EGLDisplayLifecycleCallback to handle this instance's native EGL lifecycle.
EGLGraphicsDevice(AbstractGraphicsDevice aDevice, EGLGraphicsDevice.EGLDisplayLifecycleCallback eglLifecycleCallback)	Constructs a new EGLGraphicsDevice using AbstractGraphicsDevice's native display ID and connection, using the EGLGraphicsDevice.EGLDisplayLifecycleCallback to handle this instance's native EGL lifecycle.

Method Summary

Modifier and Type	Method	Description
void	clearHandleOwner()
Object	clone()
boolean	close()	Closes the EGL device if handle is not null and it's EGLGraphicsDevice.EGLDisplayLifecycleCallback is valid.
VersionNumber	getEGLVersion()	EGL server version as returned by eglInitialize(..).
long	getNativeDisplayID()	Return the native display ID of this instance.
static long	getNativeDisplayID(AbstractGraphicsDevice aDevice)	Returns the native display ID of the given abstract device, i.e.
boolean	isHandleOwner()
boolean	open()	Opens the EGL device if handle is null and it's EGLGraphicsDevice.EGLDisplayLifecycleCallback is valid.
boolean	sameNativeDisplayID(AbstractGraphicsDevice aDevice)	Returns true if given AbstractGraphicsDevice uses the same getNativeDisplayID() of this instance.
String	toString()

Methods inherited from class com.jogamp.nativewindow.DefaultGraphicsDevice

getConnection, getDefaultDisplayConnection, getDefaultDisplayConnection, getHandle, getToolkitLock, getType, getUniqueID, getUnitID, lock, swapDeviceHandleAndOwnership, unlock, validateLocked

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EGL_DEFAULT_DISPLAY

public static final int EGL_DEFAULT_DISPLAY

EGL default native display ID

See Also:

Constant Field Values

EGL_NO_DISPLAY

public static final int EGL_NO_DISPLAY

EGL no display handle

See Also:

Constant Field Values

Constructor Detail

EGLGraphicsDevice

public EGLGraphicsDevice()

Constructs a dummy EGLGraphicsDevice with default connection settings.

The constructed instance will never create a valid EGL display handle.

EGLGraphicsDevice

public EGLGraphicsDevice(long nativeDisplayID,
                         String connection,
                         int unitID)

Constructs a new dummy EGLGraphicsDevice reusing the given native display connection with a EGL#EGL_NO_DISPLAY EGL display handle.

The constructed instance will never create a valid EGL display handle.

Parameters:

nativeDisplayID - the existing native display ID

eglDisplay - the existing EGL handle to this nativeDisplayID

connection - the existing underlying native connection name

unitID - the unit ID

EGLGraphicsDevice

public EGLGraphicsDevice(long nativeDisplayID,
                         long eglDisplay,
                         String connection,
                         int unitID)

Constructs a new EGLGraphicsDevice reusing the given native display connection and handle

The constructed instance will not take ownership of given EGL display handle.

Parameters:

nativeDisplayID - the existing native display ID

eglDisplay - the existing EGL handle to this nativeDisplayID

connection - the existing underlying native connection name

unitID - the unit ID

EGLGraphicsDevice

public EGLGraphicsDevice(AbstractGraphicsDevice aDevice,
                         EGLGraphicsDevice.EGLDisplayLifecycleCallback eglLifecycleCallback)

Constructs a new EGLGraphicsDevice using AbstractGraphicsDevice's native display ID and connection, using the EGLGraphicsDevice.EGLDisplayLifecycleCallback to handle this instance's native EGL lifecycle.

The constructed instance will take ownership of the created EGL display handle.

Parameters:

aDevice - valid AbstractGraphicsDevice's native display ID, connection and unitID

eglLifecycleCallback - valid EGLGraphicsDevice.EGLDisplayLifecycleCallback to handle this instance's native EGL lifecycle.

EGLGraphicsDevice

public EGLGraphicsDevice(long nativeDisplayID,
                         String connection,
                         int unitID,
                         EGLGraphicsDevice.EGLDisplayLifecycleCallback eglLifecycleCallback)

Constructs a new EGLGraphicsDevice using AbstractGraphicsDevice's native display ID and connection, using the EGLGraphicsDevice.EGLDisplayLifecycleCallback to handle this instance's native EGL lifecycle.

The constructed instance will take ownership of the created EGL display handle.

Parameters:

nativeDisplayID - the existing native display ID

connection - the existing underlying native connection name

unitID - the unit ID

eglLifecycleCallback - valid EGLGraphicsDevice.EGLDisplayLifecycleCallback to handle this instance's native EGL lifecycle.

Method Detail

getNativeDisplayID

public static long getNativeDisplayID(AbstractGraphicsDevice aDevice)

Returns the native display ID of the given abstract device, i.e. either getNativeDisplayID() or AbstractGraphicsDevice.getHandle().

getEGLVersion

public VersionNumber getEGLVersion()

EGL server version as returned by eglInitialize(..). Only valid after open().

getNativeDisplayID

public long getNativeDisplayID()

Return the native display ID of this instance.

Since EGL 1.4, sharing resources requires e.g. a GLContext to use the same native display ID for the so called shared context list and the to be created context.

See Also:

getNativeDisplayID(AbstractGraphicsDevice)

sameNativeDisplayID

public boolean sameNativeDisplayID(AbstractGraphicsDevice aDevice)

Returns true if given AbstractGraphicsDevice uses the same getNativeDisplayID() of this instance.

In case given AbstractGraphicsDevice is not a EGLGraphicsDevice, its AbstractGraphicsDevice.getHandle() is being used as the native display id for a matching EGLGraphicsDevice instance.

See Also:

getNativeDisplayID(AbstractGraphicsDevice)

clone

public Object clone()

Specified by:

clone in interface AbstractGraphicsDevice

Overrides:

clone in class DefaultGraphicsDevice

open

public boolean open()

Opens the EGL device if handle is null and it's EGLGraphicsDevice.EGLDisplayLifecycleCallback is valid.

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

The default implementation is a NOP.

Example implementations like X11GraphicsDevice or EGLGraphicsDevice issue the native open operation in case handle is null.

Specified by:

open in interface AbstractGraphicsDevice

Overrides:

open in class DefaultGraphicsDevice

Returns:

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

close

public boolean close()

Closes the EGL device if handle is not null and it's EGLGraphicsDevice.EGLDisplayLifecycleCallback is valid.

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 X11GraphicsDevice or EGLGraphicsDevice issue the native close operation or skip it depending on the handles's ownership.

Specified by:

close in interface AbstractGraphicsDevice

Overrides:

close in class DefaultGraphicsDevice

Returns:

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

isHandleOwner

public boolean isHandleOwner()

Specified by:

isHandleOwner in interface AbstractGraphicsDevice

Overrides:

isHandleOwner in class DefaultGraphicsDevice

Returns:

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

clearHandleOwner

public void clearHandleOwner()

Specified by:

clearHandleOwner in interface AbstractGraphicsDevice

Overrides:

clearHandleOwner in class DefaultGraphicsDevice

toString

public String toString()

Overrides:

toString in class DefaultGraphicsDevice