LWJGL 3.3.3 · org.lwjgl.openxr.XrDebugUtilsMessengerCallbackDataEXT

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
messageId must be a null-terminated UTF-8 string
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.

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;
}

Modifier and Type	Class and Description
public static class	XrDebugUtilsMessengerCallbackDataEXT.Buffer An array of `XrDebugUtilsMessengerCallbackDataEXT` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	FUNCTIONNAME The struct member offsets.
public static final int	MESSAGE The struct member offsets.
public static final int	MESSAGEID The struct member offsets.
public static final int	NEXT The struct member offsets.
public static final int	OBJECTCOUNT The struct member offsets.
public static final int	OBJECTS The struct member offsets.
public static final int	SESSIONLABELCOUNT The struct member offsets.
public static final int	SESSIONLABELS The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	TYPE The struct member offsets.

Access	Constructor and Description
protected	XrDebugUtilsMessengerCallbackDataEXT(long address, ByteBuffer container)
public	XrDebugUtilsMessengerCallbackDataEXT(ByteBuffer container) Creates a `XrDebugUtilsMessengerCallbackDataEXT` instance at the current position of the specified `ByteBuffer` container.

Method Summary

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

public Class XrDebugUtilsMessengerCallbackDataEXT

Valid Usage (Implicit)

Note

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary