Class AIColor4D

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

    public class AIColor4D
    extends Struct
    implements NativeResource
    Represents a color in Red-Green-Blue space including an alpha component. Color values range from 0 to 1.

    Member documentation

    • r – The red color component
    • g – The green color component
    • b – The blue color component
    • a – The alpha color component

    Layout

    
     struct aiColor4D {
         float r;
         float g;
         float b;
         float a;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • R, G, B, A

        The struct member offsets.
    • Constructor Detail

      • AIColor4D

        public AIColor4D​(java.nio.ByteBuffer container)
        Creates a AIColor4D 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()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class Struct
      • r

        public float r()
        Returns the value of the r field.
      • g

        public float g()
        Returns the value of the g field.
      • b

        public float b()
        Returns the value of the b field.
      • a

        public float a()
        Returns the value of the a field.
      • r

        public AIColor4D r​(float value)
        Sets the specified value to the r field.
      • g

        public AIColor4D g​(float value)
        Sets the specified value to the g field.
      • b

        public AIColor4D b​(float value)
        Sets the specified value to the b field.
      • a

        public AIColor4D a​(float value)
        Sets the specified value to the a field.
      • set

        public AIColor4D set​(float r,
                             float g,
                             float b,
                             float a)
        Initializes this struct with the specified values.
      • set

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

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

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

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

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

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

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

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

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

        public static AIColor4D callocStack()
        Returns a new AIColor4D instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • mallocStack

        public static AIColor4D mallocStack​(MemoryStack stack)
        Returns a new AIColor4D instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

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

        public static AIColor4D.Buffer callocStack​(int capacity)
        Returns a new AIColor4D.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
        Parameters:
        capacity - the buffer capacity
      • callocStack

        public static AIColor4D.Buffer callocStack​(int capacity,
                                                   MemoryStack stack)
        Returns a new AIColor4D.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
      • nr

        public static float nr​(long struct)
        Unsafe version of r().
      • ng

        public static float ng​(long struct)
        Unsafe version of g().
      • nb

        public static float nb​(long struct)
        Unsafe version of b().
      • na

        public static float na​(long struct)
        Unsafe version of a().
      • nr

        public static void nr​(long struct,
                              float value)
        Unsafe version of r.
      • ng

        public static void ng​(long struct,
                              float value)
        Unsafe version of g.
      • nb

        public static void nb​(long struct,
                              float value)
        Unsafe version of b.
      • na

        public static void na​(long struct,
                              float value)
        Unsafe version of a.