Package org.lwjgl.vulkan
Class VkClearAttachment
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkClearAttachment
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkClearAttachment extends Struct
Khronos Reference Page
Vulkan SpecificationDefines an attachment to clear and the clear values to use.
Valid Usage
aspectMask
must be a valid combination ofVkImageAspectFlagBits
valuesaspectMask
must not be 0- If
aspectMask
includesIMAGE_ASPECT_COLOR_BIT
, it must not includeIMAGE_ASPECT_DEPTH_BIT
orIMAGE_ASPECT_STENCIL_BIT
aspectMask
must not includeIMAGE_ASPECT_METADATA_BIT
Member documentation
aspectMask
– a bitmask selecting the color, depth and/or stencil aspects of the attachment to be cleared. One or more of:IMAGE_ASPECT_COLOR_BIT
IMAGE_ASPECT_DEPTH_BIT
IMAGE_ASPECT_METADATA_BIT
IMAGE_ASPECT_STENCIL_BIT
colorAttachment
– is only meaningful ifIMAGE_ASPECT_COLOR_BIT
is set inaspectMask
, in which case it is an index to thepColorAttachments
array in theVkSubpassDescription
structure of the current subpass which selects the color attachment to clearclearValue
– the color or depth/stencil value to clear the attachment to
Layout
struct VkClearAttachment { VkImageAspectFlags aspectMask; uint32_t colorAttachment;
VkClearValue
clearValue; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkClearAttachment.Buffer
An array ofVkClearAttachment
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkClearAttachment(java.nio.ByteBuffer container)
Creates aVkClearAttachment
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description int
aspectMask()
Returns the value of theaspectMask
field.VkClearAttachment
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
callocStack()
Returns a newVkClearAttachment
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkClearAttachment.Buffer
callocStack(int capacity)
Returns a newVkClearAttachment.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkClearAttachment.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkClearAttachment.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkClearAttachment
callocStack(MemoryStack stack)
Returns a newVkClearAttachment
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.VkClearValue
clearValue()
Returns aVkClearValue
view of theclearValue
field.VkClearAttachment
clearValue(VkClearValue value)
Copies the specifiedVkClearValue
to theclearValue
field.int
colorAttachment()
Returns the value of thecolorAttachment
field.VkClearAttachment
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 ornull
if the address isNULL
.static VkClearAttachment.Buffer
create(long address, int capacity)
Create aVkClearAttachment.Buffer
instance at the specified memory.static VkClearAttachment
malloc()
Returns a newVkClearAttachment
instance allocated withmemAlloc
.static VkClearAttachment.Buffer
malloc(int capacity)
Returns a newVkClearAttachment.Buffer
instance allocated withmemAlloc
.static VkClearAttachment
mallocStack()
Returns a newVkClearAttachment
instance allocated on the thread-localMemoryStack
.static VkClearAttachment.Buffer
mallocStack(int capacity)
Returns a newVkClearAttachment.Buffer
instance allocated on the thread-localMemoryStack
.static VkClearAttachment.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkClearAttachment.Buffer
instance allocated on the specifiedMemoryStack
.static VkClearAttachment
mallocStack(MemoryStack stack)
Returns a newVkClearAttachment
instance allocated on the specifiedMemoryStack
.VkClearAttachment
nset(long struct)
Unsafe version ofset
.VkClearAttachment
set(VkClearAttachment src)
Copies the specified struct data to this struct.int
sizeof()
Returns thesizeof(struct)
.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkClearAttachment
public VkClearAttachment(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
aspectMask
public int aspectMask()
Returns the value of theaspectMask
field.
-
colorAttachment
public int colorAttachment()
Returns the value of thecolorAttachment
field.
-
clearValue
public VkClearValue clearValue()
Returns aVkClearValue
view of theclearValue
field.
-
aspectMask
public VkClearAttachment aspectMask(int value)
Sets the specified value to theaspectMask
field.
-
colorAttachment
public VkClearAttachment colorAttachment(int value)
Sets the specified value to thecolorAttachment
field.
-
clearValue
public VkClearAttachment clearValue(VkClearValue value)
Copies the specifiedVkClearValue
to theclearValue
field.
-
nset
public VkClearAttachment nset(long struct)
Unsafe version ofset
.
-
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 newVkClearAttachment
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkClearAttachment calloc()
Returns a newVkClearAttachment
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkClearAttachment create()
Returns a newVkClearAttachment
instance allocated withBufferUtils
.
-
create
public static VkClearAttachment create(long address)
Returns a newVkClearAttachment
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkClearAttachment.Buffer malloc(int capacity)
Returns a newVkClearAttachment.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkClearAttachment.Buffer calloc(int capacity)
Returns a newVkClearAttachment.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkClearAttachment.Buffer create(int capacity)
Returns a newVkClearAttachment.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkClearAttachment.Buffer create(long address, int capacity)
Create aVkClearAttachment.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkClearAttachment mallocStack()
Returns a newVkClearAttachment
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkClearAttachment callocStack()
Returns a newVkClearAttachment
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkClearAttachment mallocStack(MemoryStack stack)
Returns a newVkClearAttachment
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkClearAttachment callocStack(MemoryStack stack)
Returns a newVkClearAttachment
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkClearAttachment.Buffer mallocStack(int capacity)
Returns a newVkClearAttachment.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkClearAttachment.Buffer callocStack(int capacity)
Returns a newVkClearAttachment.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkClearAttachment.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkClearAttachment.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkClearAttachment.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkClearAttachment.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-