Package org.lwjgl.openxr
Class XrDebugUtilsMessengerCreateInfoEXT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrDebugUtilsMessengerCreateInfoEXT
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class XrDebugUtilsMessengerCreateInfoEXT extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceDebug utils messenger create info.Valid Usage
userCallbackmust be a valid PFN_xrDebugUtilsMessengerCallbackEXT
Valid Usage (Implicit)
- The
XR_EXT_debug_utilsextension must be enabled prior to usingXrDebugUtilsMessengerCreateInfoEXT typemust beTYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXTnextmust beNULLor a valid pointer to the next structure in a structure chainmessageSeveritiesmust be a valid combination ofXrDebugUtilsMessageSeverityFlagBitsEXTvaluesmessageSeveritiesmust not be 0messageTypesmust be a valid combination ofXrDebugUtilsMessageTypeFlagBitsEXTvaluesmessageTypesmust not be 0userCallbackmust be a validXrDebugUtilsMessengerCallbackEXTvalue
For each
XrDebugUtilsMessengerEXTthat is created theXrDebugUtilsMessengerCreateInfoEXT::messageSeveritiesandXrDebugUtilsMessengerCreateInfoEXT::messageTypesdetermine when thatXrDebugUtilsMessengerCreateInfoEXT::userCallbackis called. The process to determine if the user’s userCallback is triggered when an event occurs is as follows:- The runtime will perform a bitwise AND of the event’s
XrDebugUtilsMessageSeverityFlagBitsEXTwith theXrDebugUtilsMessengerCreateInfoEXT::messageSeveritiesprovided during creation of theXrDebugUtilsMessengerEXTobject. - If this results in 0, the message is skipped.
- The runtime will perform bitwise AND of the event’s
XrDebugUtilsMessageTypeFlagBitsEXTwith theXrDebugUtilsMessengerCreateInfoEXT::messageTypesprovided during the creation of theXrDebugUtilsMessengerEXTobject. - If this results in 0, the message is skipped.
- If the message of the current event is not skipped, the callback will be called with the message.
The callback will come directly from the component that detected the event, unless some other layer intercepts the calls for its own purposes (filter them in a different way, log to a system error log, etc.).
See Also
XrDebugUtilsMessengerCallbackEXT,CreateDebugUtilsMessengerEXTLayout
struct XrDebugUtilsMessengerCreateInfoEXT { XrStructureTypetype(); void const *next(); XrDebugUtilsMessageSeverityFlagsEXTmessageSeverities(); XrDebugUtilsMessageTypeFlagsEXTmessageTypes();PFN_xrDebugUtilsMessengerCallbackEXTuserCallback(); void *userData(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrDebugUtilsMessengerCreateInfoEXT.BufferAn array ofXrDebugUtilsMessengerCreateInfoEXTstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intMESSAGESEVERITIES
MESSAGETYPES
NEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intTYPE
USERCALLBACK
USERDATAThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description XrDebugUtilsMessengerCreateInfoEXT(java.nio.ByteBuffer container)Creates aXrDebugUtilsMessengerCreateInfoEXTinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static XrDebugUtilsMessengerCreateInfoEXTcalloc()Returns a newXrDebugUtilsMessengerCreateInfoEXTinstance allocated withmemCalloc.static XrDebugUtilsMessengerCreateInfoEXT.Buffercalloc(int capacity)Returns a newXrDebugUtilsMessengerCreateInfoEXT.Bufferinstance allocated withmemCalloc.static XrDebugUtilsMessengerCreateInfoEXT.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrDebugUtilsMessengerCreateInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrDebugUtilsMessengerCreateInfoEXTcalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrDebugUtilsMessengerCreateInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrDebugUtilsMessengerCreateInfoEXTcreate()Returns a newXrDebugUtilsMessengerCreateInfoEXTinstance allocated withBufferUtils.static XrDebugUtilsMessengerCreateInfoEXT.Buffercreate(int capacity)Returns a newXrDebugUtilsMessengerCreateInfoEXT.Bufferinstance allocated withBufferUtils.static XrDebugUtilsMessengerCreateInfoEXTcreate(long address)Returns a newXrDebugUtilsMessengerCreateInfoEXTinstance for the specified memory address.static XrDebugUtilsMessengerCreateInfoEXT.Buffercreate(long address, int capacity)Create aXrDebugUtilsMessengerCreateInfoEXT.Bufferinstance at the specified memory.static XrDebugUtilsMessengerCreateInfoEXTcreateSafe(long address)static XrDebugUtilsMessengerCreateInfoEXT.BuffercreateSafe(long address, int capacity)static XrDebugUtilsMessengerCreateInfoEXTmalloc()Returns a newXrDebugUtilsMessengerCreateInfoEXTinstance allocated withmemAlloc.static XrDebugUtilsMessengerCreateInfoEXT.Buffermalloc(int capacity)Returns a newXrDebugUtilsMessengerCreateInfoEXT.Bufferinstance allocated withmemAlloc.static XrDebugUtilsMessengerCreateInfoEXT.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrDebugUtilsMessengerCreateInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.static XrDebugUtilsMessengerCreateInfoEXTmalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrDebugUtilsMessengerCreateInfoEXTinstance allocated on the specifiedMemoryStack.longmessageSeverities()a bitmask ofXrDebugUtilsMessageSeverityFlagBitsEXTspecifying which severity of event(s) that will cause this callback to be called.XrDebugUtilsMessengerCreateInfoEXTmessageSeverities(long value)Sets the specified value to themessageSeverities()field.longmessageTypes()a combination ofXrDebugUtilsMessageTypeFlagBitsEXTspecifying which type of event(s) will cause this callback to be called.XrDebugUtilsMessengerCreateInfoEXTmessageTypes(long value)Sets the specified value to themessageTypes()field.longnext()NULLor a pointer to the next structure in a structure chain.XrDebugUtilsMessengerCreateInfoEXTnext(long value)Sets the specified value to thenext()field.static longnmessageSeverities(long struct)Unsafe version ofmessageSeverities().static voidnmessageSeverities(long struct, long value)Unsafe version ofmessageSeverities.static longnmessageTypes(long struct)Unsafe version ofmessageTypes().static voidnmessageTypes(long struct, long value)Unsafe version ofmessageTypes.static longnnext(long struct)Unsafe version ofnext().static voidnnext(long struct, long value)Unsafe version ofnext.static intntype(long struct)Unsafe version oftype().static voidntype(long struct, int value)Unsafe version oftype.static XrDebugUtilsMessengerCallbackEXTnuserCallback(long struct)Unsafe version ofuserCallback().static voidnuserCallback(long struct, XrDebugUtilsMessengerCallbackEXTI value)Unsafe version ofuserCallback.static longnuserData(long struct)Unsafe version ofuserData().static voidnuserData(long struct, long value)Unsafe version ofuserData.XrDebugUtilsMessengerCreateInfoEXTset(int type, long next, long messageSeverities, long messageTypes, XrDebugUtilsMessengerCallbackEXTI userCallback, long userData)Initializes this struct with the specified values.XrDebugUtilsMessengerCreateInfoEXTset(XrDebugUtilsMessengerCreateInfoEXT src)Copies the specified struct data to this struct.intsizeof()inttype()theXrStructureTypeof this structure.XrDebugUtilsMessengerCreateInfoEXTtype(int value)Sets the specified value to thetype()field.XrDebugUtilsMessengerCreateInfoEXTtype$Default()Sets theTYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXTvalue to thetype()field.XrDebugUtilsMessengerCallbackEXTuserCallback()the application defined callback function to call.XrDebugUtilsMessengerCreateInfoEXTuserCallback(XrDebugUtilsMessengerCallbackEXTI value)Sets the specified value to theuserCallback()field.longuserData()arbitrary user data to be passed to the callback.XrDebugUtilsMessengerCreateInfoEXTuserData(long value)Sets the specified value to theuserData()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
XrDebugUtilsMessengerCreateInfoEXT
public XrDebugUtilsMessengerCreateInfoEXT(java.nio.ByteBuffer container)
Creates aXrDebugUtilsMessengerCreateInfoEXTinstance 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.
-
messageSeverities
public long messageSeverities()
a bitmask ofXrDebugUtilsMessageSeverityFlagBitsEXTspecifying which severity of event(s) that will cause this callback to be called.
-
messageTypes
public long messageTypes()
a combination ofXrDebugUtilsMessageTypeFlagBitsEXTspecifying which type of event(s) will cause this callback to be called.
-
userCallback
public XrDebugUtilsMessengerCallbackEXT userCallback()
the application defined callback function to call.
-
userData
public long userData()
arbitrary user data to be passed to the callback.
-
type
public XrDebugUtilsMessengerCreateInfoEXT type(int value)
Sets the specified value to thetype()field.
-
type$Default
public XrDebugUtilsMessengerCreateInfoEXT type$Default()
Sets theTYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXTvalue to thetype()field.
-
next
public XrDebugUtilsMessengerCreateInfoEXT next(long value)
Sets the specified value to thenext()field.
-
messageSeverities
public XrDebugUtilsMessengerCreateInfoEXT messageSeverities(long value)
Sets the specified value to themessageSeverities()field.
-
messageTypes
public XrDebugUtilsMessengerCreateInfoEXT messageTypes(long value)
Sets the specified value to themessageTypes()field.
-
userCallback
public XrDebugUtilsMessengerCreateInfoEXT userCallback(XrDebugUtilsMessengerCallbackEXTI value)
Sets the specified value to theuserCallback()field.
-
userData
public XrDebugUtilsMessengerCreateInfoEXT userData(long value)
Sets the specified value to theuserData()field.
-
set
public XrDebugUtilsMessengerCreateInfoEXT set(int type, long next, long messageSeverities, long messageTypes, XrDebugUtilsMessengerCallbackEXTI userCallback, long userData)
Initializes this struct with the specified values.
-
set
public XrDebugUtilsMessengerCreateInfoEXT set(XrDebugUtilsMessengerCreateInfoEXT src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static XrDebugUtilsMessengerCreateInfoEXT malloc()
Returns a newXrDebugUtilsMessengerCreateInfoEXTinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrDebugUtilsMessengerCreateInfoEXT calloc()
Returns a newXrDebugUtilsMessengerCreateInfoEXTinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrDebugUtilsMessengerCreateInfoEXT create()
Returns a newXrDebugUtilsMessengerCreateInfoEXTinstance allocated withBufferUtils.
-
create
public static XrDebugUtilsMessengerCreateInfoEXT create(long address)
Returns a newXrDebugUtilsMessengerCreateInfoEXTinstance for the specified memory address.
-
createSafe
@Nullable public static XrDebugUtilsMessengerCreateInfoEXT createSafe(long address)
-
malloc
public static XrDebugUtilsMessengerCreateInfoEXT.Buffer malloc(int capacity)
Returns a newXrDebugUtilsMessengerCreateInfoEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrDebugUtilsMessengerCreateInfoEXT.Buffer calloc(int capacity)
Returns a newXrDebugUtilsMessengerCreateInfoEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrDebugUtilsMessengerCreateInfoEXT.Buffer create(int capacity)
Returns a newXrDebugUtilsMessengerCreateInfoEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrDebugUtilsMessengerCreateInfoEXT.Buffer create(long address, int capacity)
Create aXrDebugUtilsMessengerCreateInfoEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrDebugUtilsMessengerCreateInfoEXT.Buffer createSafe(long address, int capacity)
-
malloc
public static XrDebugUtilsMessengerCreateInfoEXT malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrDebugUtilsMessengerCreateInfoEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrDebugUtilsMessengerCreateInfoEXT calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrDebugUtilsMessengerCreateInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static XrDebugUtilsMessengerCreateInfoEXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrDebugUtilsMessengerCreateInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrDebugUtilsMessengerCreateInfoEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrDebugUtilsMessengerCreateInfoEXT.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().
-
nmessageSeverities
public static long nmessageSeverities(long struct)
Unsafe version ofmessageSeverities().
-
nmessageTypes
public static long nmessageTypes(long struct)
Unsafe version ofmessageTypes().
-
nuserCallback
public static XrDebugUtilsMessengerCallbackEXT nuserCallback(long struct)
Unsafe version ofuserCallback().
-
nuserData
public static long nuserData(long struct)
Unsafe version ofuserData().
-
ntype
public static void ntype(long struct, int value)Unsafe version oftype.
-
nnext
public static void nnext(long struct, long value)Unsafe version ofnext.
-
nmessageSeverities
public static void nmessageSeverities(long struct, long value)Unsafe version ofmessageSeverities.
-
nmessageTypes
public static void nmessageTypes(long struct, long value)Unsafe version ofmessageTypes.
-
nuserCallback
public static void nuserCallback(long struct, XrDebugUtilsMessengerCallbackEXTI value)Unsafe version ofuserCallback.
-
nuserData
public static void nuserData(long struct, long value)Unsafe version ofuserData.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-