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, NativeResource, Pointer

public class VkComponentMapping
extends Struct<VkComponentMapping>
implements NativeResource

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
int	a()
VkComponentMapping	a(int value)	Sets the specified value to the a field.
int	b()
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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkComponentMapping.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkComponentMapping	calloc(MemoryStack stack)	Returns a new VkComponentMapping instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkComponentMapping	callocStack()	Deprecated.
static VkComponentMapping.Buffer	callocStack(int capacity)	Deprecated.
static VkComponentMapping.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkComponentMapping	callocStack(MemoryStack stack)	Deprecated.
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 @Nullable VkComponentMapping	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkComponentMapping.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	g()
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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkComponentMapping.Buffer instance allocated on the specified MemoryStack.
static VkComponentMapping	malloc(MemoryStack stack)	Returns a new VkComponentMapping instance allocated on the specified MemoryStack.
static VkComponentMapping	mallocStack()	Deprecated.
static VkComponentMapping.Buffer	mallocStack(int capacity)	Deprecated.
static VkComponentMapping.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkComponentMapping	mallocStack(MemoryStack stack)	Deprecated.
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()
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()	Returns sizeof(struct).

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkComponentMapping>

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

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(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkComponentMapping callocStack(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,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkComponentMapping.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkComponentMapping malloc(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(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,
 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,
 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.