Class VkComponentMapping

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

    public class VkComponentMapping
    extends Struct
    implements NativeResource
    Structure specifying a color component mapping.
    Valid Usage (Implicit)
    • r must be a valid VkComponentSwizzle value
    • g must be a valid VkComponentSwizzle value
    • b must be a valid VkComponentSwizzle value
    • a must be a valid VkComponentSwizzle value
    See Also

    VkImageViewCreateInfo, VkSamplerYcbcrConversionCreateInfo

    Member documentation

    • r – a VkComponentSwizzle specifying the component value placed in the R component of the output vector.
    • g – a VkComponentSwizzle specifying the component value placed in the G component of the output vector.
    • b – a VkComponentSwizzle specifying the component value placed in the B component of the output vector.
    • a – a VkComponentSwizzle specifying the component value placed in the A component of the output vector.

    Layout

    
     struct VkComponentMapping {
         VkComponentSwizzle r;
         VkComponentSwizzle g;
         VkComponentSwizzle b;
         VkComponentSwizzle 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

      • VkComponentMapping

        public VkComponentMapping​(java.nio.ByteBuffer container)
        Creates a VkComponentMapping 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 int r()
        Returns the value of the r field.
      • g

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

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

        public int a()
        Returns the value of the a field.
      • set

        public VkComponentMapping set​(int r,
                                      int g,
                                      int b,
                                      int a)
        Initializes this struct with the specified values.
      • malloc

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

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

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

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

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

        public static VkComponentMapping mallocStack()
        Returns a new VkComponentMapping instance allocated on the thread-local MemoryStack.
      • callocStack

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

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

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

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

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

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

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

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

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

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

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