Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkComponentMapping

extends Struct<VkComponentMapping>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying a color component mapping.
Valid Usage (Implicit)
See Also

VkAndroidHardwareBufferFormatProperties2ANDROID, VkAndroidHardwareBufferFormatPropertiesANDROID, VkImageViewCreateInfo, VkSamplerBorderColorComponentMappingCreateInfoEXT, VkSamplerYcbcrConversionCreateInfo, VkVideoFormatPropertiesKHR

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
A

The struct member offsets.

public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
B

The struct member offsets.

public static final int
G

The struct member offsets.

public static final int
R

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkComponentMapping(long address, ByteBuffer container)

public
VkComponentMapping(ByteBuffer container)

Creates a VkComponentMapping instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public int
a()

a VkComponentSwizzle specifying the component value placed in the A component of the output vector.

public VkComponentMapping
a(int value)

Sets the specified value to the a field.

public int
b()

a VkComponentSwizzle specifying the component value placed in the B component of the output vector.

public VkComponentMapping
b(int value)

Sets the specified value to the b field.

public static VkComponentMapping
calloc()

Returns a new VkComponentMapping instance allocated with memCalloc.

public static VkComponentMapping.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkComponentMapping.Buffer instance allocated with memCalloc.

public static VkComponentMapping
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkComponentMapping instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkComponentMapping.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkComponentMapping.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkComponentMapping
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkComponentMapping
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkComponentMapping.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkComponentMapping.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkComponentMapping
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkComponentMapping
create()

Returns a new VkComponentMapping instance allocated with BufferUtils.

public static VkComponentMapping
create(long address)

Returns a new VkComponentMapping instance for the specified memory address.

public static VkComponentMapping.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkComponentMapping.Buffer instance allocated with BufferUtils.

public static VkComponentMapping.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkComponentMapping.Buffer instance at the specified memory.

public static VkComponentMapping
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkComponentMapping.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
g()

a VkComponentSwizzle specifying the component value placed in the G component of the output vector.

public VkComponentMapping
g(int value)

Sets the specified value to the g field.

public static VkComponentMapping
malloc()

Returns a new VkComponentMapping instance allocated with memAlloc.

public static VkComponentMapping.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkComponentMapping.Buffer instance allocated with memAlloc.

public static VkComponentMapping
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkComponentMapping instance allocated on the specified MemoryStack.

public static VkComponentMapping.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkComponentMapping.Buffer instance allocated on the specified MemoryStack.

public static VkComponentMapping
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkComponentMapping
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkComponentMapping.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkComponentMapping.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
na(long struct)

Unsafe version of a.

public static void
na(long struct, int value)

Unsafe version of a.

public static int
nb(long struct)

Unsafe version of b.

public static void
nb(long struct, int value)

Unsafe version of b.

public static int
ng(long struct)

Unsafe version of g.

public static void
ng(long struct, int value)

Unsafe version of g.

public static int
nr(long struct)

Unsafe version of r.

public static void
nr(long struct, int value)

Unsafe version of r.

public int
r()

a VkComponentSwizzle specifying the component value placed in the R component of the output vector.

public VkComponentMapping
r(int value)

Sets the specified value to the r field.

public VkComponentMapping
set(int r, int g, int b, int a)

Initializes this struct with the specified values.

public VkComponentMapping

Returns:

this struct
set
(VkComponentMapping
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

Aback to summary
public static final int A

The struct member offsets.

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

Bback to summary
public static final int B

The struct member offsets.

Gback to summary
public static final int G

The struct member offsets.

Rback to summary
public static final int R

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VkComponentMappingback to summary
protected VkComponentMapping(long address, ByteBuffer container)
VkComponentMappingback to summary
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 Detail

aback to summary
public int a()

a VkComponentSwizzle specifying the component value placed in the A component of the output vector.

Annotations
@NativeType:VkComponentSwizzle
aback to summary
public VkComponentMapping a(int value)

Sets the specified value to the a field.

bback to summary
public int b()

a VkComponentSwizzle specifying the component value placed in the B component of the output vector.

Annotations
@NativeType:VkComponentSwizzle
bback to summary
public VkComponentMapping b(int value)

Sets the specified value to the b field.

callocback to summary
public static VkComponentMapping calloc()

Returns a new VkComponentMapping instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkComponentMapping.Buffer calloc(int capacity)

Returns a new VkComponentMapping.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkComponentMapping calloc(MemoryStack stack)

Returns a new VkComponentMapping instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkComponentMapping.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkComponentMapping.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkComponentMapping callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkComponentMapping callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkComponentMapping.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkComponentMapping.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkComponentMapping create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkComponentMapping create()

Returns a new VkComponentMapping instance allocated with BufferUtils.

createback to summary
public static VkComponentMapping create(long address)

Returns a new VkComponentMapping instance for the specified memory address.

createback to summary
public static VkComponentMapping.Buffer create(int capacity)

Returns a new VkComponentMapping.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkComponentMapping.Buffer create(long address, int capacity)

Create a VkComponentMapping.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkComponentMapping createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkComponentMapping.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
gback to summary
public int g()

a VkComponentSwizzle specifying the component value placed in the G component of the output vector.

Annotations
@NativeType:VkComponentSwizzle
gback to summary
public VkComponentMapping g(int value)

Sets the specified value to the g field.

mallocback to summary
public static VkComponentMapping malloc()

Returns a new VkComponentMapping instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkComponentMapping.Buffer malloc(int capacity)

Returns a new VkComponentMapping.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkComponentMapping malloc(MemoryStack stack)

Returns a new VkComponentMapping instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkComponentMapping.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkComponentMapping.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkComponentMapping mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkComponentMapping mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkComponentMapping.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkComponentMapping.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
naback to summary
public static int na(long struct)

Unsafe version of a.

naback to summary
public static void na(long struct, int value)

Unsafe version of a.

nbback to summary
public static int nb(long struct)

Unsafe version of b.

nbback to summary
public static void nb(long struct, int value)

Unsafe version of b.

ngback to summary
public static int ng(long struct)

Unsafe version of g.

ngback to summary
public static void ng(long struct, int value)

Unsafe version of g.

nrback to summary
public static int nr(long struct)

Unsafe version of r.

nrback to summary
public static void nr(long struct, int value)

Unsafe version of r.

rback to summary
public int r()

a VkComponentSwizzle specifying the component value placed in the R component of the output vector.

Annotations
@NativeType:VkComponentSwizzle
rback to summary
public VkComponentMapping r(int value)

Sets the specified value to the r field.

setback to summary
public VkComponentMapping set(int r, int g, int b, int a)

Initializes this struct with the specified values.

setback to summary
public VkComponentMapping set(VkComponentMapping src)

Copies the specified struct data to this struct.

Parameters
src:VkComponentMapping

the source struct

Returns:VkComponentMapping

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
org.lwjgl.vulkan back to summary

public Class VkComponentMapping.Buffer

extends StructBuffer<VkComponentMapping, VkComponentMapping.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkComponentMapping structs.

Field Summary

Modifier and TypeField and Description
private static final VkComponentMapping

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkComponentMapping.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the VkComponentMapping#a field.
a
()

public VkComponentMapping.Buffer
a(int value)

Sets the specified value to the VkComponentMapping#a field.

public int

Returns:

the value of the VkComponentMapping#b field.
b
()

public VkComponentMapping.Buffer
b(int value)

Sets the specified value to the VkComponentMapping#b field.

public int

Returns:

the value of the VkComponentMapping#g field.
g
()

public VkComponentMapping.Buffer
g(int value)

Sets the specified value to the VkComponentMapping#g field.

protected VkComponentMapping
public int

Returns:

the value of the VkComponentMapping#r field.
r
()

public VkComponentMapping.Buffer
r(int value)

Sets the specified value to the VkComponentMapping#r field.

protected VkComponentMapping.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkComponentMapping ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkComponentMapping.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkComponentMapping#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

aback to summary
public int a()
Returns:int

the value of the VkComponentMapping#a field.

Annotations
@NativeType:VkComponentSwizzle
aback to summary
public VkComponentMapping.Buffer a(int value)

Sets the specified value to the VkComponentMapping#a field.

bback to summary
public int b()
Returns:int

the value of the VkComponentMapping#b field.

Annotations
@NativeType:VkComponentSwizzle
bback to summary
public VkComponentMapping.Buffer b(int value)

Sets the specified value to the VkComponentMapping#b field.

gback to summary
public int g()
Returns:int

the value of the VkComponentMapping#g field.

Annotations
@NativeType:VkComponentSwizzle
gback to summary
public VkComponentMapping.Buffer g(int value)

Sets the specified value to the VkComponentMapping#g field.

getElementFactoryback to summary
protected VkComponentMapping getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
rback to summary
public int r()
Returns:int

the value of the VkComponentMapping#r field.

Annotations
@NativeType:VkComponentSwizzle
rback to summary
public VkComponentMapping.Buffer r(int value)

Sets the specified value to the VkComponentMapping#r field.

selfback to summary
protected VkComponentMapping.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override