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 class
VkClearColorValue.Buffer
An array ofVkClearColorValue
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 VkClearColorValue(java.nio.ByteBuffer container)
Creates aVkClearColorValue
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 static VkClearColorValue
calloc()
Returns a newVkClearColorValue
instance allocated withmemCalloc
.static VkClearColorValue.Buffer
calloc(int capacity)
Returns a newVkClearColorValue.Buffer
instance allocated withmemCalloc
.static VkClearColorValue
callocStack()
Returns a newVkClearColorValue
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkClearColorValue.Buffer
callocStack(int capacity)
Returns a newVkClearColorValue.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkClearColorValue.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkClearColorValue.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkClearColorValue
callocStack(MemoryStack stack)
Returns a newVkClearColorValue
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkClearColorValue
create()
Returns a newVkClearColorValue
instance allocated withBufferUtils
.static VkClearColorValue.Buffer
create(int capacity)
Returns a newVkClearColorValue.Buffer
instance allocated withBufferUtils
.static VkClearColorValue
create(long address)
Returns a newVkClearColorValue
instance for the specified memory address ornull
if the address isNULL
.static VkClearColorValue.Buffer
create(long address, int capacity)
Create aVkClearColorValue.Buffer
instance at the specified memory.java.nio.FloatBuffer
float32()
Returns aFloatBuffer
view of thefloat32
field.VkClearColorValue
float32(java.nio.FloatBuffer value)
Copies the specifiedFloatBuffer
to thefloat32
field.float
float32(int index)
Returns the value at the specified index of thefloat32
field.VkClearColorValue
float32(int index, float value)
Sets the specified value at the specified index of thefloat32
field.java.nio.IntBuffer
int32()
Returns aIntBuffer
view of theint32
field.int
int32(int index)
Returns the value at the specified index of theint32
field.VkClearColorValue
int32(java.nio.IntBuffer value)
Copies the specifiedIntBuffer
to theint32
field.VkClearColorValue
int32(int index, int value)
Sets the specified value at the specified index of theint32
field.static VkClearColorValue
malloc()
Returns a newVkClearColorValue
instance allocated withmemAlloc
.static VkClearColorValue.Buffer
malloc(int capacity)
Returns a newVkClearColorValue.Buffer
instance allocated withmemAlloc
.static VkClearColorValue
mallocStack()
Returns a newVkClearColorValue
instance allocated on the thread-localMemoryStack
.static VkClearColorValue.Buffer
mallocStack(int capacity)
Returns a newVkClearColorValue.Buffer
instance allocated on the thread-localMemoryStack
.static VkClearColorValue.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkClearColorValue.Buffer
instance allocated on the specifiedMemoryStack
.static VkClearColorValue
mallocStack(MemoryStack stack)
Returns a newVkClearColorValue
instance allocated on the specifiedMemoryStack
.VkClearColorValue
nset(long struct)
Unsafe version ofset
.VkClearColorValue
set(VkClearColorValue src)
Copies the specified struct data to this struct.int
sizeof()
Returns thesizeof(struct)
.java.nio.IntBuffer
uint32()
Returns aIntBuffer
view of theuint32
field.int
uint32(int index)
Returns the value at the specified index of theuint32
field.VkClearColorValue
uint32(java.nio.IntBuffer value)
Copies the specifiedIntBuffer
to theuint32
field.VkClearColorValue
uint32(int index, int value)
Sets the specified value at the specified index of theuint32
field.-
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 aVkClearColorValue
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)
.
-
float32
public java.nio.FloatBuffer float32()
Returns aFloatBuffer
view of thefloat32
field.
-
float32
public float float32(int index)
Returns the value at the specified index of thefloat32
field.
-
int32
public java.nio.IntBuffer int32()
Returns aIntBuffer
view of theint32
field.
-
int32
public int int32(int index)
Returns the value at the specified index of theint32
field.
-
uint32
public java.nio.IntBuffer uint32()
Returns aIntBuffer
view of theuint32
field.
-
uint32
public int uint32(int index)
Returns the value at the specified index of theuint32
field.
-
float32
public VkClearColorValue float32(java.nio.FloatBuffer value)
Copies the specifiedFloatBuffer
to thefloat32
field.
-
float32
public VkClearColorValue float32(int index, float value)
Sets the specified value at the specified index of thefloat32
field.
-
int32
public VkClearColorValue int32(java.nio.IntBuffer value)
Copies the specifiedIntBuffer
to theint32
field.
-
int32
public VkClearColorValue int32(int index, int value)
Sets the specified value at the specified index of theint32
field.
-
uint32
public VkClearColorValue uint32(java.nio.IntBuffer value)
Copies the specifiedIntBuffer
to theuint32
field.
-
uint32
public VkClearColorValue uint32(int index, int value)
Sets the specified value at the specified index of theuint32
field.
-
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 newVkClearColorValue
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkClearColorValue calloc()
Returns a newVkClearColorValue
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkClearColorValue create()
Returns a newVkClearColorValue
instance allocated withBufferUtils
.
-
create
public static VkClearColorValue create(long address)
Returns a newVkClearColorValue
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkClearColorValue.Buffer malloc(int capacity)
Returns a newVkClearColorValue.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkClearColorValue.Buffer calloc(int capacity)
Returns a newVkClearColorValue.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkClearColorValue.Buffer create(int capacity)
Returns a newVkClearColorValue.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkClearColorValue.Buffer create(long address, int capacity)
Create aVkClearColorValue.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkClearColorValue mallocStack()
Returns a newVkClearColorValue
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkClearColorValue callocStack()
Returns a newVkClearColorValue
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkClearColorValue mallocStack(MemoryStack stack)
Returns a newVkClearColorValue
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkClearColorValue callocStack(MemoryStack stack)
Returns a newVkClearColorValue
instance allocated on the specifiedMemoryStack
and 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.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkClearColorValue.Buffer callocStack(int capacity)
Returns a newVkClearColorValue.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkClearColorValue.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkClearColorValue.Buffer
instance 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.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-