Package org.lwjgl.vulkan
Class VkClearAttachment
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
struct VkClearAttachment {
VkImageAspectFlags aspectMask;
uint32_t colorAttachment;
{@link VkClearValue VkClearValue} clearValue;
}
-
Nested Class Summary
Nested ClassesNested 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
FieldsModifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
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
ConstructorsConstructorDescriptionVkClearAttachment
(ByteBuffer container) Creates aVkClearAttachment
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionint
aspectMask
(int value) Sets the specified value to theaspectMask
field.static VkClearAttachment
calloc()
Returns a newVkClearAttachment
instance allocated withmemCalloc
.static VkClearAttachment.Buffer
calloc
(int capacity) Returns a newVkClearAttachment.Buffer
instance allocated withmemCalloc
.static VkClearAttachment.Buffer
calloc
(int capacity, MemoryStack stack) Returns a newVkClearAttachment.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkClearAttachment
calloc
(MemoryStack stack) Returns a newVkClearAttachment
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkClearAttachment
Deprecated.static VkClearAttachment.Buffer
callocStack
(int capacity) Deprecated.static VkClearAttachment.Buffer
callocStack
(int capacity, MemoryStack stack) Deprecated.static VkClearAttachment
callocStack
(MemoryStack stack) Deprecated.clearValue
(Consumer<VkClearValue> consumer) Passes theclearValue
field to the specifiedConsumer
.clearValue
(VkClearValue value) Copies the specifiedVkClearValue
to theclearValue
field.int
colorAttachment
(int value) Sets the specified value to thecolorAttachment
field.static VkClearAttachment
create()
Returns a newVkClearAttachment
instance allocated withBufferUtils
.static VkClearAttachment.Buffer
create
(int capacity) Returns a newVkClearAttachment.Buffer
instance allocated withBufferUtils
.static VkClearAttachment
create
(long address) Returns a newVkClearAttachment
instance for the specified memory address.static VkClearAttachment.Buffer
create
(long address, int capacity) Create aVkClearAttachment.Buffer
instance at the specified memory.static @Nullable VkClearAttachment
createSafe
(long address) static @Nullable VkClearAttachment.Buffer
createSafe
(long address, int capacity) static VkClearAttachment
malloc()
Returns a newVkClearAttachment
instance allocated withmemAlloc
.static VkClearAttachment.Buffer
malloc
(int capacity) Returns a newVkClearAttachment.Buffer
instance allocated withmemAlloc
.static VkClearAttachment.Buffer
malloc
(int capacity, MemoryStack stack) Returns a newVkClearAttachment.Buffer
instance allocated on the specifiedMemoryStack
.static VkClearAttachment
malloc
(MemoryStack stack) Returns a newVkClearAttachment
instance allocated on the specifiedMemoryStack
.static VkClearAttachment
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 ofaspectMask()
.static void
naspectMask
(long struct, int value) Unsafe version ofaspectMask
.static VkClearValue
nclearValue
(long struct) Unsafe version ofclearValue()
.static void
nclearValue
(long struct, VkClearValue value) Unsafe version ofclearValue
.static int
ncolorAttachment
(long struct) Unsafe version ofcolorAttachment()
.static void
ncolorAttachment
(long struct, int value) Unsafe version ofcolorAttachment
.set
(int aspectMask, int colorAttachment, VkClearValue clearValue) Initializes this struct with the specified values.set
(VkClearAttachment src) Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
ASPECTMASK
public static final int ASPECTMASKThe struct member offsets. -
COLORATTACHMENT
public static final int COLORATTACHMENTThe struct member offsets. -
CLEARVALUE
public static final int CLEARVALUEThe struct member offsets.
-
-
Constructor Details
-
VkClearAttachment
Creates aVkClearAttachment
instance at the current position of the specifiedByteBuffer
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
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkClearAttachment>
-
aspectMask
public int aspectMask()- Returns:
- the value of the
aspectMask
field.
-
colorAttachment
public int colorAttachment()- Returns:
- the value of the
colorAttachment
field.
-
clearValue
- Returns:
- a
VkClearValue
view of theclearValue
field.
-
aspectMask
Sets the specified value to theaspectMask
field. -
colorAttachment
Sets the specified value to thecolorAttachment
field. -
clearValue
Copies the specifiedVkClearValue
to theclearValue
field. -
clearValue
Passes theclearValue
field to the specifiedConsumer
. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newVkClearAttachment
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkClearAttachment
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkClearAttachment
instance allocated withBufferUtils
. -
create
Returns a newVkClearAttachment
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkClearAttachment.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkClearAttachment.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkClearAttachment.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkClearAttachment.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkClearAttachment
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkClearAttachment
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkClearAttachment.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkClearAttachment.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
naspectMask
public static int naspectMask(long struct) Unsafe version ofaspectMask()
. -
ncolorAttachment
public static int ncolorAttachment(long struct) Unsafe version ofcolorAttachment()
. -
nclearValue
Unsafe version ofclearValue()
. -
naspectMask
public static void naspectMask(long struct, int value) Unsafe version ofaspectMask
. -
ncolorAttachment
public static void ncolorAttachment(long struct, int value) Unsafe version ofcolorAttachment
. -
nclearValue
Unsafe version ofclearValue
.
-