Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrDebugUtilsLabelEXT

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

Debug Utils Label.
Valid Usage (Implicit)
See Also

XrDebugUtilsMessengerCallbackDataEXT, SessionBeginDebugUtilsLabelRegionEXT, SessionInsertDebugUtilsLabelEXT

Layout


struct XrDebugUtilsLabelEXT {
    XrStructureType type;
    void const * next;
    char const * labelName;
}

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
LABELNAME

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrDebugUtilsLabelEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrDebugUtilsLabelEXT
calloc()

Returns a new XrDebugUtilsLabelEXT instance allocated with memCalloc.

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

Returns a new XrDebugUtilsLabelEXT.Buffer instance allocated with memCalloc.

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

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

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

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

protected XrDebugUtilsLabelEXT
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 XrDebugUtilsLabelEXT
create()

Returns a new XrDebugUtilsLabelEXT instance allocated with BufferUtils.

public static XrDebugUtilsLabelEXT
create(long address)

Returns a new XrDebugUtilsLabelEXT instance for the specified memory address.

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

Returns a new XrDebugUtilsLabelEXT.Buffer instance allocated with BufferUtils.

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

Create a XrDebugUtilsLabelEXT.Buffer instance at the specified memory.

public static XrDebugUtilsLabelEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public ByteBuffer
labelName()

a NULL terminated UTF-8 string specifying the label name.

public XrDebugUtilsLabelEXT
labelName(ByteBuffer value)

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

public String
labelNameString()

a NULL terminated UTF-8 string specifying the label name.

public static XrDebugUtilsLabelEXT
malloc()

Returns a new XrDebugUtilsLabelEXT instance allocated with memAlloc.

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

Returns a new XrDebugUtilsLabelEXT.Buffer instance allocated with memAlloc.

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

Returns a new XrDebugUtilsLabelEXT instance allocated on the specified MemoryStack.

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

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

public long
next()

NULL or a pointer to the next structure in a structure chain.

public XrDebugUtilsLabelEXT
next(long value)

Sets the specified value to the next field.

public static ByteBuffer
nlabelName(long struct)

Unsafe version of labelName.

public static void
nlabelName(long struct, ByteBuffer value)

Unsafe version of labelName.

public static String
nlabelNameString(long struct)

Unsafe version of labelNameString.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrDebugUtilsLabelEXT
set(int type, long next, ByteBuffer labelName)

Initializes this struct with the specified values.

public XrDebugUtilsLabelEXT

Returns:

this struct
set
(XrDebugUtilsLabelEXT
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
type()

the XrStructureType of this structure.

public XrDebugUtilsLabelEXT
type(int value)

Sets the specified value to the type field.

public XrDebugUtilsLabelEXT
type$Default()

Sets the TYPE_DEBUG_UTILS_LABEL_EXT value to the type field.

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.

LABELNAMEback to summary
public static final int LABELNAME

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrDebugUtilsLabelEXTback to summary
protected XrDebugUtilsLabelEXT(long address, ByteBuffer container)
XrDebugUtilsLabelEXTback to summary
public XrDebugUtilsLabelEXT(ByteBuffer container)

Creates a XrDebugUtilsLabelEXT 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 XrDebugUtilsLabelEXT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrDebugUtilsLabelEXT calloc(MemoryStack stack)

Returns a new XrDebugUtilsLabelEXT 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 XrDebugUtilsLabelEXT.Buffer calloc(int capacity, MemoryStack stack)

Returns a new XrDebugUtilsLabelEXT.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

createback to summary
protected XrDebugUtilsLabelEXT 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 XrDebugUtilsLabelEXT create()

Returns a new XrDebugUtilsLabelEXT instance allocated with BufferUtils.

createback to summary
public static XrDebugUtilsLabelEXT create(long address)

Returns a new XrDebugUtilsLabelEXT instance for the specified memory address.

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

Returns a new XrDebugUtilsLabelEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrDebugUtilsLabelEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrDebugUtilsLabelEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
labelNameback to summary
public ByteBuffer labelName()

a NULL terminated UTF-8 string specifying the label name.

Annotations
@NativeType:char const *
labelNameback to summary
public XrDebugUtilsLabelEXT labelName(ByteBuffer value)

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

labelNameStringback to summary
public String labelNameString()

a NULL terminated UTF-8 string specifying the label name.

Annotations
@NativeType:char const *
mallocback to summary
public static XrDebugUtilsLabelEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrDebugUtilsLabelEXT malloc(MemoryStack stack)

Returns a new XrDebugUtilsLabelEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nextback to summary
public long next()

NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.

Annotations
@NativeType:void const *
nextback to summary
public XrDebugUtilsLabelEXT next(long value)

Sets the specified value to the next field.

nlabelNameback to summary
public static ByteBuffer nlabelName(long struct)

Unsafe version of labelName.

nlabelNameback to summary
public static void nlabelName(long struct, ByteBuffer value)

Unsafe version of labelName.

nlabelNameStringback to summary
public static String nlabelNameString(long struct)

Unsafe version of labelNameString.

nnextback to summary
public static long nnext(long struct)

Unsafe version of next.

nnextback to summary
public static void nnext(long struct, long value)

Unsafe version of next.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

setback to summary
public XrDebugUtilsLabelEXT set(int type, long next, ByteBuffer labelName)

Initializes this struct with the specified values.

setback to summary
public XrDebugUtilsLabelEXT set(XrDebugUtilsLabelEXT src)

Copies the specified struct data to this struct.

Parameters
src:XrDebugUtilsLabelEXT

the source struct

Returns:XrDebugUtilsLabelEXT

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
typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrDebugUtilsLabelEXT type(int value)

Sets the specified value to the type field.

type$Defaultback to summary
public XrDebugUtilsLabelEXT type$Default()

Sets the TYPE_DEBUG_UTILS_LABEL_EXT value to the type 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.openxr back to summary

public Class XrDebugUtilsLabelEXT.Buffer

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

An array of XrDebugUtilsLabelEXT structs.

Field Summary

Modifier and TypeField and Description
private static final XrDebugUtilsLabelEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrDebugUtilsLabelEXT.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
protected XrDebugUtilsLabelEXT
public ByteBuffer

Returns:

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

public XrDebugUtilsLabelEXT.Buffer
labelName(ByteBuffer value)

Sets the address of the specified encoded string to the XrDebugUtilsLabelEXT#labelName field.

public String

Returns:

the null-terminated string pointed to by the XrDebugUtilsLabelEXT#labelName field.
labelNameString
()

public long

Returns:

the value of the XrDebugUtilsLabelEXT#next field.
next
()

public XrDebugUtilsLabelEXT.Buffer
next(long value)

Sets the specified value to the XrDebugUtilsLabelEXT#next field.

protected XrDebugUtilsLabelEXT.Buffer
public int

Returns:

the value of the XrDebugUtilsLabelEXT#type field.
type
()

public XrDebugUtilsLabelEXT.Buffer
type(int value)

Sets the specified value to the XrDebugUtilsLabelEXT#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrDebugUtilsLabelEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrDebugUtilsLabelEXT.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 XrDebugUtilsLabelEXT#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

getElementFactoryback to summary
protected XrDebugUtilsLabelEXT getElementFactory()

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

Annotations
@Override
labelNameback to summary
public ByteBuffer labelName()
Returns:ByteBuffer

a ByteBuffer view of the null-terminated string pointed to by the XrDebugUtilsLabelEXT#labelName field.

Annotations
@NativeType:char const *
labelNameback to summary
public XrDebugUtilsLabelEXT.Buffer labelName(ByteBuffer value)

Sets the address of the specified encoded string to the XrDebugUtilsLabelEXT#labelName field.

labelNameStringback to summary
public String labelNameString()
Returns:String

the null-terminated string pointed to by the XrDebugUtilsLabelEXT#labelName field.

Annotations
@NativeType:char const *
nextback to summary
public long next()
Returns:long

the value of the XrDebugUtilsLabelEXT#next field.

Annotations
@NativeType:void const *
nextback to summary
public XrDebugUtilsLabelEXT.Buffer next(long value)

Sets the specified value to the XrDebugUtilsLabelEXT#next field.

selfback to summary
protected XrDebugUtilsLabelEXT.Buffer self()

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

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrDebugUtilsLabelEXT#type field.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrDebugUtilsLabelEXT.Buffer type(int value)

Sets the specified value to the XrDebugUtilsLabelEXT#type field.

type$Defaultback to summary
public XrDebugUtilsLabelEXT.Buffer type$Default()

Sets the TYPE_DEBUG_UTILS_LABEL_EXT value to the XrDebugUtilsLabelEXT#type field.