Package org.lwjgl.openxr

Class XrDebugUtilsMessengerCallbackDataEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrDebugUtilsMessengerCallbackDataEXT>

org.lwjgl.openxr.XrDebugUtilsMessengerCallbackDataEXT

All Implemented Interfaces:

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

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

Debug utils messenger callback data.

Valid Usage (Implicit)

• The XR_EXT_debug_utils extension must be enabled prior to using XrDebugUtilsMessengerCallbackDataEXT
• type must be TYPE_DEBUG_UTILS_MESSENGER_CALLBACK_DATA_EXT
• next must be NULL or a valid pointer to the next structure in a structure chain
• If messageId is not NULL, messageId must be a null-terminated UTF-8 string
• If functionName is not NULL, functionName must be a null-terminated UTF-8 string
• message must be a null-terminated UTF-8 string

An XrDebugUtilsMessengerCallbackDataEXT is a messenger object that handles passing along debug messages to a provided debug callback.

Note

This structure should only be considered valid during the lifetime of the triggered callback.

The labels listed inside sessionLabels are organized in time order, with the most recently generated label appearing first, and the oldest label appearing last.

See Also

XrDebugUtilsLabelEXT, XrDebugUtilsObjectNameInfoEXT, SubmitDebugUtilsMessageEXT

Layout

 struct XrDebugUtilsMessengerCallbackDataEXT {
     XrStructureType type();
     void const * next();
     char const * messageId();
     char const * functionName();
     char const * message();
     uint32_t objectCount();
     XrDebugUtilsObjectNameInfoEXT * objects();
     uint32_t sessionLabelCount();
     XrDebugUtilsLabelEXT * sessionLabels();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrDebugUtilsMessengerCallbackDataEXT.Buffer	An array of XrDebugUtilsMessengerCallbackDataEXT 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	FUNCTIONNAME	The struct member offsets.
static final int	MESSAGE	The struct member offsets.
static final int	MESSAGEID	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	OBJECTCOUNT	The struct member offsets.
static final int	OBJECTS	The struct member offsets.
static final int	SESSIONLABELCOUNT	The struct member offsets.
static final int	SESSIONLABELS	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
XrDebugUtilsMessengerCallbackDataEXT(ByteBuffer container)	Creates a XrDebugUtilsMessengerCallbackDataEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrDebugUtilsMessengerCallbackDataEXT	calloc()	Returns a new XrDebugUtilsMessengerCallbackDataEXT instance allocated with memCalloc.
static XrDebugUtilsMessengerCallbackDataEXT.Buffer	calloc(int capacity)	Returns a new XrDebugUtilsMessengerCallbackDataEXT.Buffer instance allocated with memCalloc.
static XrDebugUtilsMessengerCallbackDataEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrDebugUtilsMessengerCallbackDataEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrDebugUtilsMessengerCallbackDataEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrDebugUtilsMessengerCallbackDataEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrDebugUtilsMessengerCallbackDataEXT	create()	Returns a new XrDebugUtilsMessengerCallbackDataEXT instance allocated with BufferUtils.
static XrDebugUtilsMessengerCallbackDataEXT.Buffer	create(int capacity)	Returns a new XrDebugUtilsMessengerCallbackDataEXT.Buffer instance allocated with BufferUtils.
static XrDebugUtilsMessengerCallbackDataEXT	create(long address)	Returns a new XrDebugUtilsMessengerCallbackDataEXT instance for the specified memory address.
static XrDebugUtilsMessengerCallbackDataEXT.Buffer	create(long address, int capacity)	Create a XrDebugUtilsMessengerCallbackDataEXT.Buffer instance at the specified memory.
static @Nullable XrDebugUtilsMessengerCallbackDataEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrDebugUtilsMessengerCallbackDataEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
@Nullable ByteBuffer	functionName()	a NULL terminated string that identifies the OpenXR function that was executing at the time the message callback was triggered.
XrDebugUtilsMessengerCallbackDataEXT	functionName(@Nullable ByteBuffer value)	Sets the address of the specified encoded string to the functionName() field.
@Nullable String	functionNameString()	a NULL terminated string that identifies the OpenXR function that was executing at the time the message callback was triggered.
static XrDebugUtilsMessengerCallbackDataEXT	malloc()	Returns a new XrDebugUtilsMessengerCallbackDataEXT instance allocated with memAlloc.
static XrDebugUtilsMessengerCallbackDataEXT.Buffer	malloc(int capacity)	Returns a new XrDebugUtilsMessengerCallbackDataEXT.Buffer instance allocated with memAlloc.
static XrDebugUtilsMessengerCallbackDataEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrDebugUtilsMessengerCallbackDataEXT.Buffer instance allocated on the specified MemoryStack.
static XrDebugUtilsMessengerCallbackDataEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrDebugUtilsMessengerCallbackDataEXT instance allocated on the specified MemoryStack.
ByteBuffer	message()	a NULL terminated string detailing the trigger conditions.
XrDebugUtilsMessengerCallbackDataEXT	message(ByteBuffer value)	Sets the address of the specified encoded string to the message() field.
@Nullable ByteBuffer	messageId()	a NULL terminated string that identifies the message in a unique way.
XrDebugUtilsMessengerCallbackDataEXT	messageId(@Nullable ByteBuffer value)	Sets the address of the specified encoded string to the messageId() field.
@Nullable String	messageIdString()	a NULL terminated string that identifies the message in a unique way.
String	messageString()	a NULL terminated string detailing the trigger conditions.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrDebugUtilsMessengerCallbackDataEXT	next(long value)	Sets the specified value to the next() field.
static @Nullable ByteBuffer	nfunctionName(long struct)	Unsafe version of functionName().
static void	nfunctionName(long struct, @Nullable ByteBuffer value)	Unsafe version of functionName.
static @Nullable String	nfunctionNameString(long struct)	Unsafe version of functionNameString().
static ByteBuffer	nmessage(long struct)	Unsafe version of message().
static void	nmessage(long struct, ByteBuffer value)	Unsafe version of message.
static @Nullable ByteBuffer	nmessageId(long struct)	Unsafe version of messageId().
static void	nmessageId(long struct, @Nullable ByteBuffer value)	Unsafe version of messageId.
static @Nullable String	nmessageIdString(long struct)	Unsafe version of messageIdString().
static String	nmessageString(long struct)	Unsafe version of messageString().
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	nobjectCount(long struct)	Unsafe version of objectCount().
static void	nobjectCount(long struct, int value)	Sets the specified value to the objectCount field of the specified struct.
static @Nullable XrDebugUtilsObjectNameInfoEXT.Buffer	nobjects(long struct)	Unsafe version of objects().
static void	nobjects(long struct, @Nullable XrDebugUtilsObjectNameInfoEXT.Buffer value)	Unsafe version of objects.
static int	nsessionLabelCount(long struct)	Unsafe version of sessionLabelCount().
static void	nsessionLabelCount(long struct, int value)	Sets the specified value to the sessionLabelCount field of the specified struct.
static @Nullable XrDebugUtilsLabelEXT.Buffer	nsessionLabels(long struct)	Unsafe version of sessionLabels().
static void	nsessionLabels(long struct, @Nullable XrDebugUtilsLabelEXT.Buffer value)	Unsafe version of sessionLabels.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
int	objectCount()	a count of items contained in the objects array.
XrDebugUtilsMessengerCallbackDataEXT	objectCount(int value)	Sets the specified value to the objectCount() field.
@Nullable XrDebugUtilsObjectNameInfoEXT.Buffer	objects()	NULL or a pointer to an array of XrDebugUtilsObjectNameInfoEXT objects related to the detected issue.
XrDebugUtilsMessengerCallbackDataEXT	objects(@Nullable XrDebugUtilsObjectNameInfoEXT.Buffer value)	Sets the address of the specified XrDebugUtilsObjectNameInfoEXT.Buffer to the objects() field.
int	sessionLabelCount()	a count of items contained in the sessionLabels array.
XrDebugUtilsMessengerCallbackDataEXT	sessionLabelCount(int value)	Sets the specified value to the sessionLabelCount() field.
@Nullable XrDebugUtilsLabelEXT.Buffer	sessionLabels()	NULL or a pointer to an array of XrDebugUtilsLabelEXT active in the current XrSession at the time the callback was triggered.
XrDebugUtilsMessengerCallbackDataEXT	sessionLabels(@Nullable XrDebugUtilsLabelEXT.Buffer value)	Sets the address of the specified XrDebugUtilsLabelEXT.Buffer to the sessionLabels() field.
XrDebugUtilsMessengerCallbackDataEXT	set(int type, long next, @Nullable ByteBuffer messageId, @Nullable ByteBuffer functionName, ByteBuffer message, int objectCount, @Nullable XrDebugUtilsObjectNameInfoEXT.Buffer objects, int sessionLabelCount, @Nullable XrDebugUtilsLabelEXT.Buffer sessionLabels)	Initializes this struct with the specified values.
XrDebugUtilsMessengerCallbackDataEXT	set(XrDebugUtilsMessengerCallbackDataEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrDebugUtilsMessengerCallbackDataEXT	type(int value)	Sets the specified value to the type() field.
XrDebugUtilsMessengerCallbackDataEXT	type$Default()	Sets the TYPE_DEBUG_UTILS_MESSENGER_CALLBACK_DATA_EXT value to the type() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

MESSAGEID

public static final int MESSAGEID

The struct member offsets.

FUNCTIONNAME

public static final int FUNCTIONNAME

The struct member offsets.

MESSAGE

public static final int MESSAGE

The struct member offsets.

OBJECTCOUNT

public static final int OBJECTCOUNT

The struct member offsets.

OBJECTS

public static final int OBJECTS

The struct member offsets.

SESSIONLABELCOUNT

public static final int SESSIONLABELCOUNT

The struct member offsets.

SESSIONLABELS

public static final int SESSIONLABELS

The struct member offsets.

Constructor Details

XrDebugUtilsMessengerCallbackDataEXT

public XrDebugUtilsMessengerCallbackDataEXT(ByteBuffer container)

Creates a XrDebugUtilsMessengerCallbackDataEXT 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<XrDebugUtilsMessengerCallbackDataEXT>

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.

messageId

public @Nullable ByteBuffer messageId()

a NULL terminated string that identifies the message in a unique way. If the callback is triggered by a validation layer, this string corresponds the Valid Usage ID (VUID) that can be used to jump to the appropriate location in the OpenXR specification. This value may be NULL if no unique message identifier is associated with the message.

messageIdString

public @Nullable String messageIdString()

a NULL terminated string that identifies the message in a unique way. If the callback is triggered by a validation layer, this string corresponds the Valid Usage ID (VUID) that can be used to jump to the appropriate location in the OpenXR specification. This value may be NULL if no unique message identifier is associated with the message.

functionName

public @Nullable ByteBuffer functionName()

a NULL terminated string that identifies the OpenXR function that was executing at the time the message callback was triggered. This value may be NULL in cases where it is difficult to determine the originating OpenXR function.

functionNameString

public @Nullable String functionNameString()

a NULL terminated string that identifies the OpenXR function that was executing at the time the message callback was triggered. This value may be NULL in cases where it is difficult to determine the originating OpenXR function.

message

public ByteBuffer message()

a NULL terminated string detailing the trigger conditions.

messageString

public String messageString()

a NULL terminated string detailing the trigger conditions.

objectCount

public int objectCount()

a count of items contained in the objects array. This may be 0.

objects

public @Nullable XrDebugUtilsObjectNameInfoEXT.Buffer objects()

NULL or a pointer to an array of XrDebugUtilsObjectNameInfoEXT objects related to the detected issue. The array is roughly in order of importance, but the 0th element is always guaranteed to be the most important object for this message.

sessionLabelCount

public int sessionLabelCount()

a count of items contained in the sessionLabels array. This may be 0.

sessionLabels

public @Nullable XrDebugUtilsLabelEXT.Buffer sessionLabels()

NULL or a pointer to an array of XrDebugUtilsLabelEXT active in the current XrSession at the time the callback was triggered. Refer to Session Labels for more information.

type

public XrDebugUtilsMessengerCallbackDataEXT type(int value)

Sets the specified value to the type() field.

type$Default

public XrDebugUtilsMessengerCallbackDataEXT type$Default()

Sets the TYPE_DEBUG_UTILS_MESSENGER_CALLBACK_DATA_EXT value to the type() field.

next

public XrDebugUtilsMessengerCallbackDataEXT next(long value)

Sets the specified value to the next() field.

messageId

public XrDebugUtilsMessengerCallbackDataEXT messageId(@Nullable ByteBuffer value)

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

functionName

public XrDebugUtilsMessengerCallbackDataEXT functionName(@Nullable ByteBuffer value)

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

message

public XrDebugUtilsMessengerCallbackDataEXT message(ByteBuffer value)

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

objectCount

public XrDebugUtilsMessengerCallbackDataEXT objectCount(int value)

Sets the specified value to the objectCount() field.

objects

public XrDebugUtilsMessengerCallbackDataEXT objects(@Nullable XrDebugUtilsObjectNameInfoEXT.Buffer value)

Sets the address of the specified XrDebugUtilsObjectNameInfoEXT.Buffer to the objects() field.

sessionLabelCount

public XrDebugUtilsMessengerCallbackDataEXT sessionLabelCount(int value)

Sets the specified value to the sessionLabelCount() field.

sessionLabels

public XrDebugUtilsMessengerCallbackDataEXT sessionLabels(@Nullable XrDebugUtilsLabelEXT.Buffer value)

Sets the address of the specified XrDebugUtilsLabelEXT.Buffer to the sessionLabels() field.

set

public XrDebugUtilsMessengerCallbackDataEXT set(int type,
 long next,
 @Nullable ByteBuffer messageId,
 @Nullable ByteBuffer functionName,
 ByteBuffer message,
 int objectCount,
 @Nullable XrDebugUtilsObjectNameInfoEXT.Buffer objects,
 int sessionLabelCount,
 @Nullable XrDebugUtilsLabelEXT.Buffer sessionLabels)

Initializes this struct with the specified values.

set

public XrDebugUtilsMessengerCallbackDataEXT set(XrDebugUtilsMessengerCallbackDataEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrDebugUtilsMessengerCallbackDataEXT malloc()

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

calloc

public static XrDebugUtilsMessengerCallbackDataEXT calloc()

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

create

public static XrDebugUtilsMessengerCallbackDataEXT create()

Returns a new XrDebugUtilsMessengerCallbackDataEXT instance allocated with BufferUtils.

create

public static XrDebugUtilsMessengerCallbackDataEXT create(long address)

Returns a new XrDebugUtilsMessengerCallbackDataEXT instance for the specified memory address.

createSafe

public static @Nullable XrDebugUtilsMessengerCallbackDataEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrDebugUtilsMessengerCallbackDataEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrDebugUtilsMessengerCallbackDataEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrDebugUtilsMessengerCallbackDataEXT.Buffer create(int capacity)

Returns a new XrDebugUtilsMessengerCallbackDataEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrDebugUtilsMessengerCallbackDataEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrDebugUtilsMessengerCallbackDataEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new XrDebugUtilsMessengerCallbackDataEXT.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().

nmessageId

public static @Nullable ByteBuffer nmessageId(long struct)

Unsafe version of messageId().

nmessageIdString

public static @Nullable String nmessageIdString(long struct)

Unsafe version of messageIdString().

nfunctionName

public static @Nullable ByteBuffer nfunctionName(long struct)

Unsafe version of functionName().

nfunctionNameString

public static @Nullable String nfunctionNameString(long struct)

Unsafe version of functionNameString().

nmessage

public static ByteBuffer nmessage(long struct)

Unsafe version of message().

nmessageString

public static String nmessageString(long struct)

Unsafe version of messageString().

nobjectCount

public static int nobjectCount(long struct)

Unsafe version of objectCount().

nobjects

public static @Nullable XrDebugUtilsObjectNameInfoEXT.Buffer nobjects(long struct)

Unsafe version of objects().

nsessionLabelCount

public static int nsessionLabelCount(long struct)

Unsafe version of sessionLabelCount().

nsessionLabels

public static @Nullable XrDebugUtilsLabelEXT.Buffer nsessionLabels(long struct)

Unsafe version of sessionLabels().

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.

nmessageId

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

Unsafe version of messageId.

nfunctionName

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

Unsafe version of functionName.

nmessage

public static void nmessage(long struct,
 ByteBuffer value)

Unsafe version of message.

nobjectCount

public static void nobjectCount(long struct,
 int value)

Sets the specified value to the objectCount field of the specified struct.

nobjects

public static void nobjects(long struct,
 @Nullable XrDebugUtilsObjectNameInfoEXT.Buffer value)

Unsafe version of objects.

nsessionLabelCount

public static void nsessionLabelCount(long struct,
 int value)

Sets the specified value to the sessionLabelCount field of the specified struct.

nsessionLabels

public static void nsessionLabels(long struct,
 @Nullable XrDebugUtilsLabelEXT.Buffer value)

Unsafe version of sessionLabels.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate