Package org.lwjgl.vulkan
Class VkClearRect
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkClearRect
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkClearRect extends Struct
Khronos Reference Page
Vulkan SpecificationDefines a region within an attachment to clear.
Member documentation
rect
– the two-dimensional region to be clearedbaseArrayLayer
– the first layer to be clearedlayerCount
– the number of layers to clear
Layout
struct VkClearRect {
VkRect2D
rect; uint32_t baseArrayLayer; uint32_t layerCount; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkClearRect.Buffer
An array ofVkClearRect
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 VkClearRect(java.nio.ByteBuffer container)
Creates aVkClearRect
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
baseArrayLayer()
Returns the value of thebaseArrayLayer
field.VkClearRect
baseArrayLayer(int value)
Sets the specified value to thebaseArrayLayer
field.static VkClearRect
calloc()
Returns a newVkClearRect
instance allocated withmemCalloc
.static VkClearRect.Buffer
calloc(int capacity)
Returns a newVkClearRect.Buffer
instance allocated withmemCalloc
.static VkClearRect
callocStack()
Returns a newVkClearRect
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkClearRect.Buffer
callocStack(int capacity)
Returns a newVkClearRect.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkClearRect.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkClearRect.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkClearRect
callocStack(MemoryStack stack)
Returns a newVkClearRect
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkClearRect
create()
Returns a newVkClearRect
instance allocated withBufferUtils
.static VkClearRect.Buffer
create(int capacity)
Returns a newVkClearRect.Buffer
instance allocated withBufferUtils
.static VkClearRect
create(long address)
static VkClearRect.Buffer
create(long address, int capacity)
Create aVkClearRect.Buffer
instance at the specified memory.int
layerCount()
Returns the value of thelayerCount
field.VkClearRect
layerCount(int value)
Sets the specified value to thelayerCount
field.static VkClearRect
malloc()
Returns a newVkClearRect
instance allocated withmemAlloc
.static VkClearRect.Buffer
malloc(int capacity)
Returns a newVkClearRect.Buffer
instance allocated withmemAlloc
.static VkClearRect
mallocStack()
Returns a newVkClearRect
instance allocated on the thread-localMemoryStack
.static VkClearRect.Buffer
mallocStack(int capacity)
Returns a newVkClearRect.Buffer
instance allocated on the thread-localMemoryStack
.static VkClearRect.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkClearRect.Buffer
instance allocated on the specifiedMemoryStack
.static VkClearRect
mallocStack(MemoryStack stack)
Returns a newVkClearRect
instance allocated on the specifiedMemoryStack
.VkClearRect
nset(long struct)
Unsafe version ofset
.VkRect2D
rect()
Returns aVkRect2D
view of therect
field.VkClearRect
rect(VkRect2D value)
Copies the specifiedVkRect2D
to therect
field.VkClearRect
set(VkClearRect src)
Copies the specified struct data to this struct.VkClearRect
set(VkRect2D rect, int baseArrayLayer, int layerCount)
Initializes this struct with the specified values.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
-
VkClearRect
public VkClearRect(java.nio.ByteBuffer container)
Creates aVkClearRect
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)
.
-
baseArrayLayer
public int baseArrayLayer()
Returns the value of thebaseArrayLayer
field.
-
layerCount
public int layerCount()
Returns the value of thelayerCount
field.
-
rect
public VkClearRect rect(VkRect2D value)
Copies the specifiedVkRect2D
to therect
field.
-
baseArrayLayer
public VkClearRect baseArrayLayer(int value)
Sets the specified value to thebaseArrayLayer
field.
-
layerCount
public VkClearRect layerCount(int value)
Sets the specified value to thelayerCount
field.
-
set
public VkClearRect set(VkRect2D rect, int baseArrayLayer, int layerCount)
Initializes this struct with the specified values.
-
nset
public VkClearRect nset(long struct)
Unsafe version ofset
.
-
set
public VkClearRect set(VkClearRect src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkClearRect malloc()
Returns a newVkClearRect
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkClearRect calloc()
Returns a newVkClearRect
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkClearRect create()
Returns a newVkClearRect
instance allocated withBufferUtils
.
-
create
public static VkClearRect create(long address)
-
malloc
public static VkClearRect.Buffer malloc(int capacity)
Returns a newVkClearRect.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkClearRect.Buffer calloc(int capacity)
Returns a newVkClearRect.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkClearRect.Buffer create(int capacity)
Returns a newVkClearRect.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkClearRect.Buffer create(long address, int capacity)
Create aVkClearRect.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkClearRect mallocStack()
Returns a newVkClearRect
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkClearRect callocStack()
Returns a newVkClearRect
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkClearRect mallocStack(MemoryStack stack)
Returns a newVkClearRect
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkClearRect callocStack(MemoryStack stack)
Returns a newVkClearRect
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkClearRect.Buffer mallocStack(int capacity)
Returns a newVkClearRect.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkClearRect.Buffer callocStack(int capacity)
Returns a newVkClearRect.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkClearRect.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkClearRect.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkClearRect.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkClearRect.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-