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, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class NkStr extends org.lwjgl.system.Struct<NkStr> implements org.lwjgl.system.NativeResource
Basic string buffer which is only used in context with the text editor to manage and manipulate dynamic or fixed size string content. This is NOT the default string handling method. The only instance you should have any contact with this API is if you interact with an NkTextEdit object inside one of the copy and paste functions and even there only for more advanced cases.

Layout


 struct nk_str {
     struct nk_buffer buffer;
     int len();
 }

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    NkStr.Buffer
    An array of NkStr structs.

    Nested classes/interfaces inherited from class org.lwjgl.system.Struct

    org.lwjgl.system.Struct.StructValidation

    Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

    org.lwjgl.system.Pointer.Default

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALIGNOF
    The struct alignment in bytes.
    static final int
    BUFFER
    The struct member offsets.
    static final int
    LEN
    The struct member offsets.
    static final int
    SIZEOF
    The struct size in bytes.

    Fields inherited from interface org.lwjgl.system.Pointer

    BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

  • Constructor Summary

    Constructors
    Constructor
    Description
    NkStr(ByteBuffer container)
    Creates a NkStr instance at the current position of the specified ByteBuffer container.

  • Method Summary

    Modifier and Type
    Method
    Description
    NkBuffer
    buffer()
     
    static NkStr
    calloc()
    Returns a new NkStr instance allocated with memCalloc.
    static NkStr.Buffer
    calloc(int capacity)
    Returns a new NkStr.Buffer instance allocated with memCalloc.
    static NkStr.Buffer
    calloc(int capacity, org.lwjgl.system.MemoryStack stack)
    Returns a new NkStr.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    static NkStr
    calloc(org.lwjgl.system.MemoryStack stack)
    Returns a new NkStr instance allocated on the specified MemoryStack and initializes all its bits to zero.
    static NkStr
    callocStack()
    Deprecated.
    static NkStr.Buffer
    callocStack(int capacity)
    Deprecated.
    static NkStr.Buffer
    callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
    Deprecated.
    static NkStr
    callocStack(org.lwjgl.system.MemoryStack stack)
    Deprecated.
    static NkStr
    create()
    Returns a new NkStr instance allocated with BufferUtils.
    static NkStr.Buffer
    create(int capacity)
    Returns a new NkStr.Buffer instance allocated with BufferUtils.
    static NkStr
    create(long address)
    Returns a new NkStr instance for the specified memory address.
    static NkStr.Buffer
    create(long address, int capacity)
    Create a NkStr.Buffer instance at the specified memory.
    static @Nullable NkStr
    createSafe(long address)
    Like create, but returns null if address is NULL.
    static @Nullable NkStr.Buffer
    createSafe(long address, int capacity)
    Like create, but returns null if address is NULL.
    int
    len()
    in codepoints/runes/glyphs
    static NkStr
    malloc()
    Returns a new NkStr instance allocated with memAlloc.
    static NkStr.Buffer
    malloc(int capacity)
    Returns a new NkStr.Buffer instance allocated with memAlloc.
    static NkStr.Buffer
    malloc(int capacity, org.lwjgl.system.MemoryStack stack)
    Returns a new NkStr.Buffer instance allocated on the specified MemoryStack.
    static NkStr
    malloc(org.lwjgl.system.MemoryStack stack)
    Returns a new NkStr instance allocated on the specified MemoryStack.
    static NkStr
    mallocStack()
    Deprecated.
    static NkStr.Buffer
    mallocStack(int capacity)
    Deprecated.
    static NkStr.Buffer
    mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
    Deprecated.
    static NkStr
    mallocStack(org.lwjgl.system.MemoryStack stack)
    Deprecated.
    static NkBuffer
    nbuffer(long struct)
    Unsafe version of buffer().
    static int
    nlen(long struct)
    Unsafe version of len().
    int
    sizeof()
     

    Methods inherited from class org.lwjgl.system.Struct

    clear, free, isNull, validate, validate

    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 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()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<NkStr>

    • buffer

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

    • len

      public int len()
      in codepoints/runes/glyphs

    • 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(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static NkStr callocStack(org.lwjgl.system.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, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

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

    • malloc

      public static NkStr malloc(org.lwjgl.system.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(org.lwjgl.system.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, org.lwjgl.system.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, org.lwjgl.system.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().