Package org.lwjgl.openxr

Class XrDebugUtilsObjectNameInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrDebugUtilsObjectNameInfoEXT>

org.lwjgl.openxr.XrDebugUtilsObjectNameInfoEXT

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class XrDebugUtilsObjectNameInfoEXT
extends org.lwjgl.system.Struct<XrDebugUtilsObjectNameInfoEXT>
implements org.lwjgl.system.NativeResource

Debug utils object name info.

Valid Usage

• If objectType is OBJECT_TYPE_UNKNOWN, objectHandle must not be NULL_HANDLE
• If objectType is not OBJECT_TYPE_UNKNOWN, objectHandle must be NULL_HANDLE or an OpenXR handle of the type associated with objectType

Valid Usage (Implicit)

• The XR_EXT_debug_utils extension must be enabled prior to using XrDebugUtilsObjectNameInfoEXT
• type must be TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT
• next must be NULL or a valid pointer to the next structure in a structure chain
• objectType must be a valid XrObjectType value
• If objectName is not NULL, objectName must be a null-terminated UTF-8 string

See Also

XrDebugUtilsMessengerCallbackDataEXT, SetDebugUtilsObjectNameEXT

Layout

 struct XrDebugUtilsObjectNameInfoEXT {
     XrStructureType type();
     void const * next();
     XrObjectType objectType();
     uint64_t objectHandle();
     char const * objectName();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrDebugUtilsObjectNameInfoEXT.Buffer	An array of XrDebugUtilsObjectNameInfoEXT structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	NEXT	The struct member offsets.
static final int	OBJECTHANDLE	The struct member offsets.
static final int	OBJECTNAME	The struct member offsets.
static final int	OBJECTTYPE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
XrDebugUtilsObjectNameInfoEXT(ByteBuffer container)	Creates a XrDebugUtilsObjectNameInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrDebugUtilsObjectNameInfoEXT	calloc()	Returns a new XrDebugUtilsObjectNameInfoEXT instance allocated with memCalloc.
static XrDebugUtilsObjectNameInfoEXT.Buffer	calloc(int capacity)	Returns a new XrDebugUtilsObjectNameInfoEXT.Buffer instance allocated with memCalloc.
static XrDebugUtilsObjectNameInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrDebugUtilsObjectNameInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrDebugUtilsObjectNameInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrDebugUtilsObjectNameInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrDebugUtilsObjectNameInfoEXT	create()	Returns a new XrDebugUtilsObjectNameInfoEXT instance allocated with BufferUtils.
static XrDebugUtilsObjectNameInfoEXT.Buffer	create(int capacity)	Returns a new XrDebugUtilsObjectNameInfoEXT.Buffer instance allocated with BufferUtils.
static XrDebugUtilsObjectNameInfoEXT	create(long address)	Returns a new XrDebugUtilsObjectNameInfoEXT instance for the specified memory address.
static XrDebugUtilsObjectNameInfoEXT.Buffer	create(long address, int capacity)	Create a XrDebugUtilsObjectNameInfoEXT.Buffer instance at the specified memory.
static @Nullable XrDebugUtilsObjectNameInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrDebugUtilsObjectNameInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrDebugUtilsObjectNameInfoEXT	malloc()	Returns a new XrDebugUtilsObjectNameInfoEXT instance allocated with memAlloc.
static XrDebugUtilsObjectNameInfoEXT.Buffer	malloc(int capacity)	Returns a new XrDebugUtilsObjectNameInfoEXT.Buffer instance allocated with memAlloc.
static XrDebugUtilsObjectNameInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrDebugUtilsObjectNameInfoEXT.Buffer instance allocated on the specified MemoryStack.
static XrDebugUtilsObjectNameInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrDebugUtilsObjectNameInfoEXT instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrDebugUtilsObjectNameInfoEXT	next(long value)	Sets the specified value to the next() field.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static long	nobjectHandle(long struct)	Unsafe version of objectHandle().
static void	nobjectHandle(long struct, long value)	Unsafe version of objectHandle.
static @Nullable ByteBuffer	nobjectName(long struct)	Unsafe version of objectName().
static void	nobjectName(long struct, @Nullable ByteBuffer value)	Unsafe version of objectName.
static @Nullable String	nobjectNameString(long struct)	Unsafe version of objectNameString().
static int	nobjectType(long struct)	Unsafe version of objectType().
static void	nobjectType(long struct, int value)	Unsafe version of objectType.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
long	objectHandle()	the object to be named.
XrDebugUtilsObjectNameInfoEXT	objectHandle(long value)	Sets the specified value to the objectHandle() field.
@Nullable ByteBuffer	objectName()	a NULL terminated UTF-8 string specifying the name to apply to objectHandle.
XrDebugUtilsObjectNameInfoEXT	objectName(@Nullable ByteBuffer value)	Sets the address of the specified encoded string to the objectName() field.
@Nullable String	objectNameString()	a NULL terminated UTF-8 string specifying the name to apply to objectHandle.
int	objectType()	an XrObjectType specifying the type of the object to be named.
XrDebugUtilsObjectNameInfoEXT	objectType(int value)	Sets the specified value to the objectType() field.
XrDebugUtilsObjectNameInfoEXT	set(int type, long next, int objectType, long objectHandle, @Nullable ByteBuffer objectName)	Initializes this struct with the specified values.
XrDebugUtilsObjectNameInfoEXT	set(XrDebugUtilsObjectNameInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrDebugUtilsObjectNameInfoEXT	type(int value)	Sets the specified value to the type() field.
XrDebugUtilsObjectNameInfoEXT	type$Default()	Sets the TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT value to the type() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

TYPE

public static final int TYPE

The struct member offsets.

NEXT

public static final int NEXT

The struct member offsets.

OBJECTTYPE

public static final int OBJECTTYPE

The struct member offsets.

OBJECTHANDLE

public static final int OBJECTHANDLE

The struct member offsets.

OBJECTNAME

public static final int OBJECTNAME

The struct member offsets.

Constructor Details

XrDebugUtilsObjectNameInfoEXT

public XrDebugUtilsObjectNameInfoEXT(ByteBuffer container)

Creates a XrDebugUtilsObjectNameInfoEXT 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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<XrDebugUtilsObjectNameInfoEXT>

type

public int type()

the XrStructureType of this structure.

next

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.

objectType

public int objectType()

an XrObjectType specifying the type of the object to be named.

objectHandle

public long objectHandle()

the object to be named.

objectName

public @Nullable ByteBuffer objectName()

a NULL terminated UTF-8 string specifying the name to apply to objectHandle.

objectNameString

public @Nullable String objectNameString()

a NULL terminated UTF-8 string specifying the name to apply to objectHandle.

type

public XrDebugUtilsObjectNameInfoEXT type(int value)

Sets the specified value to the type() field.

type$Default

public XrDebugUtilsObjectNameInfoEXT type$Default()

Sets the TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT value to the type() field.

next

public XrDebugUtilsObjectNameInfoEXT next(long value)

Sets the specified value to the next() field.

objectType

public XrDebugUtilsObjectNameInfoEXT objectType(int value)

Sets the specified value to the objectType() field.

objectHandle

public XrDebugUtilsObjectNameInfoEXT objectHandle(long value)

Sets the specified value to the objectHandle() field.

objectName

public XrDebugUtilsObjectNameInfoEXT objectName(@Nullable ByteBuffer value)

Sets the address of the specified encoded string to the objectName() field.

set

public XrDebugUtilsObjectNameInfoEXT set(int type,
 long next,
 int objectType,
 long objectHandle,
 @Nullable ByteBuffer objectName)

Initializes this struct with the specified values.

set

public XrDebugUtilsObjectNameInfoEXT set(XrDebugUtilsObjectNameInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrDebugUtilsObjectNameInfoEXT malloc()

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

calloc

public static XrDebugUtilsObjectNameInfoEXT calloc()

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

create

public static XrDebugUtilsObjectNameInfoEXT create()

Returns a new XrDebugUtilsObjectNameInfoEXT instance allocated with BufferUtils.

create

public static XrDebugUtilsObjectNameInfoEXT create(long address)

Returns a new XrDebugUtilsObjectNameInfoEXT instance for the specified memory address.

createSafe

public static @Nullable XrDebugUtilsObjectNameInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrDebugUtilsObjectNameInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrDebugUtilsObjectNameInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrDebugUtilsObjectNameInfoEXT.Buffer create(int capacity)

Returns a new XrDebugUtilsObjectNameInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static XrDebugUtilsObjectNameInfoEXT.Buffer create(long address,
 int capacity)

Create a XrDebugUtilsObjectNameInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable XrDebugUtilsObjectNameInfoEXT.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static XrDebugUtilsObjectNameInfoEXT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrDebugUtilsObjectNameInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static XrDebugUtilsObjectNameInfoEXT calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static XrDebugUtilsObjectNameInfoEXT.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static XrDebugUtilsObjectNameInfoEXT.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

ntype

public static int ntype(long struct)

Unsafe version of type().

nnext

public static long nnext(long struct)

Unsafe version of next().

nobjectType

public static int nobjectType(long struct)

Unsafe version of objectType().

nobjectHandle

public static long nobjectHandle(long struct)

Unsafe version of objectHandle().

nobjectName

public static @Nullable ByteBuffer nobjectName(long struct)

Unsafe version of objectName().

nobjectNameString

public static @Nullable String nobjectNameString(long struct)

Unsafe version of objectNameString().

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nnext

public static void nnext(long struct,
 long value)

Unsafe version of next.

nobjectType

public static void nobjectType(long struct,
 int value)

Unsafe version of objectType.

nobjectHandle

public static void nobjectHandle(long struct,
 long value)

Unsafe version of objectHandle.

nobjectName

public static void nobjectName(long struct,
 @Nullable ByteBuffer value)

Unsafe version of objectName.