Package org.lwjgl.vulkan
Class VkClearValue
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkClearValue>
org.lwjgl.vulkan.VkClearValue
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkClearValue
extends org.lwjgl.system.Struct<VkClearValue>
implements org.lwjgl.system.NativeResource
Structure specifying a clear value.
Description
This union is used where part of the API requires either color or depth/stencil clear values, depending on the attachment, and defines the initial clear values in the VkRenderPassBeginInfo structure.
See Also
VkClearAttachment, VkClearColorValue, VkClearDepthStencilValue, VkRenderPassBeginInfo, VkRenderingAttachmentInfo
Layout
union VkClearValue {
VkClearColorValue color();
VkClearDepthStencilValue depthStencil();
}-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkClearValue(ByteBuffer container) Creates aVkClearValueinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkClearValuecalloc()Returns a newVkClearValueinstance allocated withmemCalloc.static VkClearValue.Buffercalloc(int capacity) Returns a newVkClearValue.Bufferinstance allocated withmemCalloc.static VkClearValue.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkClearValue.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkClearValuecalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkClearValueinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkClearValueDeprecated.static VkClearValue.BuffercallocStack(int capacity) Deprecated.static VkClearValue.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkClearValuecallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.color()specifies the color image clear values to use when clearing a color image or attachment.color(Consumer<VkClearColorValue> consumer) color(VkClearColorValue value) Copies the specifiedVkClearColorValueto thecolor()field.static VkClearValuecreate()Returns a newVkClearValueinstance allocated withBufferUtils.static VkClearValue.Buffercreate(int capacity) Returns a newVkClearValue.Bufferinstance allocated withBufferUtils.static VkClearValuecreate(long address) Returns a newVkClearValueinstance for the specified memory address.static VkClearValue.Buffercreate(long address, int capacity) Create aVkClearValue.Bufferinstance at the specified memory.static @Nullable VkClearValuecreateSafe(long address) static @Nullable VkClearValue.BuffercreateSafe(long address, int capacity) specifies the depth and stencil clear values to use when clearing a depth/stencil image or attachment.depthStencil(Consumer<VkClearDepthStencilValue> consumer) Passes thedepthStencil()field to the specifiedConsumer.Copies the specifiedVkClearDepthStencilValueto thedepthStencil()field.static VkClearValuemalloc()Returns a newVkClearValueinstance allocated withmemAlloc.static VkClearValue.Buffermalloc(int capacity) Returns a newVkClearValue.Bufferinstance allocated withmemAlloc.static VkClearValue.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkClearValue.Bufferinstance allocated on the specifiedMemoryStack.static VkClearValuemalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkClearValueinstance allocated on the specifiedMemoryStack.static VkClearValueDeprecated.static VkClearValue.BuffermallocStack(int capacity) Deprecated.static VkClearValue.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkClearValuemallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkClearColorValuencolor(long struct) Unsafe version ofcolor().static voidncolor(long struct, VkClearColorValue value) Unsafe version ofcolor.static VkClearDepthStencilValuendepthStencil(long struct) Unsafe version ofdepthStencil().static voidndepthStencil(long struct, VkClearDepthStencilValue value) Unsafe version ofdepthStencil.set(VkClearValue src) Copies the specified struct data to this struct.intsizeof()Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods 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. -
COLOR
public static final int COLORThe struct member offsets. -
DEPTHSTENCIL
public static final int DEPTHSTENCILThe struct member offsets.
-
-
Constructor Details
-
VkClearValue
Creates aVkClearValueinstance at the current position of the specifiedByteBuffercontainer. 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()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkClearValue>
-
color
specifies the color image clear values to use when clearing a color image or attachment. -
depthStencil
specifies the depth and stencil clear values to use when clearing a depth/stencil image or attachment. -
color
Copies the specifiedVkClearColorValueto thecolor()field. -
color
-
depthStencil
Copies the specifiedVkClearDepthStencilValueto thedepthStencil()field. -
depthStencil
Passes thedepthStencil()field to the specifiedConsumer. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkClearValueinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkClearValueinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkClearValueinstance allocated withBufferUtils. -
create
Returns a newVkClearValueinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkClearValue.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkClearValue.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkClearValue.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkClearValue.Bufferinstance 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 public static VkClearValue.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkClearValue.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkClearValueinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkClearValueinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
Returns a newVkClearValue.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
Returns a newVkClearValue.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
ncolor
Unsafe version ofcolor(). -
ndepthStencil
Unsafe version ofdepthStencil(). -
ncolor
Unsafe version ofcolor. -
ndepthStencil
Unsafe version ofdepthStencil.
-