Package org.lwjgl.vulkan
Class VkClearColorValue
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkClearColorValue
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkClearColorValue extends Struct
Khronos Reference Page
Vulkan SpecificationSpecifies the color image clear values to use when clearing a color image or attachment.
Member documentation
float32– used for floating point, unorm, snorm, uscaled, packed float, and sRGB formatsint32– used for signed integer formatsuint32– used for unsigned integer formats
Layout
union VkClearColorValue { float[4] float32; int32_t[4] int32; uint32_t[4] uint32; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classVkClearColorValue.BufferAn array ofVkClearColorValuestructs.-
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 VkClearColorValue(java.nio.ByteBuffer container)Creates aVkClearColorValueinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkClearColorValuecalloc()Returns a newVkClearColorValueinstance allocated withmemCalloc.static VkClearColorValue.Buffercalloc(int capacity)Returns a newVkClearColorValue.Bufferinstance allocated withmemCalloc.static VkClearColorValuecallocStack()Returns a newVkClearColorValueinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkClearColorValue.BuffercallocStack(int capacity)Returns a newVkClearColorValue.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkClearColorValue.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkClearColorValue.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkClearColorValuecallocStack(MemoryStack stack)Returns a newVkClearColorValueinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkClearColorValuecreate()Returns a newVkClearColorValueinstance allocated withBufferUtils.static VkClearColorValue.Buffercreate(int capacity)Returns a newVkClearColorValue.Bufferinstance allocated withBufferUtils.static VkClearColorValuecreate(long address)Returns a newVkClearColorValueinstance for the specified memory address ornullif the address isNULL.static VkClearColorValue.Buffercreate(long address, int capacity)Create aVkClearColorValue.Bufferinstance at the specified memory.java.nio.FloatBufferfloat32()Returns aFloatBufferview of thefloat32field.VkClearColorValuefloat32(java.nio.FloatBuffer value)Copies the specifiedFloatBufferto thefloat32field.floatfloat32(int index)Returns the value at the specified index of thefloat32field.VkClearColorValuefloat32(int index, float value)Sets the specified value at the specified index of thefloat32field.java.nio.IntBufferint32()Returns aIntBufferview of theint32field.intint32(int index)Returns the value at the specified index of theint32field.VkClearColorValueint32(java.nio.IntBuffer value)Copies the specifiedIntBufferto theint32field.VkClearColorValueint32(int index, int value)Sets the specified value at the specified index of theint32field.static VkClearColorValuemalloc()Returns a newVkClearColorValueinstance allocated withmemAlloc.static VkClearColorValue.Buffermalloc(int capacity)Returns a newVkClearColorValue.Bufferinstance allocated withmemAlloc.static VkClearColorValuemallocStack()Returns a newVkClearColorValueinstance allocated on the thread-localMemoryStack.static VkClearColorValue.BuffermallocStack(int capacity)Returns a newVkClearColorValue.Bufferinstance allocated on the thread-localMemoryStack.static VkClearColorValue.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkClearColorValue.Bufferinstance allocated on the specifiedMemoryStack.static VkClearColorValuemallocStack(MemoryStack stack)Returns a newVkClearColorValueinstance allocated on the specifiedMemoryStack.VkClearColorValuenset(long struct)Unsafe version ofset.VkClearColorValueset(VkClearColorValue src)Copies the specified struct data to this struct.intsizeof()Returns thesizeof(struct).java.nio.IntBufferuint32()Returns aIntBufferview of theuint32field.intuint32(int index)Returns the value at the specified index of theuint32field.VkClearColorValueuint32(java.nio.IntBuffer value)Copies the specifiedIntBufferto theuint32field.VkClearColorValueuint32(int index, int value)Sets the specified value at the specified index of theuint32field.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkClearColorValue
public VkClearColorValue(java.nio.ByteBuffer container)
Creates aVkClearColorValueinstance 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).
-
float32
public java.nio.FloatBuffer float32()
Returns aFloatBufferview of thefloat32field.
-
float32
public float float32(int index)
Returns the value at the specified index of thefloat32field.
-
int32
public java.nio.IntBuffer int32()
Returns aIntBufferview of theint32field.
-
int32
public int int32(int index)
Returns the value at the specified index of theint32field.
-
uint32
public java.nio.IntBuffer uint32()
Returns aIntBufferview of theuint32field.
-
uint32
public int uint32(int index)
Returns the value at the specified index of theuint32field.
-
float32
public VkClearColorValue float32(java.nio.FloatBuffer value)
Copies the specifiedFloatBufferto thefloat32field.
-
float32
public VkClearColorValue float32(int index, float value)
Sets the specified value at the specified index of thefloat32field.
-
int32
public VkClearColorValue int32(java.nio.IntBuffer value)
Copies the specifiedIntBufferto theint32field.
-
int32
public VkClearColorValue int32(int index, int value)
Sets the specified value at the specified index of theint32field.
-
uint32
public VkClearColorValue uint32(java.nio.IntBuffer value)
Copies the specifiedIntBufferto theuint32field.
-
uint32
public VkClearColorValue uint32(int index, int value)
Sets the specified value at the specified index of theuint32field.
-
nset
public VkClearColorValue nset(long struct)
Unsafe version ofset.
-
set
public VkClearColorValue set(VkClearColorValue src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkClearColorValue malloc()
Returns a newVkClearColorValueinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkClearColorValue calloc()
Returns a newVkClearColorValueinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkClearColorValue create()
Returns a newVkClearColorValueinstance allocated withBufferUtils.
-
create
public static VkClearColorValue create(long address)
Returns a newVkClearColorValueinstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkClearColorValue.Buffer malloc(int capacity)
Returns a newVkClearColorValue.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkClearColorValue.Buffer calloc(int capacity)
Returns a newVkClearColorValue.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkClearColorValue.Buffer create(int capacity)
Returns a newVkClearColorValue.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkClearColorValue.Buffer create(long address, int capacity)
Create aVkClearColorValue.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkClearColorValue mallocStack()
Returns a newVkClearColorValueinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkClearColorValue callocStack()
Returns a newVkClearColorValueinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkClearColorValue mallocStack(MemoryStack stack)
Returns a newVkClearColorValueinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkClearColorValue callocStack(MemoryStack stack)
Returns a newVkClearColorValueinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkClearColorValue.Buffer mallocStack(int capacity)
Returns a newVkClearColorValue.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkClearColorValue.Buffer callocStack(int capacity)
Returns a newVkClearColorValue.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkClearColorValue.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkClearColorValue.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkClearColorValue.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkClearColorValue.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
-