Package org.lwjgl.nuklear

Class NkHandle

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<NkHandle>
org.lwjgl.nuklear.NkHandle
All Implemented Interfaces:
AutoCloseable, NativeResource, Pointer
public class NkHandle extends Struct<NkHandle> implements NativeResource

 union nk_handle {
     void * ptr;
     int id;
 }

  • Field Details

    • 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 Details

    • NkHandle

      public NkHandle(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 Details

    • sizeof

      public int sizeof()
      Description copied from class: Struct
      Returns sizeof(struct).
      Specified by:
      sizeof in class Struct<NkHandle>

    • 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

      public static @Nullable 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

      public static @Nullable NkHandle.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • mallocStack

      @Deprecated public static NkHandle mallocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static NkHandle callocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static NkHandle mallocStack(MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static NkHandle callocStack(MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static NkHandle.Buffer mallocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static NkHandle.Buffer callocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • mallocStack

      @Deprecated public static NkHandle.Buffer mallocStack(int capacity, MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static NkHandle.Buffer callocStack(int capacity, MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • malloc

      public static NkHandle malloc(MemoryStack stack)
      Returns a new NkHandle instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

      public static NkHandle calloc(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

    • malloc

      public static NkHandle.Buffer malloc(int capacity, MemoryStack stack)
      Returns a new NkHandle.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

      public static NkHandle.Buffer calloc(int capacity, MemoryStack stack)
      Returns a new NkHandle.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • 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.