Class XrColor4f

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

    public class XrColor4f
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Color Vector.
    Description

    Unless otherwise specified, colors are encoded as linear (not with sRGB nor other gamma compression) values with individual components being in the range of 0.0 through 1.0, and without the RGB components being premultiplied by the alpha component.

    If color encoding is specified as being premultiplied by the alpha component, the RGB components are set to zero if the alpha component is zero.

    See Also

    XrCompositionLayerColorScaleBiasKHR, XrPassthroughColorMapMonoToRgbaFB, XrPassthroughStyleFB, XrSwapchainStateSamplerOpenGLESFB, XrSwapchainStateSamplerVulkanFB

    Layout

    
     struct XrColor4f {
         float r();
         float g();
         float b();
         float a();
     }
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  XrColor4f.Buffer
      An array of XrColor4f 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 A
      The struct member offsets.
      static int ALIGNOF
      The struct alignment in bytes.
      static int B
      G
      R
      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
      XrColor4f​(java.nio.ByteBuffer container)
      Creates a XrColor4f 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
      float a()
      the alpha component of the color.
      XrColor4f a​(float value)
      Sets the specified value to the a() field.
      float b()
      the blue component of the color.
      XrColor4f b​(float value)
      Sets the specified value to the b() field.
      static XrColor4f calloc()
      Returns a new XrColor4f instance allocated with memCalloc.
      static XrColor4f.Buffer calloc​(int capacity)
      Returns a new XrColor4f.Buffer instance allocated with memCalloc.
      static XrColor4f.Buffer calloc​(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new XrColor4f.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      static XrColor4f calloc​(org.lwjgl.system.MemoryStack stack)
      Returns a new XrColor4f instance allocated on the specified MemoryStack and initializes all its bits to zero.
      static XrColor4f create()
      Returns a new XrColor4f instance allocated with BufferUtils.
      static XrColor4f.Buffer create​(int capacity)
      Returns a new XrColor4f.Buffer instance allocated with BufferUtils.
      static XrColor4f create​(long address)
      Returns a new XrColor4f instance for the specified memory address.
      static XrColor4f.Buffer create​(long address, int capacity)
      Create a XrColor4f.Buffer instance at the specified memory.
      static XrColor4f createSafe​(long address)
      Like create, but returns null if address is NULL.
      static XrColor4f.Buffer createSafe​(long address, int capacity)
      Like create, but returns null if address is NULL.
      float g()
      the green component of the color.
      XrColor4f g​(float value)
      Sets the specified value to the g() field.
      static XrColor4f malloc()
      Returns a new XrColor4f instance allocated with memAlloc.
      static XrColor4f.Buffer malloc​(int capacity)
      Returns a new XrColor4f.Buffer instance allocated with memAlloc.
      static XrColor4f.Buffer malloc​(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new XrColor4f.Buffer instance allocated on the specified MemoryStack.
      static XrColor4f malloc​(org.lwjgl.system.MemoryStack stack)
      Returns a new XrColor4f instance allocated on the specified MemoryStack.
      static float na​(long struct)
      Unsafe version of a().
      static void na​(long struct, float value)
      Unsafe version of a.
      static float nb​(long struct)
      Unsafe version of b().
      static void nb​(long struct, float value)
      Unsafe version of b.
      static float ng​(long struct)
      Unsafe version of g().
      static void ng​(long struct, float value)
      Unsafe version of g.
      static float nr​(long struct)
      Unsafe version of r().
      static void nr​(long struct, float value)
      Unsafe version of r.
      float r()
      the red component of the color.
      XrColor4f r​(float value)
      Sets the specified value to the r() field.
      XrColor4f set​(float r, float g, float b, float a)
      Initializes this struct with the specified values.
      XrColor4f set​(XrColor4f src)
      Copies the specified struct data to this struct.
      int sizeof()  
      • Methods inherited from interface org.lwjgl.system.NativeResource

        close, free
      • 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, validate
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

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

        The struct member offsets.
    • Constructor Detail

      • XrColor4f

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

        public float r()
        the red component of the color.
      • g

        public float g()
        the green component of the color.
      • b

        public float b()
        the blue component of the color.
      • a

        public float a()
        the alpha component of the color.
      • r

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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