NkHandle (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.nuklear.NkHandle

All Implemented Interfaces:: java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class NkHandle
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

Layout


 union nk_handle {
     void * ptr;
     int id;
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NkHandle.Buffer
An array of NkHandle structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`NkHandle.Buffer` An array of `NkHandle` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`ID` The struct member offsets.
`static int`	`PTR` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

NkHandle(java.nio.ByteBuffer container)
Creates a NkHandle instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`NkHandle(java.nio.ByteBuffer container)` Creates a `NkHandle` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static NkHandle`	`calloc()` Returns a new `NkHandle` instance allocated with `memCalloc`.
`static NkHandle.Buffer`	`calloc(int capacity)` Returns a new `NkHandle.Buffer` instance allocated with `memCalloc`.
`static NkHandle`	`callocStack()` Returns a new `NkHandle` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static NkHandle.Buffer`	`callocStack(int capacity)` Returns a new `NkHandle.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static NkHandle.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `NkHandle.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static NkHandle`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `NkHandle` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static NkHandle`	`create()` Returns a new `NkHandle` instance allocated with `BufferUtils`.
`static NkHandle.Buffer`	`create(int capacity)` Returns a new `NkHandle.Buffer` instance allocated with `BufferUtils`.
`static NkHandle`	`create(long address)` Returns a new `NkHandle` instance for the specified memory address.
`static NkHandle.Buffer`	`create(long address, int capacity)` Create a `NkHandle.Buffer` instance at the specified memory.
`static NkHandle`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static NkHandle.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`id()` Returns the value of the `id` field.
`NkHandle`	`id(int value)` Sets the specified value to the `id` field.
`static NkHandle`	`malloc()` Returns a new `NkHandle` instance allocated with `memAlloc`.
`static NkHandle.Buffer`	`malloc(int capacity)` Returns a new `NkHandle.Buffer` instance allocated with `memAlloc`.
`static NkHandle`	`mallocStack()` Returns a new `NkHandle` instance allocated on the thread-local `MemoryStack`.
`static NkHandle.Buffer`	`mallocStack(int capacity)` Returns a new `NkHandle.Buffer` instance allocated on the thread-local `MemoryStack`.
`static NkHandle.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `NkHandle.Buffer` instance allocated on the specified `MemoryStack`.
`static NkHandle`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `NkHandle` instance allocated on the specified `MemoryStack`.
`static int`	`nid(long struct)` Unsafe version of `id()`.
`static void`	`nid(long struct, int value)` Unsafe version of `id`.
`static long`	`nptr(long struct)` Unsafe version of `ptr()`.
`static void`	`nptr(long struct, long value)` Unsafe version of `ptr`.
`long`	`ptr()` Returns the value of the `ptr` field.
`NkHandle`	`ptr(long value)` Sets the specified value to the `ptr` field.
`NkHandle`	`set(NkHandle src)` Copies the specified struct data to this struct.
`int`	`sizeof()`

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

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

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - PTR
```
public static final int PTR
```
    The struct member offsets.
  - ID
```
public static final int ID
```
    The struct member offsets.
- Constructor Detail
  - NkHandle
```
public NkHandle(java.nio.ByteBuffer container)
```
    Creates a NkHandle instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.
    The created instance holds a strong reference to the container object.
- Method Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - ptr
```
public long ptr()
```
    Returns the value of the ptr field.
  - id
```
public int id()
```
    Returns the value of the id field.
  - ptr
```
public NkHandle ptr(long value)
```
    Sets the specified value to the ptr field.
  - id
```
public NkHandle id(int value)
```
    Sets the specified value to the id field.
  - set
```
public NkHandle set(NkHandle src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static NkHandle malloc()
```
    Returns a new NkHandle instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static NkHandle calloc()
```
    Returns a new NkHandle instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static NkHandle create()
```
    Returns a new NkHandle instance allocated with BufferUtils.
  - create
```
public static NkHandle create(long address)
```
    Returns a new NkHandle instance for the specified memory address.
  - createSafe
```
@Nullable
public static NkHandle createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static NkHandle.Buffer malloc(int capacity)
```
    Returns a new NkHandle.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static NkHandle.Buffer calloc(int capacity)
```
    Returns a new NkHandle.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static NkHandle.Buffer create(int capacity)
```
    Returns a new NkHandle.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static NkHandle.Buffer create(long address,
                                     int capacity)
```
    Create a NkHandle.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static NkHandle.Buffer createSafe(long address,
                                                   int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static NkHandle mallocStack()
```
    Returns a new NkHandle instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static NkHandle callocStack()
```
    Returns a new NkHandle instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static NkHandle mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkHandle instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static NkHandle callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkHandle instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static NkHandle.Buffer mallocStack(int capacity)
```
    Returns a new NkHandle.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static NkHandle.Buffer callocStack(int capacity)
```
    Returns a new NkHandle.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static NkHandle.Buffer mallocStack(int capacity,
                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkHandle.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static NkHandle.Buffer callocStack(int capacity,
                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkHandle.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nptr
```
public static long nptr(long struct)
```
    Unsafe version of ptr().
  - nid
```
public static int nid(long struct)
```
    Unsafe version of id().
  - nptr
```
public static void nptr(long struct,
                        long value)
```
    Unsafe version of ptr.
  - nid
```
public static void nid(long struct,
                       int value)
```
    Unsafe version of id.

Class NkHandle

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

PTR

ID

Constructor Detail

NkHandle

Method Detail

sizeof

ptr

id

ptr

id

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nptr

nid

nptr

nid