Package org.lwjgl.vulkan
Class VkDebugUtilsLabelEXT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDebugUtilsLabelEXT
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkDebugUtilsLabelEXT extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Specify parameters of a label region.Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_DEBUG_UTILS_LABEL_EXT
pNext
must beNULL
pLabelName
must be a null-terminated UTF-8 string
See Also
VkDebugUtilsMessengerCallbackDataEXT
,CmdBeginDebugUtilsLabelEXT
,CmdInsertDebugUtilsLabelEXT
,QueueBeginDebugUtilsLabelEXT
,QueueInsertDebugUtilsLabelEXT
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.pLabelName
– a pointer to a null-terminated UTF-8 string that contains the name of the label.color[4]
– an optional RGBA color value that can be associated with the label. A particular implementation may choose to ignore this color value. The values contain RGBA values in order, in the range 0.0 to 1.0. If all elements incolor
are set to 0.0 then it is ignored.
Layout
struct VkDebugUtilsLabelEXT { VkStructureType sType; void const * pNext; char const * pLabelName; float color[4]; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkDebugUtilsLabelEXT.Buffer
An array ofVkDebugUtilsLabelEXT
structs.
-
Constructor Summary
Constructors Constructor Description VkDebugUtilsLabelEXT(java.nio.ByteBuffer container)
Creates aVkDebugUtilsLabelEXT
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 VkDebugUtilsLabelEXT
calloc()
Returns a newVkDebugUtilsLabelEXT
instance allocated withmemCalloc
.static VkDebugUtilsLabelEXT.Buffer
calloc(int capacity)
Returns a newVkDebugUtilsLabelEXT.Buffer
instance allocated withmemCalloc
.static VkDebugUtilsLabelEXT
callocStack()
Returns a newVkDebugUtilsLabelEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDebugUtilsLabelEXT.Buffer
callocStack(int capacity)
Returns a newVkDebugUtilsLabelEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDebugUtilsLabelEXT.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsLabelEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDebugUtilsLabelEXT
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsLabelEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.java.nio.FloatBuffer
color()
Returns aFloatBuffer
view of thecolor
field.float
color(int index)
Returns the value at the specified index of thecolor
field.VkDebugUtilsLabelEXT
color(int index, float value)
Sets the specified value at the specified index of thecolor
field.VkDebugUtilsLabelEXT
color(java.nio.FloatBuffer value)
Copies the specifiedFloatBuffer
to thecolor
field.static VkDebugUtilsLabelEXT
create()
Returns a newVkDebugUtilsLabelEXT
instance allocated withBufferUtils
.static VkDebugUtilsLabelEXT.Buffer
create(int capacity)
Returns a newVkDebugUtilsLabelEXT.Buffer
instance allocated withBufferUtils
.static VkDebugUtilsLabelEXT
create(long address)
Returns a newVkDebugUtilsLabelEXT
instance for the specified memory address.static VkDebugUtilsLabelEXT.Buffer
create(long address, int capacity)
Create aVkDebugUtilsLabelEXT.Buffer
instance at the specified memory.static VkDebugUtilsLabelEXT
createSafe(long address)
static VkDebugUtilsLabelEXT.Buffer
createSafe(long address, int capacity)
static VkDebugUtilsLabelEXT
malloc()
Returns a newVkDebugUtilsLabelEXT
instance allocated withmemAlloc
.static VkDebugUtilsLabelEXT.Buffer
malloc(int capacity)
Returns a newVkDebugUtilsLabelEXT.Buffer
instance allocated withmemAlloc
.static VkDebugUtilsLabelEXT
mallocStack()
Returns a newVkDebugUtilsLabelEXT
instance allocated on the thread-localMemoryStack
.static VkDebugUtilsLabelEXT.Buffer
mallocStack(int capacity)
Returns a newVkDebugUtilsLabelEXT.Buffer
instance allocated on the thread-localMemoryStack
.static VkDebugUtilsLabelEXT.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsLabelEXT.Buffer
instance allocated on the specifiedMemoryStack
.static VkDebugUtilsLabelEXT
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsLabelEXT
instance allocated on the specifiedMemoryStack
.static java.nio.FloatBuffer
ncolor(long struct)
Unsafe version ofcolor()
.static float
ncolor(long struct, int index)
Unsafe version ofcolor
.static void
ncolor(long struct, int index, float value)
Unsafe version ofcolor
.static void
ncolor(long struct, java.nio.FloatBuffer value)
Unsafe version ofcolor
.static java.nio.ByteBuffer
npLabelName(long struct)
Unsafe version ofpLabelName()
.static void
npLabelName(long struct, java.nio.ByteBuffer value)
Unsafe version ofpLabelName
.static java.lang.String
npLabelNameString(long struct)
Unsafe version ofpLabelNameString()
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.java.nio.ByteBuffer
pLabelName()
Returns aByteBuffer
view of the null-terminated string pointed to by thepLabelName
field.VkDebugUtilsLabelEXT
pLabelName(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to thepLabelName
field.java.lang.String
pLabelNameString()
Decodes the null-terminated string pointed to by thepLabelName
field.long
pNext()
Returns the value of thepNext
field.VkDebugUtilsLabelEXT
pNext(long value)
Sets the specified value to thepNext
field.VkDebugUtilsLabelEXT
set(int sType, long pNext, java.nio.ByteBuffer pLabelName, java.nio.FloatBuffer color)
Initializes this struct with the specified values.VkDebugUtilsLabelEXT
set(VkDebugUtilsLabelEXT src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkDebugUtilsLabelEXT
sType(int value)
Sets the specified value to thesType
field.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.
-
-
-
Constructor Detail
-
VkDebugUtilsLabelEXT
public VkDebugUtilsLabelEXT(java.nio.ByteBuffer container)
Creates aVkDebugUtilsLabelEXT
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
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
pLabelName
public java.nio.ByteBuffer pLabelName()
Returns aByteBuffer
view of the null-terminated string pointed to by thepLabelName
field.
-
pLabelNameString
public java.lang.String pLabelNameString()
Decodes the null-terminated string pointed to by thepLabelName
field.
-
color
public java.nio.FloatBuffer color()
Returns aFloatBuffer
view of thecolor
field.
-
color
public float color(int index)
Returns the value at the specified index of thecolor
field.
-
sType
public VkDebugUtilsLabelEXT sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkDebugUtilsLabelEXT pNext(long value)
Sets the specified value to thepNext
field.
-
pLabelName
public VkDebugUtilsLabelEXT pLabelName(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to thepLabelName
field.
-
color
public VkDebugUtilsLabelEXT color(java.nio.FloatBuffer value)
Copies the specifiedFloatBuffer
to thecolor
field.
-
color
public VkDebugUtilsLabelEXT color(int index, float value)
Sets the specified value at the specified index of thecolor
field.
-
set
public VkDebugUtilsLabelEXT set(int sType, long pNext, java.nio.ByteBuffer pLabelName, java.nio.FloatBuffer color)
Initializes this struct with the specified values.
-
set
public VkDebugUtilsLabelEXT set(VkDebugUtilsLabelEXT src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkDebugUtilsLabelEXT malloc()
Returns a newVkDebugUtilsLabelEXT
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDebugUtilsLabelEXT calloc()
Returns a newVkDebugUtilsLabelEXT
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDebugUtilsLabelEXT create()
Returns a newVkDebugUtilsLabelEXT
instance allocated withBufferUtils
.
-
create
public static VkDebugUtilsLabelEXT create(long address)
Returns a newVkDebugUtilsLabelEXT
instance for the specified memory address.
-
createSafe
@Nullable public static VkDebugUtilsLabelEXT createSafe(long address)
-
malloc
public static VkDebugUtilsLabelEXT.Buffer malloc(int capacity)
Returns a newVkDebugUtilsLabelEXT.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDebugUtilsLabelEXT.Buffer calloc(int capacity)
Returns a newVkDebugUtilsLabelEXT.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDebugUtilsLabelEXT.Buffer create(int capacity)
Returns a newVkDebugUtilsLabelEXT.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDebugUtilsLabelEXT.Buffer create(long address, int capacity)
Create aVkDebugUtilsLabelEXT.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkDebugUtilsLabelEXT.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkDebugUtilsLabelEXT mallocStack()
Returns a newVkDebugUtilsLabelEXT
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDebugUtilsLabelEXT callocStack()
Returns a newVkDebugUtilsLabelEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDebugUtilsLabelEXT mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsLabelEXT
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDebugUtilsLabelEXT callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsLabelEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkDebugUtilsLabelEXT.Buffer mallocStack(int capacity)
Returns a newVkDebugUtilsLabelEXT.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDebugUtilsLabelEXT.Buffer callocStack(int capacity)
Returns a newVkDebugUtilsLabelEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDebugUtilsLabelEXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsLabelEXT.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkDebugUtilsLabelEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsLabelEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType()
.
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext()
.
-
npLabelName
public static java.nio.ByteBuffer npLabelName(long struct)
Unsafe version ofpLabelName()
.
-
npLabelNameString
public static java.lang.String npLabelNameString(long struct)
Unsafe version ofpLabelNameString()
.
-
ncolor
public static java.nio.FloatBuffer ncolor(long struct)
Unsafe version ofcolor()
.
-
ncolor
public static float ncolor(long struct, int index)
Unsafe version ofcolor
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
npLabelName
public static void npLabelName(long struct, java.nio.ByteBuffer value)
Unsafe version ofpLabelName
.
-
ncolor
public static void ncolor(long struct, java.nio.FloatBuffer value)
Unsafe version ofcolor
.
-
ncolor
public static void ncolor(long struct, int index, float value)
Unsafe version ofcolor
.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-
validate
public static void validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-