JAWTFunctions (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.jawt.JAWTFunctions

```
public class JAWTFunctions
extends java.lang.Object
```
Bindings to the AWT native interface (jawt.h).
The AWT native interface allows a native C or C++ application a means by which to access native structures in AWT. This is to facilitate moving legacy C and C++ applications to Java and to target the needs of the community who, at present, wish to do their own native rendering to canvases for performance reasons. Standard extensions such as Java3D also require a means to access the underlying native data structures of AWT.

AWT Native Drawing Surface (JAWT_DrawingSurface)

For each platform, there is a native drawing surface structure. This platform-specific structure can be found in jawt_md.h. See JAWTX11DrawingSurfaceInfo for the Linux platform, JAWTWin32DrawingSurfaceInfo for the Windows platform and MACOSX_USE_CALAYER for the OS X platform.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class JAWTFunctions.Functions
Contains the function pointers loaded from the jawt SharedLibrary.

Nested Classes
Modifier and Type	Class and Description
`static class`	`JAWTFunctions.Functions` Contains the function pointers loaded from the jawt `SharedLibrary`.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`JAWT_LOCK_BOUNDS_CHANGED` Bitmask values returned by `Lock()`.
`static int`	`JAWT_LOCK_CLIP_CHANGED` Bitmask values returned by `Lock()`.
`static int`	`JAWT_LOCK_ERROR` Bitmask values returned by `Lock()`.
`static int`	`JAWT_LOCK_SURFACE_CHANGED` Bitmask values returned by `Lock()`.
`static int`	`JAWT_MACOSX_USE_CALAYER` When calling `GetAWT` with a JAWT version less than 1.7, you must pass this flag or you will not be able to get a valid drawing surface and `GetAWT` will return false.
`static int`	`JAWT_VERSION_1_3` JAWT versions.
`static int`	`JAWT_VERSION_1_4` JAWT versions.
`static int`	`JAWT_VERSION_1_7` JAWT versions.
`static int`	`JAWT_VERSION_9` JAWT versions.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static org.lwjgl.system.SharedLibrary`	`getLibrary()` Returns the jawt `SharedLibrary`.
`static java.awt.Frame`	`JAWT_CreateEmbeddedFrame(long platformInfo, long __functionAddress)` Creates a `Frame` placed in a native container.
`static void`	`JAWT_DrawingSurface_FreeDrawingSurfaceInfo(JAWTDrawingSurfaceInfo dsi, long __functionAddress)` Frees the drawing surface info.
`static JAWTDrawingSurfaceInfo`	`JAWT_DrawingSurface_GetDrawingSurfaceInfo(JAWTDrawingSurface ds, long __functionAddress)` Returns the drawing surface info.
`static int`	`JAWT_DrawingSurface_Lock(JAWTDrawingSurface ds, long __functionAddress)` Locks the surface of the target component for native rendering.
`static void`	`JAWT_DrawingSurface_Unlock(JAWTDrawingSurface ds, long __functionAddress)` Unlocks the drawing surface of the target component for native rendering.
`static void`	`JAWT_FreeDrawingSurface(JAWTDrawingSurface ds, long __functionAddress)` Frees the drawing surface allocated in `GetDrawingSurface`.
`static boolean`	`JAWT_GetAWT(JAWT awt)` Returns the AWT native structure.
`static java.awt.Component`	`JAWT_GetComponent(long platformInfo, long __functionAddress)` Returns a reference to a `Component` from a native platform handle.
`static JAWTDrawingSurface`	`JAWT_GetDrawingSurface(java.lang.Object target, long __functionAddress)` Returns a drawing surface from a target `jobject`.
`static void`	`JAWT_Lock(long __functionAddress)` Locks the entire AWT for synchronization purposes.
`static void`	`JAWT_SetBounds(java.awt.Frame embeddedFrame, int x, int y, int w, int h, long __functionAddress)` Moves and resizes the embedded frame.
`static void`	`JAWT_SynthesizeWindowActivation(java.awt.Frame embeddedFrame, boolean doActivate, long __functionAddress)` Synthesizes a native message to activate or deactivate an `EmbeddedFrame` window depending on the value of parameter `doActivate`.
`static void`	`JAWT_Unlock(long __functionAddress)` Unlocks the entire AWT for synchronization purposes.
`static java.awt.Frame`	`nJAWT_CreateEmbeddedFrame(long platformInfo, long __functionAddress)` Unsafe version of: `CreateEmbeddedFrame`
`static void`	`nJAWT_DrawingSurface_FreeDrawingSurfaceInfo(long dsi, long __functionAddress)` Unsafe version of: `DrawingSurface_FreeDrawingSurfaceInfo`
`static long`	`nJAWT_DrawingSurface_GetDrawingSurfaceInfo(long ds, long __functionAddress)` Unsafe version of: `DrawingSurface_GetDrawingSurfaceInfo`
`static int`	`nJAWT_DrawingSurface_Lock(long ds, long __functionAddress)` Unsafe version of: `DrawingSurface_Lock`
`static void`	`nJAWT_DrawingSurface_Unlock(long ds, long __functionAddress)` Unsafe version of: `DrawingSurface_Unlock`
`static void`	`nJAWT_FreeDrawingSurface(long ds, long __functionAddress)` Unsafe version of: `FreeDrawingSurface`
`static boolean`	`nJAWT_GetAWT(long awt)` Unsafe version of: `GetAWT`
`static boolean`	`nJAWT_GetAWT(long awt, long __functionAddress)` Unsafe version of: `GetAWT`
`static java.awt.Component`	`nJAWT_GetComponent(long platformInfo, long __functionAddress)` Unsafe version of: `GetComponent`
`static long`	`nJAWT_GetDrawingSurface(java.lang.Object target, long __functionAddress)` Unsafe version of: `GetDrawingSurface`
`static void`	`nJAWT_Lock(long __functionAddress)` Unsafe version of: `Lock`
`static void`	`nJAWT_SetBounds(java.awt.Frame embeddedFrame, int x, int y, int w, int h, long __functionAddress)` Unsafe version of: `SetBounds`
`static void`	`nJAWT_SynthesizeWindowActivation(java.awt.Frame embeddedFrame, boolean doActivate, long __functionAddress)` Unsafe version of: `SynthesizeWindowActivation`
`static void`	`nJAWT_Unlock(long __functionAddress)` Unsafe version of: `Unlock`

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

- Field Detail
  - JAWT_VERSION_1_3
```
public static final int JAWT_VERSION_1_3
```
    JAWT versions.
    
    See Also:
    
    Constant Field Values
  - JAWT_VERSION_1_4
```
public static final int JAWT_VERSION_1_4
```
    JAWT versions.
    
    See Also:
    
    Constant Field Values
  - JAWT_VERSION_1_7
```
public static final int JAWT_VERSION_1_7
```
    JAWT versions.
    
    See Also:
    
    Constant Field Values
  - JAWT_VERSION_9
```
public static final int JAWT_VERSION_9
```
    JAWT versions.
    
    See Also:
    
    Constant Field Values
  - JAWT_MACOSX_USE_CALAYER
```
public static final int JAWT_MACOSX_USE_CALAYER
```
    When calling GetAWT with a JAWT version less than 1.7, you must pass this flag or you will not be able to get a valid drawing surface and GetAWT will return false. This is to maintain compatibility with applications that used the interface with Java 6 which had multiple rendering models. This flag is not necessary when JAWT version 1.7 or greater is used as this is the only supported rendering mode.
    When the native Cocoa toolkit is in use, the pointer stored in JAWT_DrawingSurfaceInfo->platformInfo points to a NSObject that conforms to the JAWT_SurfaceLayers protocol. Setting the layer property of this object will cause the specified layer to be overlaid on the Component's rectangle. If the window the Component belongs to has a CALayer attached to it, this layer will be accessible via the windowLayer property.
```
 @protocol JAWT_SurfaceLayers
     @property (readwrite, retain) CALayer *layer;
     @property (readonly) CALayer *windowLayer;
 @end
```
    See Also:
    
    Constant Field Values
  - JAWT_LOCK_ERROR
```
public static final int JAWT_LOCK_ERROR
```
    Bitmask values returned by Lock().
    
    See Also:
    
    Constant Field Values
  - JAWT_LOCK_CLIP_CHANGED
```
public static final int JAWT_LOCK_CLIP_CHANGED
```
    Bitmask values returned by Lock().
    
    See Also:
    
    Constant Field Values
  - JAWT_LOCK_BOUNDS_CHANGED
```
public static final int JAWT_LOCK_BOUNDS_CHANGED
```
    Bitmask values returned by Lock().
    
    See Also:
    
    Constant Field Values
  - JAWT_LOCK_SURFACE_CHANGED
```
public static final int JAWT_LOCK_SURFACE_CHANGED
```
    Bitmask values returned by Lock().
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getLibrary
```
public static org.lwjgl.system.SharedLibrary getLibrary()
```
    Returns the jawt SharedLibrary.
  - nJAWT_GetAWT
```
public static boolean nJAWT_GetAWT(long awt,
                                   long __functionAddress)
```
    Unsafe version of: GetAWT
  - nJAWT_GetAWT
```
public static boolean nJAWT_GetAWT(long awt)
```
    Unsafe version of: GetAWT
  - JAWT_GetAWT
```
public static boolean JAWT_GetAWT(JAWT awt)
```
    Returns the AWT native structure.
    
    Parameters:
    
    awt - the target JAWT struct
    
    Returns:
    
    JNI_FALSE if an error occurs
  - nJAWT_DrawingSurface_Lock
```
public static int nJAWT_DrawingSurface_Lock(long ds,
                                            long __functionAddress)
```
    Unsafe version of: DrawingSurface_Lock
  - JAWT_DrawingSurface_Lock
```
public static int JAWT_DrawingSurface_Lock(JAWTDrawingSurface ds,
                                           long __functionAddress)
```
    Locks the surface of the target component for native rendering. When finished drawing, the surface must be unlocked with DrawingSurface_Unlock.
    Parameters:
    
    ds - the surface to lock
    
    __functionAddress - the function address
    
    Returns:
    a bitmask with one or more of the following values:
    
    LOCK_ERROR - When an error has occurred and the surface could not be locked.
    
    LOCK_CLIP_CHANGED - When the clip region has changed.
    
    LOCK_BOUNDS_CHANGED - When the bounds of the surface have changed.
    
    LOCK_SURFACE_CHANGED - When the surface itself has changed
  - nJAWT_DrawingSurface_GetDrawingSurfaceInfo
```
public static long nJAWT_DrawingSurface_GetDrawingSurfaceInfo(long ds,
                                                              long __functionAddress)
```
    Unsafe version of: DrawingSurface_GetDrawingSurfaceInfo
  - JAWT_DrawingSurface_GetDrawingSurfaceInfo
```
@Nullable
public static JAWTDrawingSurfaceInfo JAWT_DrawingSurface_GetDrawingSurfaceInfo(JAWTDrawingSurface ds,
                                                                                         long __functionAddress)
```
    Returns the drawing surface info.
    The value returned may be cached, but the values may change if additional calls to DrawingSurface_Lock or DrawingSurface_Unlock are made. DrawingSurface_Lock must be called before this can return a valid value.
    
    When finished with the returned value, DrawingSurface_FreeDrawingSurfaceInfo must be called.
    
    Parameters:
    
    ds - the JAWTDrawingSurface to free
    
    __functionAddress - the function address
    
    Returns:
    
    NULL if an error has occurred.
  - nJAWT_DrawingSurface_FreeDrawingSurfaceInfo
```
public static void nJAWT_DrawingSurface_FreeDrawingSurfaceInfo(long dsi,
                                                               long __functionAddress)
```
    Unsafe version of: DrawingSurface_FreeDrawingSurfaceInfo
  - JAWT_DrawingSurface_FreeDrawingSurfaceInfo
```
public static void JAWT_DrawingSurface_FreeDrawingSurfaceInfo(JAWTDrawingSurfaceInfo dsi,
                                                              long __functionAddress)
```
    Frees the drawing surface info.
    
    Parameters:
    
    dsi - the JAWTDrawingSurfaceInfo to free
    
    __functionAddress - the function address
  - nJAWT_DrawingSurface_Unlock
```
public static void nJAWT_DrawingSurface_Unlock(long ds,
                                               long __functionAddress)
```
    Unsafe version of: DrawingSurface_Unlock
  - JAWT_DrawingSurface_Unlock
```
public static void JAWT_DrawingSurface_Unlock(JAWTDrawingSurface ds,
                                              long __functionAddress)
```
    Unlocks the drawing surface of the target component for native rendering.
    
    Parameters:
    
    ds - the surface to unlock
    
    __functionAddress - the function address
  - nJAWT_GetDrawingSurface
```
public static long nJAWT_GetDrawingSurface(java.lang.Object target,
                                           long __functionAddress)
```
    Unsafe version of: GetDrawingSurface
  - JAWT_GetDrawingSurface
```
@Nullable
public static JAWTDrawingSurface JAWT_GetDrawingSurface(java.lang.Object target,
                                                                  long __functionAddress)
```
    Returns a drawing surface from a target jobject. This value may be cached.
    FreeDrawingSurface must be called when finished with the returned JAWTDrawingSurface.
    
    Parameters:
    
    target - must be a Component (should be a Canvas or Window for native rendering)
    
    __functionAddress - the function address
    
    Returns:
    
    NULL if an error has occurred
  - nJAWT_FreeDrawingSurface
```
public static void nJAWT_FreeDrawingSurface(long ds,
                                            long __functionAddress)
```
    Unsafe version of: FreeDrawingSurface
  - JAWT_FreeDrawingSurface
```
public static void JAWT_FreeDrawingSurface(JAWTDrawingSurface ds,
                                           long __functionAddress)
```
    Frees the drawing surface allocated in GetDrawingSurface.
    
    Parameters:
    
    ds - the JAWTDrawingSurface to free
    
    __functionAddress - the function address
  - nJAWT_Lock
```
public static void nJAWT_Lock(long __functionAddress)
```
    Unsafe version of: Lock
  - JAWT_Lock
```
public static void JAWT_Lock(long __functionAddress)
```
    Locks the entire AWT for synchronization purposes.
    
    Parameters:
    
    __functionAddress - the function address
  - nJAWT_Unlock
```
public static void nJAWT_Unlock(long __functionAddress)
```
    Unsafe version of: Unlock
  - JAWT_Unlock
```
public static void JAWT_Unlock(long __functionAddress)
```
    Unlocks the entire AWT for synchronization purposes.
    
    Parameters:
    
    __functionAddress - the function address
  - nJAWT_GetComponent
```
@Nullable
public static java.awt.Component nJAWT_GetComponent(long platformInfo,
                                                              long __functionAddress)
```
    Unsafe version of: GetComponent
  - JAWT_GetComponent
```
@Nullable
public static java.awt.Component JAWT_GetComponent(long platformInfo,
                                                             long __functionAddress)
```
    Returns a reference to a Component from a native platform handle. On Windows, this corresponds to an HWND; on Solaris and Linux, this is a Drawable. For other platforms, see the appropriate machine-dependent header file for a description. The reference returned by this function is a local reference that is only valid in this environment. This function returns a NULL reference if no component could be found with matching platform information.
    
    Parameters:
    
    platformInfo - the native platform handle
    
    __functionAddress - the function address
  - nJAWT_CreateEmbeddedFrame
```
@Nullable
public static java.awt.Frame nJAWT_CreateEmbeddedFrame(long platformInfo,
                                                                 long __functionAddress)
```
    Unsafe version of: CreateEmbeddedFrame
  - JAWT_CreateEmbeddedFrame
```
@Nullable
public static java.awt.Frame JAWT_CreateEmbeddedFrame(long platformInfo,
                                                                long __functionAddress)
```
    Creates a Frame placed in a native container. Container is referenced by the native platform handle. For example on Windows this corresponds to an HWND. For other platforms, see the appropriate machine-dependent header file for a description. The reference returned by this function is a local reference that is only valid in this environment. This function returns a NULL reference if no frame could be created with matching platform information.
    
    Parameters:
    
    platformInfo - the native platform handle
    
    __functionAddress - the function address
    
    Since:
    
    Java 9
  - nJAWT_SetBounds
```
public static void nJAWT_SetBounds(java.awt.Frame embeddedFrame,
                                   int x,
                                   int y,
                                   int w,
                                   int h,
                                   long __functionAddress)
```
    Unsafe version of: SetBounds
  - JAWT_SetBounds
```
public static void JAWT_SetBounds(java.awt.Frame embeddedFrame,
                                  int x,
                                  int y,
                                  int w,
                                  int h,
                                  long __functionAddress)
```
    Moves and resizes the embedded frame. The new location of the top-left corner is specified by x and y parameters relative to the native parent component. The new size is specified by width and height.
    The embedded frame should be created by CreateEmbeddedFrame method, or this function will not have any effect.
    
    Component.setLocation(int, int) and Component.setBounds(int, int, int, int) for EmbeddedFrame really don't move it within the native parent. These methods always locate the embedded frame at (0, 0) for backward compatibility. To allow moving embedded frames this method was introduced, and it works just the same way as setLocation() and setBounds() for usual, non-embedded components.
    
    Using usual get/setLocation() and get/setBounds() together with this new method is not recommended.
    
    Parameters:
    
    embeddedFrame - the embedded frame
    
    x - the x coordinate
    
    y - the y coordinate
    
    w - the width
    
    h - the height
    
    __functionAddress - the function address
    
    Since:
    
    Java 9
  - nJAWT_SynthesizeWindowActivation
```
public static void nJAWT_SynthesizeWindowActivation(java.awt.Frame embeddedFrame,
                                                    boolean doActivate,
                                                    long __functionAddress)
```
    Unsafe version of: SynthesizeWindowActivation
  - JAWT_SynthesizeWindowActivation
```
public static void JAWT_SynthesizeWindowActivation(java.awt.Frame embeddedFrame,
                                                   boolean doActivate,
                                                   long __functionAddress)
```
    Synthesizes a native message to activate or deactivate an EmbeddedFrame window depending on the value of parameter doActivate.
    The embedded frame should be created by CreateEmbeddedFrame method, or this function will not have any effect.
    
    Parameters:
    
    embeddedFrame - the embedded frame
    
    doActivate - if true activates the window; otherwise, deactivates the window
    
    __functionAddress - the function address
    
    Since:
    
    Java 9

Class JAWTFunctions

AWT Native Drawing Surface (JAWT_DrawingSurface)

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JAWT_VERSION_1_3

JAWT_VERSION_1_4

JAWT_VERSION_1_7

JAWT_VERSION_9

JAWT_MACOSX_USE_CALAYER

JAWT_LOCK_ERROR

JAWT_LOCK_CLIP_CHANGED

JAWT_LOCK_BOUNDS_CHANGED

JAWT_LOCK_SURFACE_CHANGED

Method Detail

getLibrary

nJAWT_GetAWT

nJAWT_GetAWT

JAWT_GetAWT

nJAWT_DrawingSurface_Lock

JAWT_DrawingSurface_Lock

nJAWT_DrawingSurface_GetDrawingSurfaceInfo

JAWT_DrawingSurface_GetDrawingSurfaceInfo

nJAWT_DrawingSurface_FreeDrawingSurfaceInfo

JAWT_DrawingSurface_FreeDrawingSurfaceInfo

nJAWT_DrawingSurface_Unlock

JAWT_DrawingSurface_Unlock

nJAWT_GetDrawingSurface

JAWT_GetDrawingSurface

nJAWT_FreeDrawingSurface

JAWT_FreeDrawingSurface

nJAWT_Lock

JAWT_Lock

nJAWT_Unlock

JAWT_Unlock

nJAWT_GetComponent

JAWT_GetComponent

nJAWT_CreateEmbeddedFrame

JAWT_CreateEmbeddedFrame

nJAWT_SetBounds

JAWT_SetBounds

nJAWT_SynthesizeWindowActivation

JAWT_SynthesizeWindowActivation