Package org.lwjgl.vulkan

Class VkClearAttachment

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkClearAttachment>

org.lwjgl.vulkan.VkClearAttachment

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkClearAttachment
extends Struct<VkClearAttachment>
implements NativeResource

Structure specifying a clear attachment.

Valid Usage

• If aspectMask includes IMAGE_ASPECT_COLOR_BIT, it must not include IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT
• aspectMask must not include IMAGE_ASPECT_METADATA_BIT
• aspectMask must not include VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT for any index i

Valid Usage (Implicit)

• aspectMask must be a valid combination of VkImageAspectFlagBits values
• aspectMask must not be 0

See Also

VkClearValue, CmdClearAttachments

Layout

 struct VkClearAttachment {
     VkImageAspectFlags aspectMask();
     uint32_t colorAttachment();
     VkClearValue clearValue();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkClearAttachment.Buffer	An array of VkClearAttachment 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	ALIGNOF	The struct alignment in bytes.
static final int	ASPECTMASK	The struct member offsets.
static final int	CLEARVALUE	The struct member offsets.
static final int	COLORATTACHMENT	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
VkClearAttachment(ByteBuffer container)	Creates a VkClearAttachment instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	aspectMask()	a mask selecting the color, depth and/or stencil aspects of the attachment to be cleared.
VkClearAttachment	aspectMask(int value)	Sets the specified value to the aspectMask() field.
static VkClearAttachment	calloc()	Returns a new VkClearAttachment instance allocated with memCalloc.
static VkClearAttachment.Buffer	calloc(int capacity)	Returns a new VkClearAttachment.Buffer instance allocated with memCalloc.
static VkClearAttachment.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkClearAttachment.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkClearAttachment	calloc(MemoryStack stack)	Returns a new VkClearAttachment instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkClearAttachment	callocStack()	Deprecated.
static VkClearAttachment.Buffer	callocStack(int capacity)	Deprecated.
static VkClearAttachment.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkClearAttachment	callocStack(MemoryStack stack)	Deprecated.
VkClearValue	clearValue()	the color or depth/stencil value to clear the attachment to, as described in Clear Values below.
VkClearAttachment	clearValue(Consumer<VkClearValue> consumer)	Passes the clearValue() field to the specified Consumer.
VkClearAttachment	clearValue(VkClearValue value)	Copies the specified VkClearValue to the clearValue() field.
int	colorAttachment()	only meaningful if IMAGE_ASPECT_COLOR_BIT is set in aspectMask, in which case it is an index into the currently bound color attachments.
VkClearAttachment	colorAttachment(int value)	Sets the specified value to the colorAttachment() field.
static VkClearAttachment	create()	Returns a new VkClearAttachment instance allocated with BufferUtils.
static VkClearAttachment.Buffer	create(int capacity)	Returns a new VkClearAttachment.Buffer instance allocated with BufferUtils.
static VkClearAttachment	create(long address)	Returns a new VkClearAttachment instance for the specified memory address.
static VkClearAttachment.Buffer	create(long address, int capacity)	Create a VkClearAttachment.Buffer instance at the specified memory.
static VkClearAttachment	createSafe(long address)	Like create, but returns null if address is NULL.
static VkClearAttachment.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkClearAttachment	malloc()	Returns a new VkClearAttachment instance allocated with memAlloc.
static VkClearAttachment.Buffer	malloc(int capacity)	Returns a new VkClearAttachment.Buffer instance allocated with memAlloc.
static VkClearAttachment.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkClearAttachment.Buffer instance allocated on the specified MemoryStack.
static VkClearAttachment	malloc(MemoryStack stack)	Returns a new VkClearAttachment instance allocated on the specified MemoryStack.
static VkClearAttachment	mallocStack()	Deprecated.
static VkClearAttachment.Buffer	mallocStack(int capacity)	Deprecated.
static VkClearAttachment.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkClearAttachment	mallocStack(MemoryStack stack)	Deprecated.
static int	naspectMask(long struct)	Unsafe version of aspectMask().
static void	naspectMask(long struct, int value)	Unsafe version of aspectMask.
static VkClearValue	nclearValue(long struct)	Unsafe version of clearValue().
static void	nclearValue(long struct, VkClearValue value)	Unsafe version of clearValue.
static int	ncolorAttachment(long struct)	Unsafe version of colorAttachment().
static void	ncolorAttachment(long struct, int value)	Unsafe version of colorAttachment.
VkClearAttachment	set(int aspectMask, int colorAttachment, VkClearValue clearValue)	Initializes this struct with the specified values.
VkClearAttachment	set(VkClearAttachment 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

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.

ASPECTMASK

public static final int ASPECTMASK

The struct member offsets.

COLORATTACHMENT

public static final int COLORATTACHMENT

The struct member offsets.

CLEARVALUE

public static final int CLEARVALUE

The struct member offsets.

Constructor Details

VkClearAttachment

public VkClearAttachment(ByteBuffer container)

Creates a VkClearAttachment 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<VkClearAttachment>

aspectMask

public int aspectMask()

a mask selecting the color, depth and/or stencil aspects of the attachment to be cleared.

colorAttachment

public int colorAttachment()

only meaningful if IMAGE_ASPECT_COLOR_BIT is set in aspectMask, in which case it is an index into the currently bound color attachments.

clearValue

public VkClearValue clearValue()

the color or depth/stencil value to clear the attachment to, as described in Clear Values below.

aspectMask

public VkClearAttachment aspectMask(int value)

Sets the specified value to the aspectMask() field.

colorAttachment

public VkClearAttachment colorAttachment(int value)

Sets the specified value to the colorAttachment() field.

clearValue

public VkClearAttachment clearValue(VkClearValue value)

Copies the specified VkClearValue to the clearValue() field.

clearValue

public VkClearAttachment clearValue(Consumer<VkClearValue> consumer)

Passes the clearValue() field to the specified Consumer.

set

public VkClearAttachment set(int aspectMask,
 int colorAttachment,
 VkClearValue clearValue)

Initializes this struct with the specified values.

set

public VkClearAttachment set(VkClearAttachment src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkClearAttachment malloc()

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

calloc

public static VkClearAttachment calloc()

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

create

public static VkClearAttachment create()

Returns a new VkClearAttachment instance allocated with BufferUtils.

create

public static VkClearAttachment create(long address)

Returns a new VkClearAttachment instance for the specified memory address.

createSafe

@Nullable
public static VkClearAttachment createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkClearAttachment.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkClearAttachment.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkClearAttachment.Buffer create(int capacity)

Returns a new VkClearAttachment.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkClearAttachment.Buffer create(long address,
 int capacity)

Create a VkClearAttachment.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

@Nullable
public static VkClearAttachment.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkClearAttachment mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkClearAttachment callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkClearAttachment mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkClearAttachment callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkClearAttachment.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkClearAttachment.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkClearAttachment.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

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

Deprecated.

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

malloc

public static VkClearAttachment malloc(MemoryStack stack)

Returns a new VkClearAttachment instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkClearAttachment calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkClearAttachment.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkClearAttachment.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkClearAttachment.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

naspectMask

public static int naspectMask(long struct)

Unsafe version of aspectMask().

ncolorAttachment

public static int ncolorAttachment(long struct)

Unsafe version of colorAttachment().

nclearValue

public static VkClearValue nclearValue(long struct)

Unsafe version of clearValue().

naspectMask

public static void naspectMask(long struct,
 int value)

Unsafe version of aspectMask.

ncolorAttachment

public static void ncolorAttachment(long struct,
 int value)

Unsafe version of colorAttachment.

nclearValue

public static void nclearValue(long struct,
 VkClearValue value)

Unsafe version of clearValue.