NativeWindowFactory (JOGL, NativeWindow and NEWT APIs)

java.lang.Object
- javax.media.nativewindow.NativeWindowFactory

```
public abstract class NativeWindowFactory
extends Object
```
Provides a pluggable mechanism for arbitrary window toolkits to adapt their components to the NativeWindow interface, which provides a platform-independent mechanism of accessing the information required to perform operations like hardware-accelerated rendering using the OpenGL API.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`TYPE_ANDROID` Android/EGL type, as retrieved with `getNativeWindowType(boolean)`
`static String`	`TYPE_AWT` Generic AWT type, as retrieved with `getNativeWindowType(boolean)`
`static String`	`TYPE_DEFAULT` Generic DEFAULT type, where platform implementation don't care, as retrieved with `getNativeWindowType(boolean)`
`static String`	`TYPE_EGL` OpenKODE/EGL type, as retrieved with `getNativeWindowType(boolean)`
`static String`	`TYPE_MACOSX` Mac OS X type, as retrieved with `getNativeWindowType(boolean)`
`static String`	`TYPE_WINDOWS` Microsoft Windows type, as retrieved with `getNativeWindowType(boolean)`
`static String`	`TYPE_X11` X11 type, as retrieved with `getNativeWindowType(boolean)`
`static String`	`X11JAWTToolkitLockClassName`
`static String`	`X11ToolkitLockClassName`

Method Summary

Methods
Modifier and Type	Method and Description
`static ToolkitLock`	`createDefaultToolkitLock(String type, long deviceHandle)` Creates the default `ToolkitLock` for `type` and `deviceHandle`.
`static ToolkitLock`	`createDefaultToolkitLock(String type, String sharedType, long deviceHandle)` Creates the default `ToolkitLock` for `type` and `deviceHandle`.
`static ToolkitLock`	`getAWTToolkitLock()` Returns the AWT Toolkit (JAWT based) if `isAWTAvailable`, otherwise null.
`static NativeWindowFactory`	`getDefaultFactory()` Gets the default NativeWindowFactory.
`static ToolkitLock`	`getDefaultToolkitLock()` Provides the system default `ToolkitLock`, a singleton instance.
`static ToolkitLock`	`getDefaultToolkitLock(String type)` Provides the default `ToolkitLock` for `type`, a singleton instance.
`static NativeWindowFactory`	`getFactory(Class<?> windowClass)` Returns the appropriate NativeWindowFactory to handle window objects of the given type.
`static NativeWindow`	`getNativeWindow(Object winObj, 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.
`static String`	`getNativeWindowType(boolean useCustom)`
`static ToolkitLock`	`getNullToolkitLock()`
`static OffscreenLayerSurface`	`getOffscreenLayerSurface(NativeSurface surface, boolean ifEnabled)` Returns the `OffscreenLayerSurface` instance of this `NativeSurface`.
`static void`	`initSingleton(boolean firstUIActionOnProcess)` Static one time initialization of this factory. This initialization method must be called once by the program or utilizing modules!
`static boolean`	`isAWTAvailable()`
`static boolean`	`isFirstUIActionOnProcess()`
`static boolean`	`isNativeVisualIDValidForProcessing(int visualID)` Returns true if the given visualID is valid for further processing, i.e.
`static boolean`	`requiresToolkitLock()`
`static void`	`setDefaultFactory(NativeWindowFactory factory)` Sets the default NativeWindowFactory.
`static void`	`shutdown()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TYPE_EGL
```
public static final String TYPE_EGL
```
    OpenKODE/EGL type, as retrieved with getNativeWindowType(boolean)
    
    See Also:
    Constant Field Values
  - TYPE_WINDOWS
```
public static final String TYPE_WINDOWS
```
    Microsoft Windows type, as retrieved with getNativeWindowType(boolean)
    
    See Also:
    Constant Field Values
  - TYPE_X11
```
public static final String TYPE_X11
```
    X11 type, as retrieved with getNativeWindowType(boolean)
    
    See Also:
    Constant Field Values
  - TYPE_ANDROID
```
public static final String TYPE_ANDROID
```
    Android/EGL type, as retrieved with getNativeWindowType(boolean)
    
    See Also:
    Constant Field Values
  - TYPE_MACOSX
```
public static final String TYPE_MACOSX
```
    Mac OS X type, as retrieved with getNativeWindowType(boolean)
    
    See Also:
    Constant Field Values
  - TYPE_AWT
```
public static final String TYPE_AWT
```
    Generic AWT type, as retrieved with getNativeWindowType(boolean)
    
    See Also:
    Constant Field Values
  - TYPE_DEFAULT
```
public static final String TYPE_DEFAULT
```
    Generic DEFAULT type, where platform implementation don't care, as retrieved with getNativeWindowType(boolean)
    
    See Also:
    Constant Field Values
  - X11JAWTToolkitLockClassName
```
public static final String X11JAWTToolkitLockClassName
```
    See Also:
    Constant Field Values
  - X11ToolkitLockClassName
```
public static final String X11ToolkitLockClassName
```
    See Also:
    Constant Field Values
- Method Detail
  - initSingleton
```
public static void initSingleton(boolean firstUIActionOnProcess)
```
    Static one time initialization of this factory.
    This initialization method must be called once by the program or utilizing modules!
    The parameter firstUIActionOnProcess has an impact on concurrent locking:
    - getDefaultToolkitLock()
    - getDefaultToolkitLock(type)
    - createDefaultToolkitLock(type, dpyHandle)
    - createDefaultToolkitLockNoAWT(type, dpyHandle)
    Parameters:
    firstUIActionOnProcess - Should be true if called before the first UI action of the running program, otherwise false.
  - shutdown
```
public static void shutdown()
```
  - isFirstUIActionOnProcess
```
public static boolean isFirstUIActionOnProcess()
```
    Returns:
    true if initialized with initSingleton(firstUIActionOnProcess==true), otherwise false.
  - requiresToolkitLock
```
public static boolean requiresToolkitLock()
```
    Returns:
    true if the underlying toolkit requires locking, otherwise false.
  - isAWTAvailable
```
public static boolean isAWTAvailable()
```
    Returns:
    true if not headless, AWT Component and NativeWindow's AWT part available
  - getNativeWindowType
```
public static String getNativeWindowType(boolean useCustom)
```
    Parameters:
    useCustom - if false return the native value, if true return a custom value if set, otherwise fallback to the native value.
    
    Returns:
    a define native window type, like TYPE_X11, ..
  - setDefaultFactory
```
public static void setDefaultFactory(NativeWindowFactory factory)
```
    Sets the default NativeWindowFactory.
  - getDefaultFactory
```
public static NativeWindowFactory getDefaultFactory()
```
    Gets the default NativeWindowFactory.
  - getDefaultToolkitLock
```
public static ToolkitLock getDefaultToolkitLock()
```
    Provides the system default ToolkitLock, a singleton instance.
    
    See Also:
    getDefaultToolkitLock(java.lang.String)
  - getDefaultToolkitLock
```
public static ToolkitLock getDefaultToolkitLock(String type)
```
    Provides the default ToolkitLock for type, a singleton instance.
    - If initSingleton( firstUIActionOnProcess := false )
    - Otherwise return getNullToolkitLock()
  - getAWTToolkitLock
```
public static ToolkitLock getAWTToolkitLock()
```
    Returns the AWT Toolkit (JAWT based) if isAWTAvailable, otherwise null.
  - getNullToolkitLock
```
public static ToolkitLock getNullToolkitLock()
```
  - createDefaultToolkitLock
```
public static ToolkitLock createDefaultToolkitLock(String type,
                                   long deviceHandle)
```
    Creates the default ToolkitLock for type and deviceHandle.
    - If initSingleton( firstUIActionOnProcess := false )
    - Otherwise return NullToolkitLock
  - createDefaultToolkitLock
```
public static ToolkitLock createDefaultToolkitLock(String type,
                                   String sharedType,
                                   long deviceHandle)
```
    Creates the default ToolkitLock for type and deviceHandle.
    - If initSingleton( firstUIActionOnProcess := false )
    - Otherwise return NullToolkitLock
  - getFactory
```
public static NativeWindowFactory getFactory(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.
    
    Throws:
    
    IllegalArgumentException
  - getNativeWindow
```
public static NativeWindow getNativeWindow(Object winObj,
                           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. javax.media.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.
    
    Throws:
    
    IllegalArgumentException - if the given window object could not be handled by any of the registered NativeWindowFactory instances
    
    NativeWindowException
    See Also:
    javax.media.nativewindow.GraphicsConfigurationFactory#chooseGraphicsConfiguration(Capabilities, CapabilitiesChooser, AbstractGraphicsScreen)
  - getOffscreenLayerSurface
```
public static OffscreenLayerSurface getOffscreenLayerSurface(NativeSurface surface,
                                             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 - The surface to query.
    ifEnabled - If true, only return the enabled OffscreenLayerSurface, see OffscreenLayerOption.isOffscreenLayerSurfaceEnabled().
    
    Returns:
  - isNativeVisualIDValidForProcessing
```
public static boolean isNativeVisualIDValidForProcessing(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.

Class NativeWindowFactory

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_EGL

TYPE_WINDOWS

TYPE_X11

TYPE_ANDROID

TYPE_MACOSX

TYPE_AWT

TYPE_DEFAULT

X11JAWTToolkitLockClassName

X11ToolkitLockClassName

Method Detail

initSingleton

shutdown

isFirstUIActionOnProcess

requiresToolkitLock

isAWTAvailable

getNativeWindowType

setDefaultFactory

getDefaultFactory

getDefaultToolkitLock

getDefaultToolkitLock

getAWTToolkitLock

getNullToolkitLock

createDefaultToolkitLock

createDefaultToolkitLock

getFactory

getNativeWindow

getOffscreenLayerSurface

isNativeVisualIDValidForProcessing