Package org.lwjgl.vulkan
Class VkClearValue
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkClearValue
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,NativeResource
,Pointer
public class VkClearValue extends Struct implements 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
Member documentation
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.
Layout
union VkClearValue {
VkClearColorValue
color;VkClearDepthStencilValue
depthStencil; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkClearValue.Buffer
An array ofVkClearValue
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
COLOR
DEPTHSTENCILThe struct member offsets.static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor Description VkClearValue(java.nio.ByteBuffer container)
Creates aVkClearValue
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkClearValue
calloc()
Returns a newVkClearValue
instance allocated withmemCalloc
.static VkClearValue.Buffer
calloc(int capacity)
Returns a newVkClearValue.Buffer
instance allocated withmemCalloc
.static VkClearValue
callocStack()
Returns a newVkClearValue
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkClearValue.Buffer
callocStack(int capacity)
Returns a newVkClearValue.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkClearValue.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkClearValue.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkClearValue
callocStack(MemoryStack stack)
Returns a newVkClearValue
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.VkClearColorValue
color()
Returns aVkClearColorValue
view of thecolor
field.VkClearValue
color(java.util.function.Consumer<VkClearColorValue> consumer)
Passes thecolor
field to the specifiedConsumer
.VkClearValue
color(VkClearColorValue value)
Copies the specifiedVkClearColorValue
to thecolor
field.static VkClearValue
create()
Returns a newVkClearValue
instance allocated withBufferUtils
.static VkClearValue.Buffer
create(int capacity)
Returns a newVkClearValue.Buffer
instance allocated withBufferUtils
.static VkClearValue
create(long address)
Returns a newVkClearValue
instance for the specified memory address.static VkClearValue.Buffer
create(long address, int capacity)
Create aVkClearValue.Buffer
instance at the specified memory.static VkClearValue
createSafe(long address)
static VkClearValue.Buffer
createSafe(long address, int capacity)
VkClearDepthStencilValue
depthStencil()
Returns aVkClearDepthStencilValue
view of thedepthStencil
field.VkClearValue
depthStencil(java.util.function.Consumer<VkClearDepthStencilValue> consumer)
Passes thedepthStencil
field to the specifiedConsumer
.VkClearValue
depthStencil(VkClearDepthStencilValue value)
Copies the specifiedVkClearDepthStencilValue
to thedepthStencil
field.static VkClearValue
malloc()
Returns a newVkClearValue
instance allocated withmemAlloc
.static VkClearValue.Buffer
malloc(int capacity)
Returns a newVkClearValue.Buffer
instance allocated withmemAlloc
.static VkClearValue
mallocStack()
Returns a newVkClearValue
instance allocated on the thread-localMemoryStack
.static VkClearValue.Buffer
mallocStack(int capacity)
Returns a newVkClearValue.Buffer
instance allocated on the thread-localMemoryStack
.static VkClearValue.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkClearValue.Buffer
instance allocated on the specifiedMemoryStack
.static VkClearValue
mallocStack(MemoryStack stack)
Returns a newVkClearValue
instance allocated on the specifiedMemoryStack
.static VkClearColorValue
ncolor(long struct)
Unsafe version ofcolor()
.static void
ncolor(long struct, VkClearColorValue value)
Unsafe version ofcolor
.static VkClearDepthStencilValue
ndepthStencil(long struct)
Unsafe version ofdepthStencil()
.static void
ndepthStencil(long struct, VkClearDepthStencilValue value)
Unsafe version ofdepthStencil
.VkClearValue
set(VkClearValue src)
Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.-
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
-
-
-
Constructor Detail
-
VkClearValue
public VkClearValue(java.nio.ByteBuffer container)
Creates aVkClearValue
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 Detail
-
sizeof
public int sizeof()
Description copied from class:Struct
Returnssizeof(struct)
.
-
color
public VkClearColorValue color()
Returns aVkClearColorValue
view of thecolor
field.
-
color
public VkClearValue color(java.util.function.Consumer<VkClearColorValue> consumer)
Passes thecolor
field to the specifiedConsumer
.
-
depthStencil
public VkClearDepthStencilValue depthStencil()
Returns aVkClearDepthStencilValue
view of thedepthStencil
field.
-
depthStencil
public VkClearValue depthStencil(java.util.function.Consumer<VkClearDepthStencilValue> consumer)
Passes thedepthStencil
field to the specifiedConsumer
.
-
color
public VkClearValue color(VkClearColorValue value)
Copies the specifiedVkClearColorValue
to thecolor
field.
-
depthStencil
public VkClearValue depthStencil(VkClearDepthStencilValue value)
Copies the specifiedVkClearDepthStencilValue
to thedepthStencil
field.
-
set
public VkClearValue set(VkClearValue src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkClearValue malloc()
Returns a newVkClearValue
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkClearValue calloc()
Returns a newVkClearValue
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkClearValue create()
Returns a newVkClearValue
instance allocated withBufferUtils
.
-
create
public static VkClearValue create(long address)
Returns a newVkClearValue
instance for the specified memory address.
-
createSafe
@Nullable public static VkClearValue createSafe(long address)
-
malloc
public static VkClearValue.Buffer malloc(int capacity)
Returns a newVkClearValue.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkClearValue.Buffer calloc(int capacity)
Returns a newVkClearValue.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkClearValue.Buffer create(int capacity)
Returns a newVkClearValue.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkClearValue.Buffer create(long address, int capacity)
Create aVkClearValue.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkClearValue.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkClearValue mallocStack()
Returns a newVkClearValue
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkClearValue callocStack()
Returns a newVkClearValue
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkClearValue mallocStack(MemoryStack stack)
Returns a newVkClearValue
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkClearValue callocStack(MemoryStack stack)
Returns a newVkClearValue
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkClearValue.Buffer mallocStack(int capacity)
Returns a newVkClearValue.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkClearValue.Buffer callocStack(int capacity)
Returns a newVkClearValue.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkClearValue.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkClearValue.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkClearValue.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkClearValue.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
ncolor
public static VkClearColorValue ncolor(long struct)
Unsafe version ofcolor()
.
-
ndepthStencil
public static VkClearDepthStencilValue ndepthStencil(long struct)
Unsafe version ofdepthStencil()
.
-
ncolor
public static void ncolor(long struct, VkClearColorValue value)
Unsafe version ofcolor
.
-
ndepthStencil
public static void ndepthStencil(long struct, VkClearDepthStencilValue value)
Unsafe version ofdepthStencil
.
-
-