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 {VkRect2Drect; uint32_t baseArrayLayer; uint32_t layerCount; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classVkClearRect.BufferAn array ofVkClearRectstructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe 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 aVkClearRectinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description intbaseArrayLayer()Returns the value of thebaseArrayLayerfield.VkClearRectbaseArrayLayer(int value)Sets the specified value to thebaseArrayLayerfield.static VkClearRectcalloc()Returns a newVkClearRectinstance allocated withmemCalloc.static VkClearRect.Buffercalloc(int capacity)Returns a newVkClearRect.Bufferinstance allocated withmemCalloc.static VkClearRectcallocStack()Returns a newVkClearRectinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkClearRect.BuffercallocStack(int capacity)Returns a newVkClearRect.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkClearRect.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkClearRect.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkClearRectcallocStack(MemoryStack stack)Returns a newVkClearRectinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkClearRectcreate()Returns a newVkClearRectinstance allocated withBufferUtils.static VkClearRect.Buffercreate(int capacity)Returns a newVkClearRect.Bufferinstance allocated withBufferUtils.static VkClearRectcreate(long address)static VkClearRect.Buffercreate(long address, int capacity)Create aVkClearRect.Bufferinstance at the specified memory.intlayerCount()Returns the value of thelayerCountfield.VkClearRectlayerCount(int value)Sets the specified value to thelayerCountfield.static VkClearRectmalloc()Returns a newVkClearRectinstance allocated withmemAlloc.static VkClearRect.Buffermalloc(int capacity)Returns a newVkClearRect.Bufferinstance allocated withmemAlloc.static VkClearRectmallocStack()Returns a newVkClearRectinstance allocated on the thread-localMemoryStack.static VkClearRect.BuffermallocStack(int capacity)Returns a newVkClearRect.Bufferinstance allocated on the thread-localMemoryStack.static VkClearRect.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkClearRect.Bufferinstance allocated on the specifiedMemoryStack.static VkClearRectmallocStack(MemoryStack stack)Returns a newVkClearRectinstance allocated on the specifiedMemoryStack.VkClearRectnset(long struct)Unsafe version ofset.VkRect2Drect()Returns aVkRect2Dview of therectfield.VkClearRectrect(VkRect2D value)Copies the specifiedVkRect2Dto therectfield.VkClearRectset(VkClearRect src)Copies the specified struct data to this struct.VkClearRectset(VkRect2D rect, int baseArrayLayer, int layerCount)Initializes this struct with the specified values.intsizeof()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 aVkClearRectinstance 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 Detail
-
sizeof
public int sizeof()
Description copied from class:StructReturns thesizeof(struct).
-
baseArrayLayer
public int baseArrayLayer()
Returns the value of thebaseArrayLayerfield.
-
layerCount
public int layerCount()
Returns the value of thelayerCountfield.
-
rect
public VkClearRect rect(VkRect2D value)
Copies the specifiedVkRect2Dto therectfield.
-
baseArrayLayer
public VkClearRect baseArrayLayer(int value)
Sets the specified value to thebaseArrayLayerfield.
-
layerCount
public VkClearRect layerCount(int value)
Sets the specified value to thelayerCountfield.
-
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 newVkClearRectinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkClearRect calloc()
Returns a newVkClearRectinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkClearRect create()
Returns a newVkClearRectinstance allocated withBufferUtils.
-
create
public static VkClearRect create(long address)
-
malloc
public static VkClearRect.Buffer malloc(int capacity)
Returns a newVkClearRect.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkClearRect.Buffer calloc(int capacity)
Returns a newVkClearRect.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkClearRect.Buffer create(int capacity)
Returns a newVkClearRect.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkClearRect.Buffer create(long address, int capacity)
Create aVkClearRect.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkClearRect mallocStack()
Returns a newVkClearRectinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkClearRect callocStack()
Returns a newVkClearRectinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkClearRect mallocStack(MemoryStack stack)
Returns a newVkClearRectinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkClearRect callocStack(MemoryStack stack)
Returns a newVkClearRectinstance allocated on the specifiedMemoryStackand 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.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkClearRect.Buffer callocStack(int capacity)
Returns a newVkClearRect.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkClearRect.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkClearRect.Bufferinstance 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.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
-