VkComponentMapping (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkComponentMapping

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkComponentMapping
extends org.lwjgl.system.Struct
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

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;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkComponentMapping.Buffer
An array of VkComponentMapping structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkComponentMapping.Buffer` An array of `VkComponentMapping` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`A` The struct member offsets.
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`B` The struct member offsets.
`static int`	`G` The struct member offsets.
`static int`	`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 and Description
`VkComponentMapping(java.nio.ByteBuffer container)` Creates a `VkComponentMapping` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`a()` Returns the value of the `a` field.
`VkComponentMapping`	`a(int value)` Sets the specified value to the `a` field.
`int`	`b()` Returns the value of the `b` field.
`VkComponentMapping`	`b(int value)` Sets the specified value to the `b` field.
`static VkComponentMapping`	`calloc()` Returns a new `VkComponentMapping` instance allocated with `memCalloc`.
`static VkComponentMapping.Buffer`	`calloc(int capacity)` Returns a new `VkComponentMapping.Buffer` instance allocated with `memCalloc`.
`static VkComponentMapping`	`callocStack()` Returns a new `VkComponentMapping` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkComponentMapping.Buffer`	`callocStack(int capacity)` Returns a new `VkComponentMapping.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkComponentMapping.Buffer`	`callocStack(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.
`static VkComponentMapping`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkComponentMapping` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkComponentMapping`	`create()` Returns a new `VkComponentMapping` instance allocated with `BufferUtils`.
`static VkComponentMapping.Buffer`	`create(int capacity)` Returns a new `VkComponentMapping.Buffer` instance allocated with `BufferUtils`.
`static VkComponentMapping`	`create(long address)` Returns a new `VkComponentMapping` instance for the specified memory address.
`static VkComponentMapping.Buffer`	`create(long address, int capacity)` Create a `VkComponentMapping.Buffer` instance at the specified memory.
`static VkComponentMapping`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkComponentMapping.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`g()` Returns the value of the `g` field.
`VkComponentMapping`	`g(int value)` Sets the specified value to the `g` field.
`static VkComponentMapping`	`malloc()` Returns a new `VkComponentMapping` instance allocated with `memAlloc`.
`static VkComponentMapping.Buffer`	`malloc(int capacity)` Returns a new `VkComponentMapping.Buffer` instance allocated with `memAlloc`.
`static VkComponentMapping`	`mallocStack()` Returns a new `VkComponentMapping` instance allocated on the thread-local `MemoryStack`.
`static VkComponentMapping.Buffer`	`mallocStack(int capacity)` Returns a new `VkComponentMapping.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkComponentMapping.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkComponentMapping.Buffer` instance allocated on the specified `MemoryStack`.
`static VkComponentMapping`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkComponentMapping` instance allocated on the specified `MemoryStack`.
`static int`	`na(long struct)` Unsafe version of `a()`.
`static void`	`na(long struct, int value)` Unsafe version of `a`.
`static int`	`nb(long struct)` Unsafe version of `b()`.
`static void`	`nb(long struct, int value)` Unsafe version of `b`.
`static int`	`ng(long struct)` Unsafe version of `g()`.
`static void`	`ng(long struct, int value)` Unsafe version of `g`.
`static int`	`nr(long struct)` Unsafe version of `r()`.
`static void`	`nr(long struct, int value)` Unsafe version of `r`.
`int`	`r()` Returns the value of the `r` field.
`VkComponentMapping`	`r(int value)` Sets the specified value to the `r` field.
`VkComponentMapping`	`set(int r, int g, int b, int a)` Initializes this struct with the specified values.
`VkComponentMapping`	`set(VkComponentMapping src)` Copies the specified struct data to this struct.
`int`	`sizeof()`

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - 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 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()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.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.
  - 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
```
@Nullable
public static 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
```
@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(org.lwjgl.system.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(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
  - mallocStack
```
public static VkComponentMapping.Buffer mallocStack(int capacity)
```
    Returns a new VkComponentMapping.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkComponentMapping.Buffer callocStack(int capacity)
```
    Returns a new VkComponentMapping.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkComponentMapping.Buffer mallocStack(int capacity,
                                                    org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkComponentMapping.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkComponentMapping.Buffer callocStack(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:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - 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.

Class VkComponentMapping

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

R

G

B

A

Constructor Detail

VkComponentMapping

Method Detail

sizeof

r

g

b

a

r

g

b

a

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nr

ng

nb

na

nr

ng

nb

na