Package org.lwjgl.nuklear

Class 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 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

    • Field Summary

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

      • Fields inherited from interface org.lwjgl.system.Pointer

        BITS32, BITS64, POINTER_SHIFT, POINTER_SIZE

    • Constructor Summary

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

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

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