Class NkMemory

  • All Implemented Interfaces:
    org.lwjgl.system.Pointer

    public class NkMemory
    extends org.lwjgl.system.Struct

    Layout

    
     struct nk_memory {
         void * ptr;
         nk_size size;
     }
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  NkMemory.Buffer
      An array of NkMemory 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 PTR
      SIZE
      The struct member offsets.
      static 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
      NkMemory​(java.nio.ByteBuffer container)
      Creates a NkMemory instance at the current position of the specified ByteBuffer container.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static NkMemory create​(long address)
      Returns a new NkMemory instance for the specified memory address.
      static NkMemory.Buffer create​(long address, int capacity)
      Create a NkMemory.Buffer instance at the specified memory.
      static NkMemory createSafe​(long address)
      Like create, but returns null if address is NULL.
      static NkMemory.Buffer createSafe​(long address, int capacity)
      Like create, but returns null if address is NULL.
      static java.nio.ByteBuffer nptr​(long struct)
      Unsafe version of ptr.
      static long nsize​(long struct)
      Unsafe version of size().
      java.nio.ByteBuffer ptr()
      Returns a ByteBuffer view of the data pointed to by the ptr field.
      long size()
      Returns the value of the size field.
      int sizeof()  
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from class org.lwjgl.system.Pointer.Default

        address, equals, hashCode, toString
      • Methods inherited from class org.lwjgl.system.Struct

        clear, free, isNull
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • PTR, SIZE

        The struct member offsets.
    • Constructor Detail

      • NkMemory

        public NkMemory​(java.nio.ByteBuffer container)
        Creates a NkMemory 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

        @Nullable
        public java.nio.ByteBuffer ptr()
        Returns a ByteBuffer view of the data pointed to by the ptr field.
      • size

        public long size()
        Returns the value of the size field.
      • create

        public static NkMemory create​(long address)
        Returns a new NkMemory instance for the specified memory address.
      • createSafe

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

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

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

        @Nullable
        public static java.nio.ByteBuffer nptr​(long struct)
        Unsafe version of ptr.
      • nsize

        public static long nsize​(long struct)
        Unsafe version of size().