JOGL 2.3.2 · com.jogamp.nativewindow.NativeWindowFactory

Field Summary

Modifier and Type	Field and Description
private static final List<Runnable>	customShutdownHooks
protected static final boolean	DEBUG
private static NativeWindowFactory	defaultFactory
private static boolean	desktopHasThreadingIssues
private static final String	GDIClassName `jogamp.nativewindow.windows.GDIUtil` implements `ToolkitProperties`.
private static boolean	initialized
private static boolean	isAWTAvailable
private static volatile boolean	isJVMShuttingDown
private static final String	JAWTUtilClassName
private static ToolkitLock	jawtUtilJAWTToolkitLock
private static Class<?>	nativeWindowClass
private static final String	nativeWindowingTypeCustom
private static final String	nativeWindowingTypePure
private static final String	OSXUtilClassName `jogamp.nativewindow.macosx.OSXUtil` implements `ToolkitProperties`.
private static Map<Class<?>, NativeWindowFactory>	registeredFactories
private static boolean	requiresToolkitLock
public static final String	TYPE_ANDROID Android/EGL type, as retrieved with `getNativeWindowType(boolean)`.
public static final String	TYPE_AWT Generic AWT type, as retrieved with `getNativeWindowType(boolean)`.
public static final String	TYPE_BCM_VC_IV Broadcom VC IV/EGL type, as retrieved with `getNativeWindowType(boolean)`.
public static final String	TYPE_DEFAULT Generic DEFAULT type, where platform implementation don't care, as retrieved with `getNativeWindowType(boolean)`.
public static final String	TYPE_EGL OpenKODE/EGL type, as retrieved with `getNativeWindowType(boolean)`.
public static final String	TYPE_MACOSX Mac OS X type, as retrieved with `getNativeWindowType(boolean)`.
public static final String	TYPE_WINDOWS Microsoft Windows type, as retrieved with `getNativeWindowType(boolean)`.
public static final String	TYPE_X11 X11 type, as retrieved with `getNativeWindowType(boolean)`.
private static final String	X11UtilClassName `jogamp.nativewindow.x11.X11Util` implements `ToolkitProperties`.

Constructor Summary

Access	Constructor and Description
protected	NativeWindowFactory() Creates a new NativeWindowFactory instance.

Method Summary

Modifier and Type	Method and Description
private static String	_getNativeWindowingType()
public static void	addCustomShutdownHook(final boolean if true add runnable at the start, otherwise at the end head, final Runnable runnable to be added. runnable) Add a custom shutdown hook to be performed at JVM shutdown before shutting down NativeWindowFactory instance.
public static AbstractGraphicsDevice	createDevice(final String displayConnection, final boolean own) Creates a native device type, following `getNativeWindowType(true)`.
public static AbstractGraphicsDevice	createDevice(final String nwt, final String displayConnection, final boolean own) Creates a native device type, following the given `native-window-type`.
public static AbstractGraphicsScreen	Returns: newly created AbstractGraphicsScreen matching device's native type createScreen(final AbstractGraphicsDevice device, int -1 is default screen of the given device, e.g. maybe 0 or determined by native API. >= 0 is specific screen screen)
public static NativeWindow	createWrappedWindow(final AbstractGraphicsScreen aScreen, final long surfaceHandle, final long windowHandle, final UpstreamWindowHookMutableSizePos hook) Creates a wrapped `NativeWindow` with given native handles and `AbstractGraphicsScreen`.
public static ToolkitLock	getAWTToolkitLock() Returns the AWT `ToolkitLock` (JAWT based) if `isAWTAvailable`, otherwise null.
public static String	getDefaultDisplayConnection()
public static String	getDefaultDisplayConnection(final String nwt)
public static NativeWindowFactory	getDefaultFactory() Gets the default NativeWindowFactory.
public static ToolkitLock	getDefaultToolkitLock() Provides the system default `ToolkitLock` for the default system windowing type.
public static ToolkitLock	getDefaultToolkitLock(final String type) Provides the default `ToolkitLock` for `type`.
public static ToolkitLock	getDefaultToolkitLock(final String type, final long deviceHandle) Provides the default `ToolkitLock` for `type` and `deviceHandle`.
public static NativeWindowFactory	getFactory(final Class<?> windowClass) Returns the appropriate NativeWindowFactory to handle window objects of the given type.
public static PointImmutable	Returns: top-left client-area position in window units FIXME: Bug 973 Needs service provider interface (SPI) for TK dependent implementation getLocationOnScreen(final NativeWindow nw)
public static NativeWindow	getNativeWindow(final Object winObj, final AbstractGraphicsConfiguration config) Converts the given window object and it's `AbstractGraphicsConfiguration` into a `NativeWindow` which can be operated upon by a custom toolkit, e.g. `com.jogamp.opengl.GLDrawableFactory`.
protected abstract NativeWindow	getNativeWindowImpl(Object winObj, AbstractGraphicsConfiguration config) Performs the conversion from a toolkit's window object to a NativeWindow.
public static String	Returns: the native window type, e.g. `TYPE_X11`, which is canonical via `String#intern()`. Hence `String#equals(Object)` and `==` produce the same result. getNativeWindowType(final boolean if false return the native value, if true return a custom value if set, otherwise fallback to the native value. useCustom)
public static ToolkitLock	getNullToolkitLock()
public static OffscreenLayerSurface	getOffscreenLayerSurface(final NativeSurface The surface to query. surface, final boolean If true, only return the enabled `OffscreenLayerSurface`, see `OffscreenLayerOption#isOffscreenLayerSurfaceEnabled()`. ifEnabled) Returns the `OffscreenLayerSurface` instance of this `NativeSurface`.
private static final boolean	guessBroadcomVCIV()
public static synchronized void	initSingleton() Static one time initialization of this factory.
private static void	initSingletonNativeImpl(final ClassLoader cl)
public static boolean	Returns: true if not headless, AWT Component and NativeWindow's AWT part available isAWTAvailable()
public static synchronized boolean	isInitialized() Returns true if `initSingleton()` has been called w/o subsequent `shutdown(boolean)`.
public static final boolean	isJVMShuttingDown() Returns true if the JVM is shutting down, otherwise false.
public static boolean	isNativeVisualIDValidForProcessing(final int visualID) Returns true if the given visualID is valid for further processing, i.e. OpenGL usage, otherwise return false.
protected static void	registerFactory(final Class<?> windowClass, final NativeWindowFactory factory) Registers a NativeWindowFactory handling window objects of the given class.
public static boolean	Returns: true if the underlying toolkit requires locking, otherwise false. requiresToolkitLock()
public static void	setDefaultFactory(final NativeWindowFactory factory) Sets the default NativeWindowFactory.
public static synchronized void	shutdown(final boolean _isJVMShuttingDown) Cleanup resources at JVM shutdown
private static void	shutdownNativeImpl(final ClassLoader cl)

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

Field Detail

customShutdownHooks	back to summary
private static final List<Runnable> customShutdownHooks

DEBUG	back to summary
protected static final boolean DEBUG

defaultFactory	back to summary
private static NativeWindowFactory defaultFactory

desktopHasThreadingIssues	back to summary
private static boolean desktopHasThreadingIssues

GDIClassName	back to summary
private static final String GDIClassName `jogamp.nativewindow.windows.GDIUtil` implements `ToolkitProperties`.

initialized	back to summary
private static boolean initialized

isAWTAvailable	back to summary
private static boolean isAWTAvailable

isJVMShuttingDown	back to summary
private static volatile boolean isJVMShuttingDown

JAWTUtilClassName	back to summary
private static final String JAWTUtilClassName

jawtUtilJAWTToolkitLock	back to summary
private static ToolkitLock jawtUtilJAWTToolkitLock

nativeWindowClass	back to summary
private static Class<?> nativeWindowClass

nativeWindowingTypeCustom	back to summary
private static final String nativeWindowingTypeCustom

nativeWindowingTypePure	back to summary
private static final String nativeWindowingTypePure

OSXUtilClassName	back to summary
private static final String OSXUtilClassName `jogamp.nativewindow.macosx.OSXUtil` implements `ToolkitProperties`.

registeredFactories	back to summary
private static Map<Class<?>, NativeWindowFactory> registeredFactories

requiresToolkitLock	back to summary
private static boolean requiresToolkitLock

TYPE_ANDROID	back to summary
public static final String TYPE_ANDROID Android/EGL type, as retrieved with `getNativeWindowType(boolean)`. String is canonical via `String#intern()`.

TYPE_AWT	back to summary
public static final String TYPE_AWT Generic AWT type, as retrieved with `getNativeWindowType(boolean)`. String is canonical via `String#intern()`.

TYPE_BCM_VC_IV	back to summary
public static final String TYPE_BCM_VC_IV Broadcom VC IV/EGL type, as retrieved with `getNativeWindowType(boolean)`. String is canonical via `String#intern()`.

TYPE_DEFAULT	back to summary
public static final String TYPE_DEFAULT Generic DEFAULT type, where platform implementation don't care, as retrieved with `getNativeWindowType(boolean)`. String is canonical via `String#intern()`.

TYPE_EGL	back to summary
public static final String TYPE_EGL OpenKODE/EGL type, as retrieved with `getNativeWindowType(boolean)`. String is canonical via `String#intern()`.

TYPE_MACOSX	back to summary
public static final String TYPE_MACOSX Mac OS X type, as retrieved with `getNativeWindowType(boolean)`. String is canonical via `String#intern()`.

TYPE_WINDOWS	back to summary
public static final String TYPE_WINDOWS Microsoft Windows type, as retrieved with `getNativeWindowType(boolean)`. String is canonical via `String#intern()`.

TYPE_X11	back to summary
public static final String TYPE_X11 X11 type, as retrieved with `getNativeWindowType(boolean)`. String is canonical via `String#intern()`.

X11UtilClassName	back to summary
private static final String X11UtilClassName `jogamp.nativewindow.x11.X11Util` implements `ToolkitProperties`.

Constructor Detail

NativeWindowFactory	back to summary
protected NativeWindowFactory() Creates a new NativeWindowFactory instance. End users do not need to call this method.

Method Detail

_getNativeWindowingType	back to summary
private static String _getNativeWindowingType()

addCustomShutdownHook	back to summary
public static void addCustomShutdownHook(final boolean head, final Runnable runnable) Add a custom shutdown hook to be performed at JVM shutdown before shutting down NativeWindowFactory instance. Parameters head:boolean if true add runnable at the start, otherwise at the end runnable:Runnable runnable to be added.

addCustomShutdownHook

back to summary

public static void addCustomShutdownHook(final boolean head, final Runnable runnable)

Add a custom shutdown hook to be performed at JVM shutdown before shutting down NativeWindowFactory instance.

Parameters

head:boolean: if true add runnable at the start, otherwise at the end
runnable:Runnable: runnable to be added.

createDevice back to summary

createDevice	back to summary
public static AbstractGraphicsDevice createDevice(final String displayConnection, final boolean own) Creates a native device type, following `getNativeWindowType(true)`. The device will be opened if `own` is true, otherwise no native handle will ever be acquired.

public static AbstractGraphicsDevice createDevice(final String displayConnection, final boolean own)

Creates a native device type, following getNativeWindowType(true).

The device will be opened if own is true, otherwise no native handle will ever be acquired.

createDevice back to summary

createDevice	back to summary
public static AbstractGraphicsDevice createDevice(final String nwt, final String displayConnection, final boolean own) Creates a native device type, following the given `native-window-type`. The device will be opened if `own` is true, otherwise no native handle will ever be acquired. FIXME: Bug 973 Needs service provider interface (SPI) for TK dependent implementation

public static AbstractGraphicsDevice createDevice(final String nwt, final String displayConnection, final boolean own)

Creates a native device type, following the given native-window-type.

The device will be opened if own is true, otherwise no native handle will ever be acquired.

FIXME: Bug 973 Needs service provider interface (SPI) for TK dependent implementation

createScreen	back to summary
public static AbstractGraphicsScreen createScreen(final AbstractGraphicsDevice device, int screen) Parameters screen:int -1 is default screen of the given device, e.g. maybe 0 or determined by native API. >= 0 is specific screen Returns:AbstractGraphicsScreen newly created AbstractGraphicsScreen matching device's native type

createWrappedWindow back to summary

createWrappedWindow	back to summary
public static NativeWindow createWrappedWindow(final AbstractGraphicsScreen aScreen, final long surfaceHandle, final long windowHandle, final UpstreamWindowHookMutableSizePos hook) Creates a wrapped `NativeWindow` with given native handles and `AbstractGraphicsScreen`. The given `UpstreamWindowHookMutableSizePos` maybe used to reflect resizes and repositioning of the native window. The `AbstractGraphicsScreen` may be created via `createScreen(AbstractGraphicsDevice, int)`. The `AbstractGraphicsScreen` may have an underlying open `AbstractGraphicsDevice` or a simple dummy instance, see `createDevice(String, boolean)`.

public static NativeWindow createWrappedWindow(final AbstractGraphicsScreen aScreen, final long surfaceHandle, final long windowHandle, final UpstreamWindowHookMutableSizePos hook)

Creates a wrapped NativeWindow with given native handles and AbstractGraphicsScreen.

The given UpstreamWindowHookMutableSizePos maybe used to reflect resizes and repositioning of the native window.

The AbstractGraphicsScreen may be created via createScreen(AbstractGraphicsDevice, int).

The AbstractGraphicsScreen may have an underlying open AbstractGraphicsDevice or a simple dummy instance, see createDevice(String, boolean).

getAWTToolkitLock back to summary

getAWTToolkitLock	back to summary
public static ToolkitLock getAWTToolkitLock() Returns the AWT `ToolkitLock` (JAWT based) if `isAWTAvailable`, otherwise null. The JAWT based `ToolkitLock` also locks the global lock, which matters if the latter is required.

public static ToolkitLock getAWTToolkitLock()

Returns the AWT ToolkitLock (JAWT based) if isAWTAvailable, otherwise null.

The JAWT based ToolkitLock also locks the global lock, which matters if the latter is required.

getDefaultDisplayConnection	back to summary
public static String getDefaultDisplayConnection()

getDefaultDisplayConnection	back to summary
public static String getDefaultDisplayConnection(final String nwt)

getDefaultFactory	back to summary
public static NativeWindowFactory getDefaultFactory() Gets the default NativeWindowFactory.

getDefaultToolkitLock back to summary

getDefaultToolkitLock	back to summary
public static ToolkitLock getDefaultToolkitLock() Provides the system default `ToolkitLock` for the default system windowing type. See Also `getNativeWindowType(boolean)`, `getDefaultToolkitLock(java.lang.String)`

public static ToolkitLock getDefaultToolkitLock()

Provides the system default ToolkitLock for the default system windowing type.

See Also: getNativeWindowType(boolean), getDefaultToolkitLock(java.lang.String)

getDefaultToolkitLock back to summary

getDefaultToolkitLock	back to summary
public static ToolkitLock getDefaultToolkitLock(final String type) Provides the default `ToolkitLock` for `type`. JAWT `ToolkitLock` if required and `type` is of `TYPE_AWT` and AWT available, `jogamp.nativewindow.ResourceToolkitLock` if required, otherwise `jogamp.nativewindow.NullToolkitLock`

public static ToolkitLock getDefaultToolkitLock(final String type)

Provides the default ToolkitLock for type.

JAWT ToolkitLock if required and type is of TYPE_AWT and AWT available,
jogamp.nativewindow.ResourceToolkitLock if required, otherwise
jogamp.nativewindow.NullToolkitLock

getDefaultToolkitLock back to summary

getDefaultToolkitLock	back to summary
public static ToolkitLock getDefaultToolkitLock(final String type, final long deviceHandle) Provides the default `ToolkitLock` for `type` and `deviceHandle`. JAWT `ToolkitLock` if required and `type` is of `TYPE_AWT` and AWT available, `jogamp.nativewindow.ResourceToolkitLock` if required, otherwise `jogamp.nativewindow.NullToolkitLock`

public static ToolkitLock getDefaultToolkitLock(final String type, final long deviceHandle)

Provides the default ToolkitLock for type and deviceHandle.

JAWT ToolkitLock if required and type is of TYPE_AWT and AWT available,
jogamp.nativewindow.ResourceToolkitLock if required, otherwise
jogamp.nativewindow.NullToolkitLock

getFactory back to summary

getFactory	back to summary
public static NativeWindowFactory getFactory(final Class<?> windowClass) throws IllegalArgumentException Returns the appropriate NativeWindowFactory to handle window objects of the given type. The windowClass might be `NativeWindow`, in which case the client has already assumed the responsibility of creating a compatible NativeWindow implementation, or it might be that of a toolkit class like `Component`.

public static NativeWindowFactory getFactory(final Class<?> windowClass) throws IllegalArgumentException

Returns the appropriate NativeWindowFactory to handle window objects of the given type. The windowClass might be NativeWindow, in which case the client has already assumed the responsibility of creating a compatible NativeWindow implementation, or it might be that of a toolkit class like Component.

getLocationOnScreen	back to summary
public static PointImmutable getLocationOnScreen(final NativeWindow nw) Returns:PointImmutable top-left client-area position in window units FIXME: Bug 973 Needs service provider interface (SPI) for TK dependent implementation

getNativeWindow back to summary

getNativeWindow	back to summary
public static NativeWindow getNativeWindow(final Object winObj, final AbstractGraphicsConfiguration config) throws IllegalArgumentException, NativeWindowException Converts the given window object and it's `AbstractGraphicsConfiguration` into a `NativeWindow` which can be operated upon by a custom toolkit, e.g. `com.jogamp.opengl.GLDrawableFactory`. The object may be a component for a particular window toolkit, such as an AWT Canvas. It may also be a NativeWindow object itself. You shall utilize `GraphicsConfigurationFactory` to construct a proper `AbstractGraphicsConfiguration`. The particular implementation of the NativeWindowFactory is responsible for handling objects from a particular window toolkit. The built-in NativeWindowFactory handles NativeWindow instances as well as AWT Components. Exceptions IllegalArgumentException: if the given window object could not be handled by any of the registered NativeWindowFactory instances See Also `com.jogamp.nativewindow.GraphicsConfigurationFactory#chooseGraphicsConfiguration(Capabilities, CapabilitiesChooser, AbstractGraphicsScreen)`

public static NativeWindow getNativeWindow(final Object winObj, final AbstractGraphicsConfiguration config) throws IllegalArgumentException, NativeWindowException

Converts the given window object and it's AbstractGraphicsConfiguration into a NativeWindow which can be operated upon by a custom toolkit, e.g. com.jogamp.opengl.GLDrawableFactory.
The object may be a component for a particular window toolkit, such as an AWT Canvas. It may also be a NativeWindow object itself.
You shall utilize GraphicsConfigurationFactory to construct a proper AbstractGraphicsConfiguration.
The particular implementation of the NativeWindowFactory is responsible for handling objects from a particular window toolkit. The built-in NativeWindowFactory handles NativeWindow instances as well as AWT Components.

Exceptions

IllegalArgumentException:: if the given window object could not be handled by any of the registered NativeWindowFactory instances

See Also

com.jogamp.nativewindow.GraphicsConfigurationFactory#chooseGraphicsConfiguration(Capabilities, CapabilitiesChooser, AbstractGraphicsScreen)

getNativeWindowImpl	back to summary
protected abstract NativeWindow getNativeWindowImpl(Object winObj, AbstractGraphicsConfiguration config) throws IllegalArgumentException Performs the conversion from a toolkit's window object to a NativeWindow. Implementors of concrete NativeWindowFactory subclasses should override this method.

getNativeWindowType	back to summary
public static String getNativeWindowType(final boolean useCustom) Parameters useCustom:boolean if false return the native value, if true return a custom value if set, otherwise fallback to the native value. Returns:String the native window type, e.g. `TYPE_X11`, which is canonical via `String#intern()`. Hence `String#equals(Object)` and `==` produce the same result.

getNullToolkitLock	back to summary
public static ToolkitLock getNullToolkitLock()

getOffscreenLayerSurface back to summary

getOffscreenLayerSurface	back to summary
public static OffscreenLayerSurface getOffscreenLayerSurface(final NativeSurface surface, final boolean ifEnabled) Returns the `OffscreenLayerSurface` instance of this `NativeSurface`. In case this surface is a `NativeWindow`, we traverse from the given surface up to root until an implementation of `OffscreenLayerSurface` is found. In case `ifEnabled` is true, the surface must also implement `OffscreenLayerOption` where `OffscreenLayerOption#isOffscreenLayerSurfaceEnabled()` is `true`. Parameters surface:NativeSurface The surface to query. ifEnabled:boolean If true, only return the enabled `OffscreenLayerSurface`, see `OffscreenLayerOption#isOffscreenLayerSurfaceEnabled()`.

public static OffscreenLayerSurface getOffscreenLayerSurface(final NativeSurface surface, final boolean ifEnabled)

Returns the OffscreenLayerSurface instance of this NativeSurface.

In case this surface is a NativeWindow, we traverse from the given surface up to root until an implementation of OffscreenLayerSurface is found. In case ifEnabled is true, the surface must also implement OffscreenLayerOption where OffscreenLayerOption#isOffscreenLayerSurfaceEnabled() is true.

Parameters

surface:NativeSurface: The surface to query.
ifEnabled:boolean: If true, only return the enabled OffscreenLayerSurface, see OffscreenLayerOption#isOffscreenLayerSurfaceEnabled().

guessBroadcomVCIV	back to summary
private static final boolean guessBroadcomVCIV()

initSingleton	back to summary
public static synchronized void initSingleton() Static one time initialization of this factory. This initialization method must be called once by the program or utilizing modules!

initSingletonNativeImpl	back to summary
private static void initSingletonNativeImpl(final ClassLoader cl)

isAWTAvailable	back to summary
public static boolean isAWTAvailable() Returns:boolean true if not headless, AWT Component and NativeWindow's AWT part available

isInitialized	back to summary
public static synchronized boolean isInitialized() Returns true if `initSingleton()` has been called w/o subsequent `shutdown(boolean)`.

isJVMShuttingDown	back to summary
public static final boolean isJVMShuttingDown() Returns true if the JVM is shutting down, otherwise false.

isNativeVisualIDValidForProcessing back to summary

public static boolean isNativeVisualIDValidForProcessing(final int visualID)

Returns true if the given visualID is valid for further processing, i.e. OpenGL usage, otherwise return false.

On certain platforms, i.e. X11, a valid visualID is required at window creation. Other platforms may determine it later on, e.g. OSX and Windows.

If the visualID is VisualIDHolder#VID_UNDEFINED and the platform requires it at creation time (see above), it is not valid for further processing.

FIXME: Bug 973 Needs service provider interface (SPI) for TK dependent implementation

registerFactory	back to summary
protected static void registerFactory(final Class<?> windowClass, final NativeWindowFactory factory) Registers a NativeWindowFactory handling window objects of the given class. This does not need to be called by end users, only implementors of new NativeWindowFactory subclasses.

requiresToolkitLock	back to summary
public static boolean requiresToolkitLock() Returns:boolean true if the underlying toolkit requires locking, otherwise false.

setDefaultFactory	back to summary
public static void setDefaultFactory(final NativeWindowFactory factory) Sets the default NativeWindowFactory.

shutdown	back to summary
public static synchronized void shutdown(final boolean _isJVMShuttingDown) Cleanup resources at JVM shutdown

shutdownNativeImpl	back to summary
private static void shutdownNativeImpl(final ClassLoader cl)

public abstract Class NativeWindowFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail