Package org.lwjgl.nuklear

Class NkStr

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

 struct nk_str {
     {@link NkBuffer struct nk_buffer} buffer;
     int len;
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • BUFFER

      public static final int BUFFER
      The struct member offsets.

    • LEN

      public static final int LEN
      The struct member offsets.

  • Constructor Details

    • NkStr

      public NkStr(ByteBuffer container)
      Creates a NkStr 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<NkStr>

    • buffer

      public NkBuffer buffer()
      Returns:
      a NkBuffer view of the buffer field.

    • len

      public int len()
      Returns:
      the value of the len field.

    • malloc

      public static NkStr malloc()
      Returns a new NkStr instance allocated with memAlloc. The instance must be explicitly freed.

    • calloc

      public static NkStr calloc()
      Returns a new NkStr instance allocated with memCalloc. The instance must be explicitly freed.

    • create

      public static NkStr create()
      Returns a new NkStr instance allocated with BufferUtils.

    • create

      public static NkStr create(long address)
      Returns a new NkStr instance for the specified memory address.

    • createSafe

      public static @Nullable NkStr createSafe(long address)
      Like create, but returns null if address is NULL.

    • malloc

      public static NkStr.Buffer malloc(int capacity)
      Returns a new NkStr.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static NkStr.Buffer calloc(int capacity)
      Returns a new NkStr.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static NkStr.Buffer create(int capacity)
      Returns a new NkStr.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static NkStr.Buffer create(long address, int capacity)
      Create a NkStr.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

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

    • mallocStack

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

    • callocStack

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

    • mallocStack

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

    • callocStack

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

    • mallocStack

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

    • callocStack

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

    • mallocStack

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

    • callocStack

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

      public static NkStr.Buffer calloc(int capacity, MemoryStack stack)
      Returns a new NkStr.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

    • nbuffer

      public static NkBuffer nbuffer(long struct)
      Unsafe version of buffer().

    • nlen

      public static int nlen(long struct)
      Unsafe version of len().