NkAllocator (LWJGL 3.2.4 SNAPSHOT

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

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

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

Layout


 struct nk_allocator {
     nk_handle userdata;
     nk_plugin_alloc alloc;
     nk_plugin_free mfree;
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NkAllocator.Buffer
An array of NkAllocator 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`	`NkAllocator.Buffer` An array of `NkAllocator` structs.

Field Summary

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

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

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`NkAllocator(java.nio.ByteBuffer container)` Creates a `NkAllocator` 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
`NkPluginAlloc`	`alloc()` Returns the value of the `alloc` field.
`NkAllocator`	`alloc(NkPluginAllocI value)` Sets the specified value to the `alloc` field.
`static NkAllocator`	`calloc()` Returns a new `NkAllocator` instance allocated with `memCalloc`.
`static NkAllocator.Buffer`	`calloc(int capacity)` Returns a new `NkAllocator.Buffer` instance allocated with `memCalloc`.
`static NkAllocator`	`callocStack()` Returns a new `NkAllocator` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static NkAllocator.Buffer`	`callocStack(int capacity)` Returns a new `NkAllocator.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static NkAllocator.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `NkAllocator.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static NkAllocator`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `NkAllocator` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static NkAllocator`	`create()` Returns a new `NkAllocator` instance allocated with `BufferUtils`.
`static NkAllocator.Buffer`	`create(int capacity)` Returns a new `NkAllocator.Buffer` instance allocated with `BufferUtils`.
`static NkAllocator`	`create(long address)` Returns a new `NkAllocator` instance for the specified memory address.
`static NkAllocator.Buffer`	`create(long address, int capacity)` Create a `NkAllocator.Buffer` instance at the specified memory.
`static NkAllocator`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static NkAllocator.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static NkAllocator`	`malloc()` Returns a new `NkAllocator` instance allocated with `memAlloc`.
`static NkAllocator.Buffer`	`malloc(int capacity)` Returns a new `NkAllocator.Buffer` instance allocated with `memAlloc`.
`static NkAllocator`	`mallocStack()` Returns a new `NkAllocator` instance allocated on the thread-local `MemoryStack`.
`static NkAllocator.Buffer`	`mallocStack(int capacity)` Returns a new `NkAllocator.Buffer` instance allocated on the thread-local `MemoryStack`.
`static NkAllocator.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `NkAllocator.Buffer` instance allocated on the specified `MemoryStack`.
`static NkAllocator`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `NkAllocator` instance allocated on the specified `MemoryStack`.
`NkPluginFree`	`mfree()` Returns the value of the `mfree` field.
`NkAllocator`	`mfree(NkPluginFreeI value)` Sets the specified value to the `mfree` field.
`static NkPluginAlloc`	`nalloc(long struct)` Unsafe version of `alloc()`.
`static void`	`nalloc(long struct, NkPluginAllocI value)` Unsafe version of `alloc`.
`static NkPluginFree`	`nmfree(long struct)` Unsafe version of `mfree()`.
`static void`	`nmfree(long struct, NkPluginFreeI value)` Unsafe version of `mfree`.
`static NkHandle`	`nuserdata(long struct)` Unsafe version of `userdata()`.
`static void`	`nuserdata(long struct, NkHandle value)` Unsafe version of `userdata`.
`NkAllocator`	`set(NkAllocator src)` Copies the specified struct data to this struct.
`NkAllocator`	`set(NkHandle userdata, NkPluginAllocI alloc, NkPluginFreeI mfree)` Initializes this struct with the specified values.
`int`	`sizeof()`
`NkHandle`	`userdata()` Returns a `NkHandle` view of the `userdata` field.
`NkAllocator`	`userdata(java.util.function.Consumer<NkHandle> consumer)` Passes the `userdata` field to the specified `Consumer`.
`NkAllocator`	`userdata(NkHandle value)` Copies the specified `NkHandle` to the `userdata` field.

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.
  - USERDATA
```
public static final int USERDATA
```
    The struct member offsets.
  - ALLOC
```
public static final int ALLOC
```
    The struct member offsets.
  - MFREE
```
public static final int MFREE
```
    The struct member offsets.
- Constructor Detail
  - NkAllocator
```
public NkAllocator(java.nio.ByteBuffer container)
```
    Creates a NkAllocator 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
  - userdata
```
public NkHandle userdata()
```
    Returns a NkHandle view of the userdata field.
  - alloc
```
@Nullable
public NkPluginAlloc alloc()
```
    Returns the value of the alloc field.
  - mfree
```
@Nullable
public NkPluginFree mfree()
```
    Returns the value of the mfree field.
  - userdata
```
public NkAllocator userdata(NkHandle value)
```
    Copies the specified NkHandle to the userdata field.
  - userdata
```
public NkAllocator userdata(java.util.function.Consumer<NkHandle> consumer)
```
    Passes the userdata field to the specified Consumer.
  - alloc
```
public NkAllocator alloc(@Nullable
                         NkPluginAllocI value)
```
    Sets the specified value to the alloc field.
  - mfree
```
public NkAllocator mfree(@Nullable
                         NkPluginFreeI value)
```
    Sets the specified value to the mfree field.
  - set
```
public NkAllocator set(NkHandle userdata,
                       NkPluginAllocI alloc,
                       NkPluginFreeI mfree)
```
    Initializes this struct with the specified values.
  - set
```
public NkAllocator set(NkAllocator src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static NkAllocator malloc()
```
    Returns a new NkAllocator instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static NkAllocator calloc()
```
    Returns a new NkAllocator instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static NkAllocator create()
```
    Returns a new NkAllocator instance allocated with BufferUtils.
  - create
```
public static NkAllocator create(long address)
```
    Returns a new NkAllocator instance for the specified memory address.
  - createSafe
```
@Nullable
public static NkAllocator createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static NkAllocator.Buffer malloc(int capacity)
```
    Returns a new NkAllocator.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static NkAllocator.Buffer calloc(int capacity)
```
    Returns a new NkAllocator.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static NkAllocator.Buffer create(int capacity)
```
    Returns a new NkAllocator.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static NkAllocator.Buffer create(long address,
                                        int capacity)
```
    Create a NkAllocator.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static NkAllocator.Buffer createSafe(long address,
                                                      int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static NkAllocator mallocStack()
```
    Returns a new NkAllocator instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static NkAllocator callocStack()
```
    Returns a new NkAllocator instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static NkAllocator mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkAllocator instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static NkAllocator callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkAllocator instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static NkAllocator.Buffer mallocStack(int capacity)
```
    Returns a new NkAllocator.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static NkAllocator.Buffer callocStack(int capacity)
```
    Returns a new NkAllocator.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static NkAllocator.Buffer mallocStack(int capacity,
                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkAllocator.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static NkAllocator.Buffer callocStack(int capacity,
                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkAllocator.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
  - nuserdata
```
public static NkHandle nuserdata(long struct)
```
    Unsafe version of userdata().
  - nalloc
```
@Nullable
public static NkPluginAlloc nalloc(long struct)
```
    Unsafe version of alloc().
  - nmfree
```
@Nullable
public static NkPluginFree nmfree(long struct)
```
    Unsafe version of mfree().
  - nuserdata
```
public static void nuserdata(long struct,
                             NkHandle value)
```
    Unsafe version of userdata.
  - nalloc
```
public static void nalloc(long struct,
                          @Nullable
                          NkPluginAllocI value)
```
    Unsafe version of alloc.
  - nmfree
```
public static void nmfree(long struct,
                          @Nullable
                          NkPluginFreeI value)
```
    Unsafe version of mfree.

Class NkAllocator

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

USERDATA

ALLOC

MFREE

Constructor Detail

NkAllocator

Method Detail

sizeof

userdata

alloc

mfree

userdata

userdata

alloc

mfree

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nuserdata

nalloc

nmfree

nuserdata

nalloc

nmfree