Package org.lwjgl.openxr
Class XrDebugUtilsMessengerCallbackDataEXT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrDebugUtilsMessengerCallbackDataEXT
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class XrDebugUtilsMessengerCallbackDataEXT extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceDebug utils messenger callback data.Valid Usage (Implicit)
- The
XR_EXT_debug_utilsextension must be enabled prior to usingXrDebugUtilsMessengerCallbackDataEXT typemust beTYPE_DEBUG_UTILS_MESSENGER_CALLBACK_DATA_EXTnextmust beNULLor a valid pointer to the next structure in a structure chainmessageIdmust be a null-terminated UTF-8 stringfunctionNamemust be a null-terminated UTF-8 stringmessagemust be a null-terminated UTF-8 string
An
XrDebugUtilsMessengerCallbackDataEXTis 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
sessionLabelsare organized in time order, with the most recently generated label appearing first, and the oldest label appearing last.See Also
XrDebugUtilsLabelEXT,XrDebugUtilsObjectNameInfoEXT,SubmitDebugUtilsMessageEXTLayout
struct XrDebugUtilsMessengerCallbackDataEXT { XrStructureTypetype(); void const *next(); char const *messageId(); char const *functionName(); char const *message(); uint32_tobjectCount();XrDebugUtilsObjectNameInfoEXT*objects(); uint32_tsessionLabelCount();XrDebugUtilsLabelEXT*sessionLabels(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrDebugUtilsMessengerCallbackDataEXT.BufferAn array ofXrDebugUtilsMessengerCallbackDataEXTstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intFUNCTIONNAME
MESSAGE
MESSAGEID
NEXT
OBJECTCOUNT
OBJECTS
SESSIONLABELCOUNT
SESSIONLABELSThe struct member offsets.static intSIZEOFThe struct size in bytes.static intTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description XrDebugUtilsMessengerCallbackDataEXT(java.nio.ByteBuffer container)Creates aXrDebugUtilsMessengerCallbackDataEXTinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static XrDebugUtilsMessengerCallbackDataEXTcalloc()Returns a newXrDebugUtilsMessengerCallbackDataEXTinstance allocated withmemCalloc.static XrDebugUtilsMessengerCallbackDataEXT.Buffercalloc(int capacity)Returns a newXrDebugUtilsMessengerCallbackDataEXT.Bufferinstance allocated withmemCalloc.static XrDebugUtilsMessengerCallbackDataEXT.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrDebugUtilsMessengerCallbackDataEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrDebugUtilsMessengerCallbackDataEXTcalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrDebugUtilsMessengerCallbackDataEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrDebugUtilsMessengerCallbackDataEXTcreate()Returns a newXrDebugUtilsMessengerCallbackDataEXTinstance allocated withBufferUtils.static XrDebugUtilsMessengerCallbackDataEXT.Buffercreate(int capacity)Returns a newXrDebugUtilsMessengerCallbackDataEXT.Bufferinstance allocated withBufferUtils.static XrDebugUtilsMessengerCallbackDataEXTcreate(long address)Returns a newXrDebugUtilsMessengerCallbackDataEXTinstance for the specified memory address.static XrDebugUtilsMessengerCallbackDataEXT.Buffercreate(long address, int capacity)Create aXrDebugUtilsMessengerCallbackDataEXT.Bufferinstance at the specified memory.static XrDebugUtilsMessengerCallbackDataEXTcreateSafe(long address)static XrDebugUtilsMessengerCallbackDataEXT.BuffercreateSafe(long address, int capacity)java.nio.ByteBufferfunctionName()aNULLterminated string that identifies the OpenXR function that was executing at the time the message callback was triggered.XrDebugUtilsMessengerCallbackDataEXTfunctionName(java.nio.ByteBuffer value)Sets the address of the specified encoded string to thefunctionName()field.java.lang.StringfunctionNameString()aNULLterminated string that identifies the OpenXR function that was executing at the time the message callback was triggered.static XrDebugUtilsMessengerCallbackDataEXTmalloc()Returns a newXrDebugUtilsMessengerCallbackDataEXTinstance allocated withmemAlloc.static XrDebugUtilsMessengerCallbackDataEXT.Buffermalloc(int capacity)Returns a newXrDebugUtilsMessengerCallbackDataEXT.Bufferinstance allocated withmemAlloc.static XrDebugUtilsMessengerCallbackDataEXT.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrDebugUtilsMessengerCallbackDataEXT.Bufferinstance allocated on the specifiedMemoryStack.static XrDebugUtilsMessengerCallbackDataEXTmalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrDebugUtilsMessengerCallbackDataEXTinstance allocated on the specifiedMemoryStack.java.nio.ByteBuffermessage()aNULLterminated string detailing the trigger conditions.XrDebugUtilsMessengerCallbackDataEXTmessage(java.nio.ByteBuffer value)Sets the address of the specified encoded string to themessage()field.java.nio.ByteBuffermessageId()aNULLterminated string that identifies the message in a unique way.XrDebugUtilsMessengerCallbackDataEXTmessageId(java.nio.ByteBuffer value)Sets the address of the specified encoded string to themessageId()field.java.lang.StringmessageIdString()aNULLterminated string that identifies the message in a unique way.java.lang.StringmessageString()aNULLterminated string detailing the trigger conditions.longnext()NULLor a pointer to the next structure in a structure chain.XrDebugUtilsMessengerCallbackDataEXTnext(long value)Sets the specified value to thenext()field.static java.nio.ByteBuffernfunctionName(long struct)Unsafe version offunctionName().static voidnfunctionName(long struct, java.nio.ByteBuffer value)Unsafe version offunctionName.static java.lang.StringnfunctionNameString(long struct)Unsafe version offunctionNameString().static java.nio.ByteBuffernmessage(long struct)Unsafe version ofmessage().static voidnmessage(long struct, java.nio.ByteBuffer value)Unsafe version ofmessage.static java.nio.ByteBuffernmessageId(long struct)Unsafe version ofmessageId().static voidnmessageId(long struct, java.nio.ByteBuffer value)Unsafe version ofmessageId.static java.lang.StringnmessageIdString(long struct)Unsafe version ofmessageIdString().static java.lang.StringnmessageString(long struct)Unsafe version ofmessageString().static longnnext(long struct)Unsafe version ofnext().static voidnnext(long struct, long value)Unsafe version ofnext.static intnobjectCount(long struct)Unsafe version ofobjectCount().static voidnobjectCount(long struct, int value)Sets the specified value to theobjectCountfield of the specifiedstruct.static XrDebugUtilsObjectNameInfoEXT.Buffernobjects(long struct)Unsafe version ofobjects().static voidnobjects(long struct, XrDebugUtilsObjectNameInfoEXT.Buffer value)Unsafe version ofobjects.static intnsessionLabelCount(long struct)Unsafe version ofsessionLabelCount().static voidnsessionLabelCount(long struct, int value)Sets the specified value to thesessionLabelCountfield of the specifiedstruct.static XrDebugUtilsLabelEXT.BuffernsessionLabels(long struct)Unsafe version ofsessionLabels().static voidnsessionLabels(long struct, XrDebugUtilsLabelEXT.Buffer value)Unsafe version ofsessionLabels.static intntype(long struct)Unsafe version oftype().static voidntype(long struct, int value)Unsafe version oftype.intobjectCount()a count of items contained in theobjectsarray.XrDebugUtilsMessengerCallbackDataEXTobjectCount(int value)Sets the specified value to theobjectCount()field.XrDebugUtilsObjectNameInfoEXT.Bufferobjects()a pointer to an array ofXrDebugUtilsObjectNameInfoEXTobjects related to the detected issue.XrDebugUtilsMessengerCallbackDataEXTobjects(XrDebugUtilsObjectNameInfoEXT.Buffer value)Sets the address of the specifiedXrDebugUtilsObjectNameInfoEXT.Bufferto theobjects()field.intsessionLabelCount()a count of items contained in thesessionLabelsarray.XrDebugUtilsMessengerCallbackDataEXTsessionLabelCount(int value)Sets the specified value to thesessionLabelCount()field.XrDebugUtilsLabelEXT.BuffersessionLabels()a pointer to an array ofXrDebugUtilsLabelEXTobjects related to the detected issue.XrDebugUtilsMessengerCallbackDataEXTsessionLabels(XrDebugUtilsLabelEXT.Buffer value)Sets the address of the specifiedXrDebugUtilsLabelEXT.Bufferto thesessionLabels()field.XrDebugUtilsMessengerCallbackDataEXTset(int type, long next, java.nio.ByteBuffer messageId, java.nio.ByteBuffer functionName, java.nio.ByteBuffer message, int objectCount, XrDebugUtilsObjectNameInfoEXT.Buffer objects, int sessionLabelCount, XrDebugUtilsLabelEXT.Buffer sessionLabels)Initializes this struct with the specified values.XrDebugUtilsMessengerCallbackDataEXTset(XrDebugUtilsMessengerCallbackDataEXT src)Copies the specified struct data to this struct.intsizeof()inttype()theXrStructureTypeof this structure.XrDebugUtilsMessengerCallbackDataEXTtype(int value)Sets the specified value to thetype()field.XrDebugUtilsMessengerCallbackDataEXTtype$Default()Sets theTYPE_DEBUG_UTILS_MESSENGER_CALLBACK_DATA_EXTvalue to thetype()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
XrDebugUtilsMessengerCallbackDataEXT
public XrDebugUtilsMessengerCallbackDataEXT(java.nio.ByteBuffer container)
Creates aXrDebugUtilsMessengerCallbackDataEXTinstance at the current position of the specifiedByteBuffercontainer. 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
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
type
public int type()
theXrStructureTypeof this structure.
-
next
public long next()
NULLor a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.
-
messageId, messageIdString
public java.nio.ByteBuffer messageId() public java.lang.String messageIdString()
aNULLterminated 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 beNULLif no unique message identifier is associated with the message.
-
functionName, functionNameString
public java.nio.ByteBuffer functionName() public java.lang.String functionNameString()
aNULLterminated string that identifies the OpenXR function that was executing at the time the message callback was triggered. This value may beNULLin cases where it is difficult to determine the originating OpenXR function.
-
message, messageString
public java.nio.ByteBuffer message() public java.lang.String messageString()
aNULLterminated string detailing the trigger conditions.
-
objectCount
public int objectCount()
a count of items contained in theobjectsarray. This may be 0.
-
objects
@Nullable public XrDebugUtilsObjectNameInfoEXT.Buffer objects()
a pointer to an array ofXrDebugUtilsObjectNameInfoEXTobjects related to the detected issue. The array is roughly in order or 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 thesessionLabelsarray. This may be 0.
-
sessionLabels
@Nullable public XrDebugUtilsLabelEXT.Buffer sessionLabels()
a pointer to an array ofXrDebugUtilsLabelEXTobjects related to the detected issue. The array is roughly in order or importance, but the 0th element is always guaranteed to be the most important object for this message.NULL or a pointer to an array of
XrDebugUtilsLabelEXTactive in the currentXrSessionat the time the callback was triggered. Refer to Session Labels for more information.
-
type
public XrDebugUtilsMessengerCallbackDataEXT type(int value)
Sets the specified value to thetype()field.
-
type$Default
public XrDebugUtilsMessengerCallbackDataEXT type$Default()
Sets theTYPE_DEBUG_UTILS_MESSENGER_CALLBACK_DATA_EXTvalue to thetype()field.
-
next
public XrDebugUtilsMessengerCallbackDataEXT next(long value)
Sets the specified value to thenext()field.
-
messageId
public XrDebugUtilsMessengerCallbackDataEXT messageId(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themessageId()field.
-
functionName
public XrDebugUtilsMessengerCallbackDataEXT functionName(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to thefunctionName()field.
-
message
public XrDebugUtilsMessengerCallbackDataEXT message(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themessage()field.
-
objectCount
public XrDebugUtilsMessengerCallbackDataEXT objectCount(int value)
Sets the specified value to theobjectCount()field.
-
objects
public XrDebugUtilsMessengerCallbackDataEXT objects(@Nullable XrDebugUtilsObjectNameInfoEXT.Buffer value)
Sets the address of the specifiedXrDebugUtilsObjectNameInfoEXT.Bufferto theobjects()field.
-
sessionLabelCount
public XrDebugUtilsMessengerCallbackDataEXT sessionLabelCount(int value)
Sets the specified value to thesessionLabelCount()field.
-
sessionLabels
public XrDebugUtilsMessengerCallbackDataEXT sessionLabels(@Nullable XrDebugUtilsLabelEXT.Buffer value)
Sets the address of the specifiedXrDebugUtilsLabelEXT.Bufferto thesessionLabels()field.
-
set
public XrDebugUtilsMessengerCallbackDataEXT set(int type, long next, java.nio.ByteBuffer messageId, java.nio.ByteBuffer functionName, java.nio.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 newXrDebugUtilsMessengerCallbackDataEXTinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrDebugUtilsMessengerCallbackDataEXT calloc()
Returns a newXrDebugUtilsMessengerCallbackDataEXTinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrDebugUtilsMessengerCallbackDataEXT create()
Returns a newXrDebugUtilsMessengerCallbackDataEXTinstance allocated withBufferUtils.
-
create
public static XrDebugUtilsMessengerCallbackDataEXT create(long address)
Returns a newXrDebugUtilsMessengerCallbackDataEXTinstance for the specified memory address.
-
createSafe
@Nullable public static XrDebugUtilsMessengerCallbackDataEXT createSafe(long address)
-
malloc
public static XrDebugUtilsMessengerCallbackDataEXT.Buffer malloc(int capacity)
Returns a newXrDebugUtilsMessengerCallbackDataEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrDebugUtilsMessengerCallbackDataEXT.Buffer calloc(int capacity)
Returns a newXrDebugUtilsMessengerCallbackDataEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrDebugUtilsMessengerCallbackDataEXT.Buffer create(int capacity)
Returns a newXrDebugUtilsMessengerCallbackDataEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrDebugUtilsMessengerCallbackDataEXT.Buffer create(long address, int capacity)
Create aXrDebugUtilsMessengerCallbackDataEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrDebugUtilsMessengerCallbackDataEXT.Buffer createSafe(long address, int capacity)
-
malloc
public static XrDebugUtilsMessengerCallbackDataEXT malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrDebugUtilsMessengerCallbackDataEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrDebugUtilsMessengerCallbackDataEXT calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrDebugUtilsMessengerCallbackDataEXTinstance allocated on the specifiedMemoryStackand 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 newXrDebugUtilsMessengerCallbackDataEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrDebugUtilsMessengerCallbackDataEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrDebugUtilsMessengerCallbackDataEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
ntype
public static int ntype(long struct)
Unsafe version oftype().
-
nnext
public static long nnext(long struct)
Unsafe version ofnext().
-
nmessageId
public static java.nio.ByteBuffer nmessageId(long struct)
Unsafe version ofmessageId().
-
nmessageIdString
public static java.lang.String nmessageIdString(long struct)
Unsafe version ofmessageIdString().
-
nfunctionName
public static java.nio.ByteBuffer nfunctionName(long struct)
Unsafe version offunctionName().
-
nfunctionNameString
public static java.lang.String nfunctionNameString(long struct)
Unsafe version offunctionNameString().
-
nmessage
public static java.nio.ByteBuffer nmessage(long struct)
Unsafe version ofmessage().
-
nmessageString
public static java.lang.String nmessageString(long struct)
Unsafe version ofmessageString().
-
nobjectCount
public static int nobjectCount(long struct)
Unsafe version ofobjectCount().
-
nobjects
@Nullable public static XrDebugUtilsObjectNameInfoEXT.Buffer nobjects(long struct)
Unsafe version ofobjects().
-
nsessionLabelCount
public static int nsessionLabelCount(long struct)
Unsafe version ofsessionLabelCount().
-
nsessionLabels
@Nullable public static XrDebugUtilsLabelEXT.Buffer nsessionLabels(long struct)
Unsafe version ofsessionLabels().
-
ntype
public static void ntype(long struct, int value)Unsafe version oftype.
-
nnext
public static void nnext(long struct, long value)Unsafe version ofnext.
-
nmessageId
public static void nmessageId(long struct, java.nio.ByteBuffer value)Unsafe version ofmessageId.
-
nfunctionName
public static void nfunctionName(long struct, java.nio.ByteBuffer value)Unsafe version offunctionName.
-
nmessage
public static void nmessage(long struct, java.nio.ByteBuffer value)Unsafe version ofmessage.
-
nobjectCount
public static void nobjectCount(long struct, int value)Sets the specified value to theobjectCountfield of the specifiedstruct.
-
nobjects
public static void nobjects(long struct, @Nullable XrDebugUtilsObjectNameInfoEXT.Buffer value)Unsafe version ofobjects.
-
nsessionLabelCount
public static void nsessionLabelCount(long struct, int value)Sets the specified value to thesessionLabelCountfield of the specifiedstruct.
-
nsessionLabels
public static void nsessionLabels(long struct, @Nullable XrDebugUtilsLabelEXT.Buffer value)Unsafe version ofsessionLabels.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-