NkImage (LWJGL 3.2.4 SNAPSHOT

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

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

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

Layout


 struct nk_image {
     nk_handle handle;
     unsigned short w;
     unsigned short h;
     unsigned short region[4];
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`H` The struct member offsets.
`static int`	`HANDLE` The struct member offsets.
`static int`	`REGION` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`W` 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

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

Constructors
Constructor and Description
`NkImage(java.nio.ByteBuffer container)` Creates a `NkImage` 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 NkImage`	`calloc()` Returns a new `NkImage` instance allocated with `memCalloc`.
`static NkImage.Buffer`	`calloc(int capacity)` Returns a new `NkImage.Buffer` instance allocated with `memCalloc`.
`static NkImage`	`callocStack()` Returns a new `NkImage` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static NkImage.Buffer`	`callocStack(int capacity)` Returns a new `NkImage.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static NkImage.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `NkImage.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static NkImage`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `NkImage` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static NkImage`	`create()` Returns a new `NkImage` instance allocated with `BufferUtils`.
`static NkImage.Buffer`	`create(int capacity)` Returns a new `NkImage.Buffer` instance allocated with `BufferUtils`.
`static NkImage`	`create(long address)` Returns a new `NkImage` instance for the specified memory address.
`static NkImage.Buffer`	`create(long address, int capacity)` Create a `NkImage.Buffer` instance at the specified memory.
`static NkImage`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static NkImage.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`short`	`h()` Returns the value of the `h` field.
`NkImage`	`h(short value)` Sets the specified value to the `h` field.
`NkHandle`	`handle()` Returns a `NkHandle` view of the `handle` field.
`NkImage`	`handle(java.util.function.Consumer<NkHandle> consumer)` Passes the `handle` field to the specified `Consumer`.
`NkImage`	`handle(NkHandle value)` Copies the specified `NkHandle` to the `handle` field.
`static NkImage`	`malloc()` Returns a new `NkImage` instance allocated with `memAlloc`.
`static NkImage.Buffer`	`malloc(int capacity)` Returns a new `NkImage.Buffer` instance allocated with `memAlloc`.
`static NkImage`	`mallocStack()` Returns a new `NkImage` instance allocated on the thread-local `MemoryStack`.
`static NkImage.Buffer`	`mallocStack(int capacity)` Returns a new `NkImage.Buffer` instance allocated on the thread-local `MemoryStack`.
`static NkImage.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `NkImage.Buffer` instance allocated on the specified `MemoryStack`.
`static NkImage`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `NkImage` instance allocated on the specified `MemoryStack`.
`static short`	`nh(long struct)` Unsafe version of `h()`.
`static void`	`nh(long struct, short value)` Unsafe version of `h`.
`static NkHandle`	`nhandle(long struct)` Unsafe version of `handle()`.
`static void`	`nhandle(long struct, NkHandle value)` Unsafe version of `handle`.
`static java.nio.ShortBuffer`	`nregion(long struct)` Unsafe version of `region()`.
`static short`	`nregion(long struct, int index)` Unsafe version of `region`.
`static void`	`nregion(long struct, int index, short value)` Unsafe version of `region`.
`static void`	`nregion(long struct, java.nio.ShortBuffer value)` Unsafe version of `region`.
`static short`	`nw(long struct)` Unsafe version of `w()`.
`static void`	`nw(long struct, short value)` Unsafe version of `w`.
`java.nio.ShortBuffer`	`region()` Returns a `ShortBuffer` view of the `region` field.
`short`	`region(int index)` Returns the value at the specified index of the `region` field.
`NkImage`	`region(int index, short value)` Sets the specified value at the specified index of the `region` field.
`NkImage`	`region(java.nio.ShortBuffer value)` Copies the specified `ShortBuffer` to the `region` field.
`NkImage`	`set(NkHandle handle, short w, short h, java.nio.ShortBuffer region)` Initializes this struct with the specified values.
`NkImage`	`set(NkImage src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`short`	`w()` Returns the value of the `w` field.
`NkImage`	`w(short value)` Sets the specified value to the `w` 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.
  - HANDLE
```
public static final int HANDLE
```
    The struct member offsets.
  - W
```
public static final int W
```
    The struct member offsets.
  - H
```
public static final int H
```
    The struct member offsets.
  - REGION
```
public static final int REGION
```
    The struct member offsets.
- Constructor Detail
  - NkImage
```
public NkImage(java.nio.ByteBuffer container)
```
    Creates a NkImage 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
  - handle
```
public NkHandle handle()
```
    Returns a NkHandle view of the handle field.
  - w
```
public short w()
```
    Returns the value of the w field.
  - h
```
public short h()
```
    Returns the value of the h field.
  - region
```
public java.nio.ShortBuffer region()
```
    Returns a ShortBuffer view of the region field.
  - region
```
public short region(int index)
```
    Returns the value at the specified index of the region field.
  - handle
```
public NkImage handle(NkHandle value)
```
    Copies the specified NkHandle to the handle field.
  - handle
```
public NkImage handle(java.util.function.Consumer<NkHandle> consumer)
```
    Passes the handle field to the specified Consumer.
  - w
```
public NkImage w(short value)
```
    Sets the specified value to the w field.
  - h
```
public NkImage h(short value)
```
    Sets the specified value to the h field.
  - region
```
public NkImage region(java.nio.ShortBuffer value)
```
    Copies the specified ShortBuffer to the region field.
  - region
```
public NkImage region(int index,
                      short value)
```
    Sets the specified value at the specified index of the region field.
  - set
```
public NkImage set(NkHandle handle,
                   short w,
                   short h,
                   java.nio.ShortBuffer region)
```
    Initializes this struct with the specified values.
  - set
```
public NkImage set(NkImage src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static NkImage malloc()
```
    Returns a new NkImage instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static NkImage calloc()
```
    Returns a new NkImage instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static NkImage create()
```
    Returns a new NkImage instance allocated with BufferUtils.
  - create
```
public static NkImage create(long address)
```
    Returns a new NkImage instance for the specified memory address.
  - createSafe
```
@Nullable
public static NkImage createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static NkImage.Buffer malloc(int capacity)
```
    Returns a new NkImage.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static NkImage.Buffer calloc(int capacity)
```
    Returns a new NkImage.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static NkImage.Buffer create(int capacity)
```
    Returns a new NkImage.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static NkImage.Buffer create(long address,
                                    int capacity)
```
    Create a NkImage.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static NkImage.Buffer createSafe(long address,
                                                  int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static NkImage mallocStack()
```
    Returns a new NkImage instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static NkImage callocStack()
```
    Returns a new NkImage instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static NkImage mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkImage instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static NkImage callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkImage instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static NkImage.Buffer mallocStack(int capacity)
```
    Returns a new NkImage.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static NkImage.Buffer callocStack(int capacity)
```
    Returns a new NkImage.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static NkImage.Buffer mallocStack(int capacity,
                                         org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkImage.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static NkImage.Buffer callocStack(int capacity,
                                         org.lwjgl.system.MemoryStack stack)
```
    Returns a new NkImage.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
  - nhandle
```
public static NkHandle nhandle(long struct)
```
    Unsafe version of handle().
  - nw
```
public static short nw(long struct)
```
    Unsafe version of w().
  - nh
```
public static short nh(long struct)
```
    Unsafe version of h().
  - nregion
```
public static java.nio.ShortBuffer nregion(long struct)
```
    Unsafe version of region().
  - nregion
```
public static short nregion(long struct,
                            int index)
```
    Unsafe version of region.
  - nhandle
```
public static void nhandle(long struct,
                           NkHandle value)
```
    Unsafe version of handle.
  - nw
```
public static void nw(long struct,
                      short value)
```
    Unsafe version of w.
  - nh
```
public static void nh(long struct,
                      short value)
```
    Unsafe version of h.
  - nregion
```
public static void nregion(long struct,
                           java.nio.ShortBuffer value)
```
    Unsafe version of region.
  - nregion
```
public static void nregion(long struct,
                           int index,
                           short value)
```
    Unsafe version of region.

Class NkImage

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

HANDLE

W

H

REGION

Constructor Detail

NkImage

Method Detail

sizeof

handle

w

h

region

region

handle

handle

w

h

region

region

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nhandle

nw

nh

nregion

nregion

nhandle

nw

nh

nregion

nregion