Class CUmemLocation

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

    public class CUmemLocation
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Specifies a memory location.

    Layout

    
     struct CUmemLocation {
         CUmemLocationType type();
         int id();
     }
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CUmemLocation.Buffer
      An array of CUmemLocation structs.
      • Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

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

        org.lwjgl.system.Struct.StructValidation
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ALIGNOF
      The struct alignment in bytes.
      static int ID
      The struct member offsets.
      static int SIZEOF
      The struct size in bytes.
      static int TYPE
      The struct member offsets.
      • Fields inherited from interface org.lwjgl.system.Pointer

        BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
    • Constructor Summary

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

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • TYPE, ID

        The struct member offsets.
    • Constructor Detail

      • CUmemLocation

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

        public int type()
        specifies the location type, which modifies the meaning of id
      • id

        public int id()
        identifier for a given this location's CUmemLocationType
      • type

        public CUmemLocation type​(int value)
        Sets the specified value to the type() field.
      • id

        public CUmemLocation id​(int value)
        Sets the specified value to the id() field.
      • set

        public CUmemLocation set​(int type,
                                 int id)
        Initializes this struct with the specified values.
      • set

        public CUmemLocation set​(CUmemLocation src)
        Copies the specified struct data to this struct.
        Parameters:
        src - the source struct
        Returns:
        this struct
      • malloc

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

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

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

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

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

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

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

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

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

        public static CUmemLocation malloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new CUmemLocation instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • calloc

        public static CUmemLocation calloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new CUmemLocation instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
      • malloc

        public static CUmemLocation.Buffer malloc​(int capacity,
                                                  org.lwjgl.system.MemoryStack stack)
        Returns a new CUmemLocation.Buffer instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • calloc

        public static CUmemLocation.Buffer calloc​(int capacity,
                                                  org.lwjgl.system.MemoryStack stack)
        Returns a new CUmemLocation.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
      • ntype

        public static int ntype​(long struct)
        Unsafe version of type().
      • nid

        public static int nid​(long struct)
        Unsafe version of id().
      • ntype

        public static void ntype​(long struct,
                                 int value)
        Unsafe version of type.
      • nid

        public static void nid​(long struct,
                               int value)
        Unsafe version of id.