Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDebugUtilsLabelEXT

extends Struct<VkDebugUtilsLabelEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Specify parameters of a label region.
Valid Usage (Implicit)
See Also

VkDebugUtilsMessengerCallbackDataEXT, CmdBeginDebugUtilsLabelEXT, CmdInsertDebugUtilsLabelEXT, QueueBeginDebugUtilsLabelEXT, QueueInsertDebugUtilsLabelEXT

Layout


struct VkDebugUtilsLabelEXT {
    VkStructureType sType;
    void const * pNext;
    char const * pLabelName;
    float color[4];
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
COLOR

The struct member offsets.

public static final int
PLABELNAME

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkDebugUtilsLabelEXT(long address, ByteBuffer container)

public
VkDebugUtilsLabelEXT(ByteBuffer container)

Creates a VkDebugUtilsLabelEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkDebugUtilsLabelEXT
calloc()

Returns a new VkDebugUtilsLabelEXT instance allocated with memCalloc.

public static VkDebugUtilsLabelEXT.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkDebugUtilsLabelEXT.Buffer instance allocated with memCalloc.

public static VkDebugUtilsLabelEXT
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkDebugUtilsLabelEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkDebugUtilsLabelEXT.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkDebugUtilsLabelEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkDebugUtilsLabelEXT
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkDebugUtilsLabelEXT
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDebugUtilsLabelEXT.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDebugUtilsLabelEXT.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public FloatBuffer
color()

an optional RGBA color value that can be associated with the label.

public float
color(int index)

an optional RGBA color value that can be associated with the label.

public VkDebugUtilsLabelEXT
color(FloatBuffer value)

Copies the specified FloatBuffer to the color field.

public VkDebugUtilsLabelEXT
color(int index, float value)

Sets the specified value at the specified index of the color field.

protected VkDebugUtilsLabelEXT
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkDebugUtilsLabelEXT
create()

Returns a new VkDebugUtilsLabelEXT instance allocated with BufferUtils.

public static VkDebugUtilsLabelEXT
create(long address)

Returns a new VkDebugUtilsLabelEXT instance for the specified memory address.

public static VkDebugUtilsLabelEXT.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkDebugUtilsLabelEXT.Buffer instance allocated with BufferUtils.

public static VkDebugUtilsLabelEXT.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkDebugUtilsLabelEXT.Buffer instance at the specified memory.

public static VkDebugUtilsLabelEXT
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkDebugUtilsLabelEXT.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkDebugUtilsLabelEXT
malloc()

Returns a new VkDebugUtilsLabelEXT instance allocated with memAlloc.

public static VkDebugUtilsLabelEXT.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkDebugUtilsLabelEXT.Buffer instance allocated with memAlloc.

public static VkDebugUtilsLabelEXT
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkDebugUtilsLabelEXT instance allocated on the specified MemoryStack.

public static VkDebugUtilsLabelEXT.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkDebugUtilsLabelEXT.Buffer instance allocated on the specified MemoryStack.

public static VkDebugUtilsLabelEXT
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkDebugUtilsLabelEXT
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDebugUtilsLabelEXT.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDebugUtilsLabelEXT.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static FloatBuffer
ncolor(long struct)

Unsafe version of color.

public static float
ncolor(long struct, int index)

Unsafe version of color.

public static void
ncolor(long struct, FloatBuffer value)

Unsafe version of color.

public static void
ncolor(long struct, int index, float value)

Unsafe version of color.

public static ByteBuffer
npLabelName(long struct)

Unsafe version of pLabelName.

public static void
npLabelName(long struct, ByteBuffer value)

Unsafe version of pLabelName.

public static String
npLabelNameString(long struct)

Unsafe version of pLabelNameString.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public ByteBuffer
pLabelName()

a pointer to a null-terminated UTF-8 string containing the name of the label.

public VkDebugUtilsLabelEXT
pLabelName(ByteBuffer value)

Sets the address of the specified encoded string to the pLabelName field.

public String
pLabelNameString()

a pointer to a null-terminated UTF-8 string containing the name of the label.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkDebugUtilsLabelEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkDebugUtilsLabelEXT
set(int sType, long pNext, ByteBuffer pLabelName, FloatBuffer color)

Initializes this struct with the specified values.

public VkDebugUtilsLabelEXT

Returns:

this struct
set
(VkDebugUtilsLabelEXT
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkDebugUtilsLabelEXT
sType(int value)

Sets the specified value to the sType field.

public VkDebugUtilsLabelEXT
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

COLORback to summary
public static final int COLOR

The struct member offsets.

PLABELNAMEback to summary
public static final int PLABELNAME

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkDebugUtilsLabelEXTback to summary
protected VkDebugUtilsLabelEXT(long address, ByteBuffer container)
VkDebugUtilsLabelEXTback to summary
public VkDebugUtilsLabelEXT(ByteBuffer container)

Creates a VkDebugUtilsLabelEXT instance at the current position of the specified ByteBuffer 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

callocback to summary
public static VkDebugUtilsLabelEXT calloc()

Returns a new VkDebugUtilsLabelEXT instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkDebugUtilsLabelEXT.Buffer calloc(int capacity)

Returns a new VkDebugUtilsLabelEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDebugUtilsLabelEXT calloc(MemoryStack stack)

Returns a new VkDebugUtilsLabelEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkDebugUtilsLabelEXT.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkDebugUtilsLabelEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkDebugUtilsLabelEXT callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkDebugUtilsLabelEXT callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkDebugUtilsLabelEXT.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkDebugUtilsLabelEXT.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
colorback to summary
public FloatBuffer color()

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 in color are set to 0.0 then it is ignored.

Annotations
@NativeType:float[4]
colorback to summary
public float color(int index)

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 in color are set to 0.0 then it is ignored.

colorback to summary
public VkDebugUtilsLabelEXT color(FloatBuffer value)

Copies the specified FloatBuffer to the color field.

colorback to summary
public VkDebugUtilsLabelEXT color(int index, float value)

Sets the specified value at the specified index of the color field.

createback to summary
protected VkDebugUtilsLabelEXT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkDebugUtilsLabelEXT create()

Returns a new VkDebugUtilsLabelEXT instance allocated with BufferUtils.

createback to summary
public static VkDebugUtilsLabelEXT create(long address)

Returns a new VkDebugUtilsLabelEXT instance for the specified memory address.

createback to summary
public static VkDebugUtilsLabelEXT.Buffer create(int capacity)

Returns a new VkDebugUtilsLabelEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkDebugUtilsLabelEXT.Buffer create(long address, int capacity)

Create a VkDebugUtilsLabelEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDebugUtilsLabelEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkDebugUtilsLabelEXT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkDebugUtilsLabelEXT malloc()

Returns a new VkDebugUtilsLabelEXT instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkDebugUtilsLabelEXT.Buffer malloc(int capacity)

Returns a new VkDebugUtilsLabelEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDebugUtilsLabelEXT malloc(MemoryStack stack)

Returns a new VkDebugUtilsLabelEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkDebugUtilsLabelEXT.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkDebugUtilsLabelEXT.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkDebugUtilsLabelEXT mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkDebugUtilsLabelEXT mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkDebugUtilsLabelEXT.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkDebugUtilsLabelEXT.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
ncolorback to summary
public static FloatBuffer ncolor(long struct)

Unsafe version of color.

ncolorback to summary
public static float ncolor(long struct, int index)

Unsafe version of color.

ncolorback to summary
public static void ncolor(long struct, FloatBuffer value)

Unsafe version of color.

ncolorback to summary
public static void ncolor(long struct, int index, float value)

Unsafe version of color.

npLabelNameback to summary
public static ByteBuffer npLabelName(long struct)

Unsafe version of pLabelName.

npLabelNameback to summary
public static void npLabelName(long struct, ByteBuffer value)

Unsafe version of pLabelName.

npLabelNameStringback to summary
public static String npLabelNameString(long struct)

Unsafe version of pLabelNameString.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pLabelNameback to summary
public ByteBuffer pLabelName()

a pointer to a null-terminated UTF-8 string containing the name of the label.

Annotations
@NativeType:char const *
pLabelNameback to summary
public VkDebugUtilsLabelEXT pLabelName(ByteBuffer value)

Sets the address of the specified encoded string to the pLabelName field.

pLabelNameStringback to summary
public String pLabelNameString()

a pointer to a null-terminated UTF-8 string containing the name of the label.

Annotations
@NativeType:char const *
pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkDebugUtilsLabelEXT pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkDebugUtilsLabelEXT set(int sType, long pNext, ByteBuffer pLabelName, FloatBuffer color)

Initializes this struct with the specified values.

setback to summary
public VkDebugUtilsLabelEXT set(VkDebugUtilsLabelEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkDebugUtilsLabelEXT

the source struct

Returns:VkDebugUtilsLabelEXT

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkDebugUtilsLabelEXT sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkDebugUtilsLabelEXT sType$Default()

Sets the STRUCTURE_TYPE_DEBUG_UTILS_LABEL_EXT value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkDebugUtilsLabelEXT.Buffer

extends StructBuffer<VkDebugUtilsLabelEXT, VkDebugUtilsLabelEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkDebugUtilsLabelEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkDebugUtilsLabelEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDebugUtilsLabelEXT.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public FloatBuffer

Returns:

a FloatBuffer view of the VkDebugUtilsLabelEXT#color field.
color
()

public float

Returns:

the value at the specified index of the VkDebugUtilsLabelEXT#color field.
color
(int index)

public VkDebugUtilsLabelEXT.Buffer
color(FloatBuffer value)

Copies the specified FloatBuffer to the VkDebugUtilsLabelEXT#color field.

public VkDebugUtilsLabelEXT.Buffer
color(int index, float value)

Sets the specified value at the specified index of the VkDebugUtilsLabelEXT#color field.

protected VkDebugUtilsLabelEXT
public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the VkDebugUtilsLabelEXT#pLabelName field.
pLabelName
()

public VkDebugUtilsLabelEXT.Buffer
pLabelName(ByteBuffer value)

Sets the address of the specified encoded string to the VkDebugUtilsLabelEXT#pLabelName field.

public String

Returns:

the null-terminated string pointed to by the VkDebugUtilsLabelEXT#pLabelName field.
pLabelNameString
()

public long

Returns:

the value of the VkDebugUtilsLabelEXT#pNext field.
pNext
()

public VkDebugUtilsLabelEXT.Buffer
pNext(long value)

Sets the specified value to the VkDebugUtilsLabelEXT#pNext field.

protected VkDebugUtilsLabelEXT.Buffer
public int

Returns:

the value of the VkDebugUtilsLabelEXT#sType field.
sType
()

public VkDebugUtilsLabelEXT.Buffer
sType(int value)

Sets the specified value to the VkDebugUtilsLabelEXT#sType field.

public VkDebugUtilsLabelEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDebugUtilsLabelEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkDebugUtilsLabelEXT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkDebugUtilsLabelEXT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

colorback to summary
public FloatBuffer color()
Returns:FloatBuffer

a FloatBuffer view of the VkDebugUtilsLabelEXT#color field.

Annotations
@NativeType:float[4]
colorback to summary
public float color(int index)
Returns:float

the value at the specified index of the VkDebugUtilsLabelEXT#color field.

colorback to summary
public VkDebugUtilsLabelEXT.Buffer color(FloatBuffer value)

Copies the specified FloatBuffer to the VkDebugUtilsLabelEXT#color field.

colorback to summary
public VkDebugUtilsLabelEXT.Buffer color(int index, float value)

Sets the specified value at the specified index of the VkDebugUtilsLabelEXT#color field.

getElementFactoryback to summary
protected VkDebugUtilsLabelEXT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pLabelNameback to summary
public ByteBuffer pLabelName()
Returns:ByteBuffer

a ByteBuffer view of the null-terminated string pointed to by the VkDebugUtilsLabelEXT#pLabelName field.

Annotations
@NativeType:char const *
pLabelNameback to summary
public VkDebugUtilsLabelEXT.Buffer pLabelName(ByteBuffer value)

Sets the address of the specified encoded string to the VkDebugUtilsLabelEXT#pLabelName field.

pLabelNameStringback to summary
public String pLabelNameString()
Returns:String

the null-terminated string pointed to by the VkDebugUtilsLabelEXT#pLabelName field.

Annotations
@NativeType:char const *
pNextback to summary
public long pNext()
Returns:long

the value of the VkDebugUtilsLabelEXT#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkDebugUtilsLabelEXT.Buffer pNext(long value)

Sets the specified value to the VkDebugUtilsLabelEXT#pNext field.

selfback to summary
protected VkDebugUtilsLabelEXT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkDebugUtilsLabelEXT#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkDebugUtilsLabelEXT.Buffer sType(int value)

Sets the specified value to the VkDebugUtilsLabelEXT#sType field.

sType$Defaultback to summary
public VkDebugUtilsLabelEXT.Buffer sType$Default()

Sets the STRUCTURE_TYPE_DEBUG_UTILS_LABEL_EXT value to the VkDebugUtilsLabelEXT#sType field.