Package org.lwjgl.vulkan

Class VkComponentMapping

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkComponentMapping>
org.lwjgl.vulkan.VkComponentMapping
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkComponentMapping extends org.lwjgl.system.Struct<VkComponentMapping> implements org.lwjgl.system.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

VkAndroidHardwareBufferFormatProperties2ANDROID, VkAndroidHardwareBufferFormatPropertiesANDROID, VkImageViewCreateInfo, VkSamplerBorderColorComponentMappingCreateInfoEXT, VkSamplerYcbcrConversionCreateInfo, VkVideoFormatPropertiesKHR

Layout


 struct VkComponentMapping {
     VkComponentSwizzle r();
     VkComponentSwizzle g();
     VkComponentSwizzle b();
     VkComponentSwizzle a();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • R

      public static final int R
      The struct member offsets.

    • G

      public static final int G
      The struct member offsets.

    • B

      public static final int B
      The struct member offsets.

    • A

      public static final int A
      The struct member offsets.

  • Constructor Details

    • VkComponentMapping

      public VkComponentMapping(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 Details

    • sizeof

      public int sizeof()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<VkComponentMapping>

    • r

      public int r()
      a VkComponentSwizzle specifying the component value placed in the R component of the output vector.

    • g

      public int g()
      a VkComponentSwizzle specifying the component value placed in the G component of the output vector.

    • b

      public int b()
      a VkComponentSwizzle specifying the component value placed in the B component of the output vector.

    • a

      public int a()
      a VkComponentSwizzle specifying the component value placed in the A component of the output vector.

    • r

      public VkComponentMapping r(int value)
      Sets the specified value to the r() field.

    • g

      public VkComponentMapping g(int value)
      Sets the specified value to the g() field.

    • b

      public VkComponentMapping b(int value)
      Sets the specified value to the b() field.

    • a

      public VkComponentMapping a(int value)
      Sets the specified value to the a() field.

    • set

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

    • set

      public VkComponentMapping set(VkComponentMapping src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • 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()
      Returns a new VkComponentMapping instance allocated with BufferUtils.

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • mallocStack

      @Deprecated public static VkComponentMapping mallocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static VkComponentMapping callocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkComponentMapping mallocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static VkComponentMapping callocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkComponentMapping.Buffer mallocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static VkComponentMapping.Buffer callocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkComponentMapping.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static VkComponentMapping.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • malloc

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

    • calloc

      public static VkComponentMapping calloc(org.lwjgl.system.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

    • malloc

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

    • calloc

      public static VkComponentMapping.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkComponentMapping.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      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.