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
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkClearColorValue extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying a clear color value.Description
The four array elements of the clear color map to R, G, B, and A components of image formats, in order.
If the image has more than one sample, the same value is written to all samples for any pixels being cleared.
See Also
VkClearValue
,CmdClearColorImage
Member documentation
float32[4]
– are the color clear values when the format of the image or attachment is one of the formats in the Interpretation of Numeric Format table other than signed integer (SINT
) or unsigned integer (UINT
). Floating point values are automatically converted to the format of the image, with the clear value being treated as linear if the image is sRGB.int32[4]
– are the color clear values when the format of the image or attachment is signed integer (SINT
). Signed integer values are converted to the format of the image by casting to the smaller type (with negative 32-bit values mapping to negative values in the smaller type). If the integer clear value is not representable in the target type (e.g. would overflow in conversion to that type), the clear value is undefined.uint32[4]
– are the color clear values when the format of the image or attachment is unsigned integer (UINT
). Unsigned integer values are converted to the format of the image by casting to the integer type with fewer bits.
Layout
union VkClearColorValue { float float32[4]; int32_t int32[4]; uint32_t uint32[4]; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkClearColorValue.Buffer
An array ofVkClearColorValue
structs.
-
Constructor Summary
Constructors Constructor 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 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, org.lwjgl.system.MemoryStack stack)
Returns a newVkClearColorValue.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkClearColorValue
callocStack(org.lwjgl.system.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.static VkClearColorValue.Buffer
create(long address, int capacity)
Create aVkClearColorValue.Buffer
instance at the specified memory.static VkClearColorValue
createSafe(long address)
static VkClearColorValue.Buffer
createSafe(long address, int capacity)
java.nio.FloatBuffer
float32()
Returns aFloatBuffer
view of 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.VkClearColorValue
float32(java.nio.FloatBuffer value)
Copies the specifiedFloatBuffer
to 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(int index, int value)
Sets the specified value at the specified index of theint32
field.VkClearColorValue
int32(java.nio.IntBuffer value)
Copies the specifiedIntBuffer
to 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, org.lwjgl.system.MemoryStack stack)
Returns a newVkClearColorValue.Buffer
instance allocated on the specifiedMemoryStack
.static VkClearColorValue
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkClearColorValue
instance allocated on the specifiedMemoryStack
.static java.nio.FloatBuffer
nfloat32(long struct)
Unsafe version offloat32()
.static float
nfloat32(long struct, int index)
Unsafe version offloat32
.static void
nfloat32(long struct, int index, float value)
Unsafe version offloat32
.static void
nfloat32(long struct, java.nio.FloatBuffer value)
Unsafe version offloat32
.static java.nio.IntBuffer
nint32(long struct)
Unsafe version ofint32()
.static int
nint32(long struct, int index)
Unsafe version ofint32
.static void
nint32(long struct, int index, int value)
Unsafe version ofint32
.static void
nint32(long struct, java.nio.IntBuffer value)
Unsafe version ofint32
.static java.nio.IntBuffer
nuint32(long struct)
Unsafe version ofuint32()
.static int
nuint32(long struct, int index)
Unsafe version ofuint32
.static void
nuint32(long struct, int index, int value)
Unsafe version ofuint32
.static void
nuint32(long struct, java.nio.IntBuffer value)
Unsafe version ofuint32
.VkClearColorValue
set(VkClearColorValue src)
Copies the specified struct data to this struct.int
sizeof()
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(int index, int value)
Sets the specified value at the specified index of theuint32
field.VkClearColorValue
uint32(java.nio.IntBuffer value)
Copies the specifiedIntBuffer
to theuint32
field.
-
-
-
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()
- Specified by:
sizeof
in classorg.lwjgl.system.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.
-
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.
-
createSafe
@Nullable public static VkClearColorValue createSafe(long address)
-
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
-
createSafe
@Nullable public static VkClearColorValue.Buffer createSafe(long address, int 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(org.lwjgl.system.MemoryStack stack)
Returns a newVkClearColorValue
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkClearColorValue callocStack(org.lwjgl.system.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, org.lwjgl.system.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, org.lwjgl.system.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
-
nfloat32
public static java.nio.FloatBuffer nfloat32(long struct)
Unsafe version offloat32()
.
-
nfloat32
public static float nfloat32(long struct, int index)
Unsafe version offloat32
.
-
nint32
public static java.nio.IntBuffer nint32(long struct)
Unsafe version ofint32()
.
-
nint32
public static int nint32(long struct, int index)
Unsafe version ofint32
.
-
nuint32
public static java.nio.IntBuffer nuint32(long struct)
Unsafe version ofuint32()
.
-
nuint32
public static int nuint32(long struct, int index)
Unsafe version ofuint32
.
-
nfloat32
public static void nfloat32(long struct, java.nio.FloatBuffer value)
Unsafe version offloat32
.
-
nfloat32
public static void nfloat32(long struct, int index, float value)
Unsafe version offloat32
.
-
nint32
public static void nint32(long struct, java.nio.IntBuffer value)
Unsafe version ofint32
.
-
nint32
public static void nint32(long struct, int index, int value)
Unsafe version ofint32
.
-
nuint32
public static void nuint32(long struct, java.nio.IntBuffer value)
Unsafe version ofuint32
.
-
nuint32
public static void nuint32(long struct, int index, int value)
Unsafe version ofuint32
.
-
-