OpenXR.Extensions.XR_EXT_debug_utils

Name

XR_EXT_debug_utils - instance extension

Specification

See XR_EXT_debug_utils in the main specification for complete information.

Registered Extension Number

20

Revision

3

Extension and Version Dependencies

• Requires OpenXR 1.0

See Also

PFN_xrDebugUtilsMessengerCallbackEXT, DebugUtilsLabelEXT, DebugUtilsMessengerCallbackDataEXT, DebugUtilsMessengerCreateInfoEXT, DebugUtilsObjectNameInfoEXT, createDebugUtilsMessengerEXT, destroyDebugUtilsMessengerEXT, sessionBeginDebugUtilsLabelRegionEXT, sessionEndDebugUtilsLabelRegionEXT, sessionInsertDebugUtilsLabelEXT, setDebugUtilsObjectNameEXT, submitDebugUtilsMessageEXT

Document Notes

For more information, see the OpenXR Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Documentation

setDebugUtilsObjectNameEXT

Arguments

:: forall io. MonadIO io

=> Instance

instance is the Instance that the object was created under.

-> DebugUtilsObjectNameInfoEXT

nameInfo is a pointer to an instance of the DebugUtilsObjectNameInfoEXT structure specifying the parameters of the name to set on the object.

-> io ()

xrSetDebugUtilsObjectNameEXT - Sets debug utils object name

Valid Usage

• In the structure pointed to by nameInfo, DebugUtilsObjectNameInfoEXT::objectType must not be OBJECT_TYPE_UNKNOWN

• In the structure pointed to by nameInfo, DebugUtilsObjectNameInfoEXT::objectHandle must not be XR_NULL_HANDLE

Valid Usage (Implicit)

• The @@ extension must be enabled prior to calling setDebugUtilsObjectNameEXT

• instance must be a valid Instance handle
• nameInfo must be a pointer to a valid DebugUtilsObjectNameInfoEXT structure

Thread Safety

• Access to the objectHandle member of the nameInfo parameter must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_MEMORY
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_FUNCTION_UNSUPPORTED

Applications may change the name associated with an object simply by calling setDebugUtilsObjectNameEXT again with a new string. If DebugUtilsObjectNameInfoEXT::objectName is an empty string, then any previously set name is removed.

See Also

DebugUtilsObjectNameInfoEXT, Instance

createDebugUtilsMessengerEXT

Arguments

:: forall io. MonadIO io

=> Instance

instance is the instance the messenger will be used with.

-> DebugUtilsMessengerCreateInfoEXT

createInfo points to an DebugUtilsMessengerCreateInfoEXT structure, which contains the callback pointer as well as defines the conditions under which this messenger will trigger the callback.

-> io DebugUtilsMessengerEXT

xrCreateDebugUtilsMessengerEXT - Creates a debug messenger

Valid Usage (Implicit)

• The @@ extension must be enabled prior to calling createDebugUtilsMessengerEXT

• instance must be a valid Instance handle
• createInfo must be a pointer to a valid DebugUtilsMessengerCreateInfoEXT structure
• messenger must be a pointer to an DebugUtilsMessengerEXT handle

Thread Safety

• Access to instance, and any child handles, must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_MEMORY
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_LIMIT_REACHED
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_FUNCTION_UNSUPPORTED

The application must ensure that createDebugUtilsMessengerEXT is not executed in parallel with any OpenXR function that is also called with instance or child of instance.

When an event of interest occurs a debug messenger calls its createInfo->userCallback with a debug message from the producer of the event. Additionally, the debug messenger must filter out any debug messages that the application’s callback is not interested in based on DebugUtilsMessengerCreateInfoEXT flags, as described below.

See Also

DebugUtilsMessengerCreateInfoEXT, DebugUtilsMessengerEXT, Instance, destroyDebugUtilsMessengerEXT

withDebugUtilsMessengerEXT :: forall io r. MonadIO io => Instance -> DebugUtilsMessengerCreateInfoEXT -> (io DebugUtilsMessengerEXT -> (DebugUtilsMessengerEXT -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createDebugUtilsMessengerEXT and destroyDebugUtilsMessengerEXT

To ensure that destroyDebugUtilsMessengerEXT is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

destroyDebugUtilsMessengerEXT

Arguments

:: forall io. MonadIO io

=> DebugUtilsMessengerEXT

messenger the DebugUtilsMessengerEXT object to destroy. messenger is an externally synchronized object and must not be used on more than one thread at a time. This means that destroyDebugUtilsMessengerEXT must not be called when a callback is active.

-> io ()

xrDestroyDebugUtilsMessengerEXT - Destroys a debug messenger

Valid Usage (Implicit)

• The @@ extension must be enabled prior to calling destroyDebugUtilsMessengerEXT

• messenger must be a valid DebugUtilsMessengerEXT handle

Thread Safety

• Access to messenger must be externally synchronized

• Access to the Instance used to create messenger, and all of its child handles must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_HANDLE_INVALID
• ERROR_FUNCTION_UNSUPPORTED

The application must ensure that destroyDebugUtilsMessengerEXT is not executed in parallel with any OpenXR function that is also called with the instance or child of instance that it was created with.

See Also

DebugUtilsMessengerEXT, createDebugUtilsMessengerEXT

submitDebugUtilsMessageEXT

Arguments

:: forall io. MonadIO io

=> Instance

instance is the debug stream’s Instance.

-> DebugUtilsMessageSeverityFlagsEXT

messageSeverity is a single bit value of DebugUtilsMessageSeverityFlagsEXT severity of this event/message.

-> ("messageTypes" ::: DebugUtilsMessageTypeFlagsEXT)

messageTypes is an DebugUtilsMessageTypeFlagsEXT bitmask of XrDebugUtilsMessageTypeFlagBitsEXT specifying which types of event to identify this message with.

-> DebugUtilsMessengerCallbackDataEXT

callbackData contains all the callback related data in the DebugUtilsMessengerCallbackDataEXT structure.

-> io ()

xrSubmitDebugUtilsMessageEXT - Submits debug utils message

Valid Usage

• For each structure in objects found in callbackData, the value of DebugUtilsObjectNameInfoEXT::objectType must not be OBJECT_TYPE_UNKNOWN

Valid Usage (Implicit)

• The @@ extension must be enabled prior to calling submitDebugUtilsMessageEXT

• instance must be a valid Instance handle
• messageSeverity must be a valid combination of XrDebugUtilsMessageSeverityFlagBitsEXT values
• messageSeverity must not be 0
• messageTypes must be a valid combination of XrDebugUtilsMessageTypeFlagBitsEXT values
• messageTypes must not be 0
• callbackData must be a pointer to a valid DebugUtilsMessengerCallbackDataEXT structure

Return Codes

Success

• SUCCESS

Failure

• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_VALIDATION_FAILURE
• ERROR_FUNCTION_UNSUPPORTED

The application can also produce a debug message, and submit it into the OpenXR messaging system.

The call will propagate through the layers and generate callback(s) as indicated by the message’s flags. The parameters are passed on to the callback in addition to the userData value that was defined at the time the messenger was created.

See Also

DebugUtilsMessageSeverityFlagsEXT, DebugUtilsMessageTypeFlagsEXT, DebugUtilsMessengerCallbackDataEXT, Instance

sessionBeginDebugUtilsLabelRegionEXT

Arguments

:: forall io. MonadIO io

=> Session

session is the Session that a label region should be associated with.

-> ("labelInfo" ::: DebugUtilsLabelEXT)

labelInfo is the DebugUtilsLabelEXT containing the label information for the region that should be begun.

-> io Result

xrSessionBeginDebugUtilsLabelRegionEXT - Session begin debug utils label region

Valid Usage (Implicit)

• The @@ extension must be enabled prior to calling sessionBeginDebugUtilsLabelRegionEXT

• session must be a valid Session handle
• labelInfo must be a pointer to a valid DebugUtilsLabelEXT structure

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_SESSION_LOST
• ERROR_HANDLE_INVALID
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_FUNCTION_UNSUPPORTED

The sessionBeginDebugUtilsLabelRegionEXT function begins a label region within session.

See Also

DebugUtilsLabelEXT, Session

sessionEndDebugUtilsLabelRegionEXT

Arguments

:: forall io. MonadIO io

=> Session

session is the Session that a label region should be associated with.

-> io Result

xrSessionEndDebugUtilsLabelRegionEXT - Session end debug utils label region

Valid Usage

• sessionEndDebugUtilsLabelRegionEXT must be called only after a matching sessionBeginDebugUtilsLabelRegionEXT.

Valid Usage (Implicit)

• The @@ extension must be enabled prior to calling sessionEndDebugUtilsLabelRegionEXT

• session must be a valid Session handle

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_SESSION_LOST
• ERROR_HANDLE_INVALID
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_FUNCTION_UNSUPPORTED

This function ends the last label region begun with the sessionBeginDebugUtilsLabelRegionEXT function within the same session.

See Also

Session

sessionInsertDebugUtilsLabelEXT

Arguments

:: forall io. MonadIO io

=> Session

session is the Session that a label region should be associated with.

-> ("labelInfo" ::: DebugUtilsLabelEXT)

labelInfo is the DebugUtilsLabelEXT containing the label information for the region that should be begun.

-> io Result

xrSessionInsertDebugUtilsLabelEXT - Session insert debug utils label

Valid Usage (Implicit)

• The @@ extension must be enabled prior to calling sessionInsertDebugUtilsLabelEXT

• session must be a valid Session handle
• labelInfo must be a pointer to a valid DebugUtilsLabelEXT structure

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_SESSION_LOST
• ERROR_HANDLE_INVALID
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_FUNCTION_UNSUPPORTED

The sessionInsertDebugUtilsLabelEXT function inserts an individual label within session. The individual labels are useful for different reasons based on the type of debugging scenario. When used with something active like a profiler or debugger, it identifies a single point of time. When used with logging, the individual label identifies that a particular location has been passed at the point the log message is triggered. Because of this usage, individual labels only exist in a log until the next call to any of the label functions:

• sessionBeginDebugUtilsLabelRegionEXT
• sessionEndDebugUtilsLabelRegionEXT
• sessionInsertDebugUtilsLabelEXT

See Also

DebugUtilsLabelEXT, Session, sessionBeginDebugUtilsLabelRegionEXT, sessionEndDebugUtilsLabelRegionEXT

data DebugUtilsObjectNameInfoEXT

XrDebugUtilsObjectNameInfoEXT - Debug utils object name info

Valid Usage

• If objectType is OBJECT_TYPE_UNKNOWN, objectHandle must not be XR_NULL_HANDLE

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

Valid Usage (Implicit)

• The @@ extension must be enabled prior to using DebugUtilsObjectNameInfoEXT

• 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 ObjectType value
• If objectName is not NULL, objectName must be a null-terminated UTF-8 string

See Also

DebugUtilsMessengerCallbackDataEXT, ObjectType, StructureType, setDebugUtilsObjectNameEXT

Constructors

DebugUtilsObjectNameInfoEXT

Fields

• objectType :: ObjectType

  objectType is an ObjectType specifying the type of the object to be named.

• objectHandle :: Word64

  objectHandle is the object to be named.

• objectName :: Maybe ByteString

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

Instances

Show DebugUtilsObjectNameInfoEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

showsPrec :: Int -> DebugUtilsObjectNameInfoEXT -> ShowS

show :: DebugUtilsObjectNameInfoEXT -> String

showList :: [DebugUtilsObjectNameInfoEXT] -> ShowS

Zero DebugUtilsObjectNameInfoEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

zero :: DebugUtilsObjectNameInfoEXT

ToCStruct DebugUtilsObjectNameInfoEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

withCStruct :: DebugUtilsObjectNameInfoEXT -> (Ptr DebugUtilsObjectNameInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr DebugUtilsObjectNameInfoEXT -> DebugUtilsObjectNameInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr DebugUtilsObjectNameInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr DebugUtilsObjectNameInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct DebugUtilsObjectNameInfoEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

peekCStruct :: Ptr DebugUtilsObjectNameInfoEXT -> IO DebugUtilsObjectNameInfoEXT

data DebugUtilsLabelEXT

XrDebugUtilsLabelEXT - Debug Utils Label

Valid Usage (Implicit)

• The @@ extension must be enabled prior to using DebugUtilsLabelEXT

• type must be TYPE_DEBUG_UTILS_LABEL_EXT
• next must be NULL or a valid pointer to the next structure in a structure chain
• labelName must be a null-terminated UTF-8 string

See Also

DebugUtilsMessengerCallbackDataEXT, StructureType, sessionBeginDebugUtilsLabelRegionEXT, sessionInsertDebugUtilsLabelEXT

Constructors

DebugUtilsLabelEXT

Fields

• labelName :: ByteString

  labelName is a NULL terminated UTF-8 string specifying the label name.

Instances

Show DebugUtilsLabelEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

showsPrec :: Int -> DebugUtilsLabelEXT -> ShowS

show :: DebugUtilsLabelEXT -> String

showList :: [DebugUtilsLabelEXT] -> ShowS

Zero DebugUtilsLabelEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

zero :: DebugUtilsLabelEXT

ToCStruct DebugUtilsLabelEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

withCStruct :: DebugUtilsLabelEXT -> (Ptr DebugUtilsLabelEXT -> IO b) -> IO b

pokeCStruct :: Ptr DebugUtilsLabelEXT -> DebugUtilsLabelEXT -> IO b -> IO b

withZeroCStruct :: (Ptr DebugUtilsLabelEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr DebugUtilsLabelEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct DebugUtilsLabelEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

peekCStruct :: Ptr DebugUtilsLabelEXT -> IO DebugUtilsLabelEXT

data DebugUtilsMessengerCallbackDataEXT

XrDebugUtilsMessengerCallbackDataEXT - Debug utils messenger callback data

Valid Usage (Implicit)

• The @@ extension must be enabled prior to using DebugUtilsMessengerCallbackDataEXT

• 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 DebugUtilsMessengerCallbackDataEXT 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

DebugUtilsLabelEXT, DebugUtilsObjectNameInfoEXT, StructureType, submitDebugUtilsMessageEXT

Constructors

DebugUtilsMessengerCallbackDataEXT

Fields

• messageId :: ByteString

  messageId is 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 :: ByteString

  functionName is 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 :: ByteString

  message is a NULL terminated string detailing the trigger conditions.

• objectCount :: Word32

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

• objects :: Ptr DebugUtilsObjectNameInfoEXT

  objects is a pointer to an array of DebugUtilsObjectNameInfoEXT objects 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 :: Word32

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

• sessionLabels :: Ptr DebugUtilsLabelEXT

  sessionLabels is a pointer to an array of DebugUtilsLabelEXT objects 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.

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

Instances

Show DebugUtilsMessengerCallbackDataEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

showsPrec :: Int -> DebugUtilsMessengerCallbackDataEXT -> ShowS

show :: DebugUtilsMessengerCallbackDataEXT -> String

showList :: [DebugUtilsMessengerCallbackDataEXT] -> ShowS

Zero DebugUtilsMessengerCallbackDataEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

zero :: DebugUtilsMessengerCallbackDataEXT

ToCStruct DebugUtilsMessengerCallbackDataEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

withCStruct :: DebugUtilsMessengerCallbackDataEXT -> (Ptr DebugUtilsMessengerCallbackDataEXT -> IO b) -> IO b

pokeCStruct :: Ptr DebugUtilsMessengerCallbackDataEXT -> DebugUtilsMessengerCallbackDataEXT -> IO b -> IO b

withZeroCStruct :: (Ptr DebugUtilsMessengerCallbackDataEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr DebugUtilsMessengerCallbackDataEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct DebugUtilsMessengerCallbackDataEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

peekCStruct :: Ptr DebugUtilsMessengerCallbackDataEXT -> IO DebugUtilsMessengerCallbackDataEXT

data DebugUtilsMessengerCreateInfoEXT

XrDebugUtilsMessengerCreateInfoEXT - Debug utils messenger create info

Valid Usage

• userCallback must be a valid PFN_xrDebugUtilsMessengerCallbackEXT

Valid Usage (Implicit)

• The @@ extension must be enabled prior to using DebugUtilsMessengerCreateInfoEXT

• type must be TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT
• next must be NULL or a valid pointer to the next structure in a structure chain
• messageSeverities must be a valid combination of XrDebugUtilsMessageSeverityFlagBitsEXT values
• messageSeverities must not be 0
• messageTypes must be a valid combination of XrDebugUtilsMessageTypeFlagBitsEXT values
• messageTypes must not be 0
• userCallback must be a valid PFN_xrDebugUtilsMessengerCallbackEXT value

For each DebugUtilsMessengerEXT that is created the DebugUtilsMessengerCreateInfoEXT::messageSeverities and DebugUtilsMessengerCreateInfoEXT::messageTypes determine when that DebugUtilsMessengerCreateInfoEXT::userCallback is 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 XrDebugUtilsMessageSeverityFlagBitsEXT with the DebugUtilsMessengerCreateInfoEXT::messageSeverities provided during creation of the DebugUtilsMessengerEXT object.
• If this results in 0, the message is skipped.
• The runtime will perform bitwise AND of the event’s XrDebugUtilsMessageTypeFlagBitsEXT with the DebugUtilsMessengerCreateInfoEXT::messageTypes provided during the creation of the DebugUtilsMessengerEXT object.
• 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

PFN_xrDebugUtilsMessengerCallbackEXT, DebugUtilsMessageSeverityFlagsEXT, DebugUtilsMessageTypeFlagsEXT, StructureType, createDebugUtilsMessengerEXT

Constructors

DebugUtilsMessengerCreateInfoEXT

Fields

• messageSeverities :: DebugUtilsMessageSeverityFlagsEXT

  messageSeverities is a bitmask of XrDebugUtilsMessageSeverityFlagBitsEXT specifying which severity of event(s) that will cause this callback to be called.

• messageTypes :: DebugUtilsMessageTypeFlagsEXT

  messageTypes is a combination of XrDebugUtilsMessageTypeFlagBitsEXT specifying which type of event(s) will cause this callback to be called.

• userCallback :: PFN_xrDebugUtilsMessengerCallbackEXT

  userCallback is the application defined callback function to call.

• userData :: Ptr ()

  userData is arbitrary user data to be passed to the callback.

Instances

Show DebugUtilsMessengerCreateInfoEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

showsPrec :: Int -> DebugUtilsMessengerCreateInfoEXT -> ShowS

show :: DebugUtilsMessengerCreateInfoEXT -> String

showList :: [DebugUtilsMessengerCreateInfoEXT] -> ShowS

Storable DebugUtilsMessengerCreateInfoEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

sizeOf :: DebugUtilsMessengerCreateInfoEXT -> Int

alignment :: DebugUtilsMessengerCreateInfoEXT -> Int

peekElemOff :: Ptr DebugUtilsMessengerCreateInfoEXT -> Int -> IO DebugUtilsMessengerCreateInfoEXT

pokeElemOff :: Ptr DebugUtilsMessengerCreateInfoEXT -> Int -> DebugUtilsMessengerCreateInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO DebugUtilsMessengerCreateInfoEXT

pokeByteOff :: Ptr b -> Int -> DebugUtilsMessengerCreateInfoEXT -> IO ()

peek :: Ptr DebugUtilsMessengerCreateInfoEXT -> IO DebugUtilsMessengerCreateInfoEXT

poke :: Ptr DebugUtilsMessengerCreateInfoEXT -> DebugUtilsMessengerCreateInfoEXT -> IO ()

Zero DebugUtilsMessengerCreateInfoEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

zero :: DebugUtilsMessengerCreateInfoEXT

ToCStruct DebugUtilsMessengerCreateInfoEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

withCStruct :: DebugUtilsMessengerCreateInfoEXT -> (Ptr DebugUtilsMessengerCreateInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr DebugUtilsMessengerCreateInfoEXT -> DebugUtilsMessengerCreateInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr DebugUtilsMessengerCreateInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr DebugUtilsMessengerCreateInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct DebugUtilsMessengerCreateInfoEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

peekCStruct :: Ptr DebugUtilsMessengerCreateInfoEXT -> IO DebugUtilsMessengerCreateInfoEXT

newtype DebugUtilsMessageSeverityFlagsEXT

XrDebugUtilsMessageSeverityFlagsEXT - XrDebugUtilsMessageSeverityFlagsEXT

See Also

DebugUtilsMessengerCreateInfoEXT, submitDebugUtilsMessageEXT

Constructors

DebugUtilsMessageSeverityFlagsEXT Flags64

Instances

Eq DebugUtilsMessageSeverityFlagsEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

(==) :: DebugUtilsMessageSeverityFlagsEXT -> DebugUtilsMessageSeverityFlagsEXT -> Bool

(/=) :: DebugUtilsMessageSeverityFlagsEXT -> DebugUtilsMessageSeverityFlagsEXT -> Bool

Ord DebugUtilsMessageSeverityFlagsEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

compare :: DebugUtilsMessageSeverityFlagsEXT -> DebugUtilsMessageSeverityFlagsEXT -> Ordering

(<) :: DebugUtilsMessageSeverityFlagsEXT -> DebugUtilsMessageSeverityFlagsEXT -> Bool

(<=) :: DebugUtilsMessageSeverityFlagsEXT -> DebugUtilsMessageSeverityFlagsEXT -> Bool

(>) :: DebugUtilsMessageSeverityFlagsEXT -> DebugUtilsMessageSeverityFlagsEXT -> Bool

(>=) :: DebugUtilsMessageSeverityFlagsEXT -> DebugUtilsMessageSeverityFlagsEXT -> Bool

max :: DebugUtilsMessageSeverityFlagsEXT -> DebugUtilsMessageSeverityFlagsEXT -> DebugUtilsMessageSeverityFlagsEXT

min :: DebugUtilsMessageSeverityFlagsEXT -> DebugUtilsMessageSeverityFlagsEXT -> DebugUtilsMessageSeverityFlagsEXT

Read DebugUtilsMessageSeverityFlagsEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

readsPrec :: Int -> ReadS DebugUtilsMessageSeverityFlagsEXT

readList :: ReadS [DebugUtilsMessageSeverityFlagsEXT]

readPrec :: ReadPrec DebugUtilsMessageSeverityFlagsEXT

readListPrec :: ReadPrec [DebugUtilsMessageSeverityFlagsEXT]

Show DebugUtilsMessageSeverityFlagsEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

showsPrec :: Int -> DebugUtilsMessageSeverityFlagsEXT -> ShowS

show :: DebugUtilsMessageSeverityFlagsEXT -> String

showList :: [DebugUtilsMessageSeverityFlagsEXT] -> ShowS

Storable DebugUtilsMessageSeverityFlagsEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

sizeOf :: DebugUtilsMessageSeverityFlagsEXT -> Int

alignment :: DebugUtilsMessageSeverityFlagsEXT -> Int

peekElemOff :: Ptr DebugUtilsMessageSeverityFlagsEXT -> Int -> IO DebugUtilsMessageSeverityFlagsEXT

pokeElemOff :: Ptr DebugUtilsMessageSeverityFlagsEXT -> Int -> DebugUtilsMessageSeverityFlagsEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO DebugUtilsMessageSeverityFlagsEXT

pokeByteOff :: Ptr b -> Int -> DebugUtilsMessageSeverityFlagsEXT -> IO ()

peek :: Ptr DebugUtilsMessageSeverityFlagsEXT -> IO DebugUtilsMessageSeverityFlagsEXT

poke :: Ptr DebugUtilsMessageSeverityFlagsEXT -> DebugUtilsMessageSeverityFlagsEXT -> IO ()

Bits DebugUtilsMessageSeverityFlagsEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

(.&.) :: DebugUtilsMessageSeverityFlagsEXT -> DebugUtilsMessageSeverityFlagsEXT -> DebugUtilsMessageSeverityFlagsEXT

(.|.) :: DebugUtilsMessageSeverityFlagsEXT -> DebugUtilsMessageSeverityFlagsEXT -> DebugUtilsMessageSeverityFlagsEXT

xor :: DebugUtilsMessageSeverityFlagsEXT -> DebugUtilsMessageSeverityFlagsEXT -> DebugUtilsMessageSeverityFlagsEXT

complement :: DebugUtilsMessageSeverityFlagsEXT -> DebugUtilsMessageSeverityFlagsEXT

shift :: DebugUtilsMessageSeverityFlagsEXT -> Int -> DebugUtilsMessageSeverityFlagsEXT

rotate :: DebugUtilsMessageSeverityFlagsEXT -> Int -> DebugUtilsMessageSeverityFlagsEXT

zeroBits :: DebugUtilsMessageSeverityFlagsEXT

bit :: Int -> DebugUtilsMessageSeverityFlagsEXT

setBit :: DebugUtilsMessageSeverityFlagsEXT -> Int -> DebugUtilsMessageSeverityFlagsEXT

clearBit :: DebugUtilsMessageSeverityFlagsEXT -> Int -> DebugUtilsMessageSeverityFlagsEXT

complementBit :: DebugUtilsMessageSeverityFlagsEXT -> Int -> DebugUtilsMessageSeverityFlagsEXT

testBit :: DebugUtilsMessageSeverityFlagsEXT -> Int -> Bool

bitSizeMaybe :: DebugUtilsMessageSeverityFlagsEXT -> Maybe Int

bitSize :: DebugUtilsMessageSeverityFlagsEXT -> Int

isSigned :: DebugUtilsMessageSeverityFlagsEXT -> Bool

shiftL :: DebugUtilsMessageSeverityFlagsEXT -> Int -> DebugUtilsMessageSeverityFlagsEXT

unsafeShiftL :: DebugUtilsMessageSeverityFlagsEXT -> Int -> DebugUtilsMessageSeverityFlagsEXT

shiftR :: DebugUtilsMessageSeverityFlagsEXT -> Int -> DebugUtilsMessageSeverityFlagsEXT

unsafeShiftR :: DebugUtilsMessageSeverityFlagsEXT -> Int -> DebugUtilsMessageSeverityFlagsEXT

rotateL :: DebugUtilsMessageSeverityFlagsEXT -> Int -> DebugUtilsMessageSeverityFlagsEXT

rotateR :: DebugUtilsMessageSeverityFlagsEXT -> Int -> DebugUtilsMessageSeverityFlagsEXT

popCount :: DebugUtilsMessageSeverityFlagsEXT -> Int

FiniteBits DebugUtilsMessageSeverityFlagsEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

finiteBitSize :: DebugUtilsMessageSeverityFlagsEXT -> Int

countLeadingZeros :: DebugUtilsMessageSeverityFlagsEXT -> Int

countTrailingZeros :: DebugUtilsMessageSeverityFlagsEXT -> Int

Zero DebugUtilsMessageSeverityFlagsEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

zero :: DebugUtilsMessageSeverityFlagsEXT

newtype DebugUtilsMessageTypeFlagsEXT

XrDebugUtilsMessageTypeFlagsEXT - XrDebugUtilsMessageTypeFlagsEXT

See Also

DebugUtilsMessengerCreateInfoEXT, submitDebugUtilsMessageEXT

Constructors

DebugUtilsMessageTypeFlagsEXT Flags64

Instances

Eq DebugUtilsMessageTypeFlagsEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

(==) :: DebugUtilsMessageTypeFlagsEXT -> DebugUtilsMessageTypeFlagsEXT -> Bool

(/=) :: DebugUtilsMessageTypeFlagsEXT -> DebugUtilsMessageTypeFlagsEXT -> Bool

Ord DebugUtilsMessageTypeFlagsEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

compare :: DebugUtilsMessageTypeFlagsEXT -> DebugUtilsMessageTypeFlagsEXT -> Ordering

(<) :: DebugUtilsMessageTypeFlagsEXT -> DebugUtilsMessageTypeFlagsEXT -> Bool

(<=) :: DebugUtilsMessageTypeFlagsEXT -> DebugUtilsMessageTypeFlagsEXT -> Bool

(>) :: DebugUtilsMessageTypeFlagsEXT -> DebugUtilsMessageTypeFlagsEXT -> Bool

(>=) :: DebugUtilsMessageTypeFlagsEXT -> DebugUtilsMessageTypeFlagsEXT -> Bool

max :: DebugUtilsMessageTypeFlagsEXT -> DebugUtilsMessageTypeFlagsEXT -> DebugUtilsMessageTypeFlagsEXT

min :: DebugUtilsMessageTypeFlagsEXT -> DebugUtilsMessageTypeFlagsEXT -> DebugUtilsMessageTypeFlagsEXT

Read DebugUtilsMessageTypeFlagsEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

readsPrec :: Int -> ReadS DebugUtilsMessageTypeFlagsEXT

readList :: ReadS [DebugUtilsMessageTypeFlagsEXT]

readPrec :: ReadPrec DebugUtilsMessageTypeFlagsEXT

readListPrec :: ReadPrec [DebugUtilsMessageTypeFlagsEXT]

Show DebugUtilsMessageTypeFlagsEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

showsPrec :: Int -> DebugUtilsMessageTypeFlagsEXT -> ShowS

show :: DebugUtilsMessageTypeFlagsEXT -> String

showList :: [DebugUtilsMessageTypeFlagsEXT] -> ShowS

Storable DebugUtilsMessageTypeFlagsEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

sizeOf :: DebugUtilsMessageTypeFlagsEXT -> Int

alignment :: DebugUtilsMessageTypeFlagsEXT -> Int

peekElemOff :: Ptr DebugUtilsMessageTypeFlagsEXT -> Int -> IO DebugUtilsMessageTypeFlagsEXT

pokeElemOff :: Ptr DebugUtilsMessageTypeFlagsEXT -> Int -> DebugUtilsMessageTypeFlagsEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO DebugUtilsMessageTypeFlagsEXT

pokeByteOff :: Ptr b -> Int -> DebugUtilsMessageTypeFlagsEXT -> IO ()

peek :: Ptr DebugUtilsMessageTypeFlagsEXT -> IO DebugUtilsMessageTypeFlagsEXT

poke :: Ptr DebugUtilsMessageTypeFlagsEXT -> DebugUtilsMessageTypeFlagsEXT -> IO ()

Bits DebugUtilsMessageTypeFlagsEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

(.&.) :: DebugUtilsMessageTypeFlagsEXT -> DebugUtilsMessageTypeFlagsEXT -> DebugUtilsMessageTypeFlagsEXT

(.|.) :: DebugUtilsMessageTypeFlagsEXT -> DebugUtilsMessageTypeFlagsEXT -> DebugUtilsMessageTypeFlagsEXT

xor :: DebugUtilsMessageTypeFlagsEXT -> DebugUtilsMessageTypeFlagsEXT -> DebugUtilsMessageTypeFlagsEXT

complement :: DebugUtilsMessageTypeFlagsEXT -> DebugUtilsMessageTypeFlagsEXT

shift :: DebugUtilsMessageTypeFlagsEXT -> Int -> DebugUtilsMessageTypeFlagsEXT

rotate :: DebugUtilsMessageTypeFlagsEXT -> Int -> DebugUtilsMessageTypeFlagsEXT

zeroBits :: DebugUtilsMessageTypeFlagsEXT

bit :: Int -> DebugUtilsMessageTypeFlagsEXT

setBit :: DebugUtilsMessageTypeFlagsEXT -> Int -> DebugUtilsMessageTypeFlagsEXT

clearBit :: DebugUtilsMessageTypeFlagsEXT -> Int -> DebugUtilsMessageTypeFlagsEXT

complementBit :: DebugUtilsMessageTypeFlagsEXT -> Int -> DebugUtilsMessageTypeFlagsEXT

testBit :: DebugUtilsMessageTypeFlagsEXT -> Int -> Bool

bitSizeMaybe :: DebugUtilsMessageTypeFlagsEXT -> Maybe Int

bitSize :: DebugUtilsMessageTypeFlagsEXT -> Int

isSigned :: DebugUtilsMessageTypeFlagsEXT -> Bool

shiftL :: DebugUtilsMessageTypeFlagsEXT -> Int -> DebugUtilsMessageTypeFlagsEXT

unsafeShiftL :: DebugUtilsMessageTypeFlagsEXT -> Int -> DebugUtilsMessageTypeFlagsEXT

shiftR :: DebugUtilsMessageTypeFlagsEXT -> Int -> DebugUtilsMessageTypeFlagsEXT

unsafeShiftR :: DebugUtilsMessageTypeFlagsEXT -> Int -> DebugUtilsMessageTypeFlagsEXT

rotateL :: DebugUtilsMessageTypeFlagsEXT -> Int -> DebugUtilsMessageTypeFlagsEXT

rotateR :: DebugUtilsMessageTypeFlagsEXT -> Int -> DebugUtilsMessageTypeFlagsEXT

popCount :: DebugUtilsMessageTypeFlagsEXT -> Int

FiniteBits DebugUtilsMessageTypeFlagsEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

finiteBitSize :: DebugUtilsMessageTypeFlagsEXT -> Int

countLeadingZeros :: DebugUtilsMessageTypeFlagsEXT -> Int

countTrailingZeros :: DebugUtilsMessageTypeFlagsEXT -> Int

Zero DebugUtilsMessageTypeFlagsEXT

Defined in OpenXR.Extensions.XR_EXT_debug_utils

Methods

zero :: DebugUtilsMessageTypeFlagsEXT

type PFN_xrDebugUtilsMessengerCallbackEXT = FunPtr FN_xrDebugUtilsMessengerCallbackEXT

PFN_xrDebugUtilsMessengerCallbackEXT - Type of callback function invoked by the debug utils

Parameter Descriptions

Description

The callback must not call destroyDebugUtilsMessengerEXT.

The callback returns an https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrBool32 that indicates to the calling layer the application’s desire to abort the call. A value of TRUE indicates that the application wants to abort this call. If the application returns FALSE, the function must not be aborted. Applications should always return FALSE so that they see the same behavior with and without validation layers enabled.

If the application returns TRUE from its callback and the OpenXR call being aborted returns an Result, the layer will return ERROR_VALIDATION_FAILURE.

The object pointed to by callbackData (and any pointers in it recursively) must be valid during the lifetime of the triggered callback. It may become invalid afterwards.

See Also

DebugUtilsMessengerCreateInfoEXT, createDebugUtilsMessengerEXT

type FN_xrDebugUtilsMessengerCallbackEXT = DebugUtilsMessageSeverityFlagsEXT -> ("messageTypes" ::: DebugUtilsMessageTypeFlagsEXT) -> Ptr DebugUtilsMessengerCallbackDataEXT -> ("userData" ::: Ptr ()) -> IO Bool32

type EXT_debug_utils_SPEC_VERSION = 3

pattern EXT_debug_utils_SPEC_VERSION :: forall a. Integral a => a

type EXT_DEBUG_UTILS_EXTENSION_NAME = "XR_EXT_debug_utils"

pattern EXT_DEBUG_UTILS_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

data DebugUtilsMessengerEXT

XrDebugUtilsMessengerEXT - Callback for debug data

Description

DebugUtilsMessengerEXT represents a callback function and associated filters registered with the runtime.

See Also

createDebugUtilsMessengerEXT, destroyDebugUtilsMessengerEXT

Constructors

DebugUtilsMessengerEXT

Fields

• debugUtilsMessengerEXTHandle :: Ptr DebugUtilsMessengerEXT_T
• instanceCmds :: InstanceCmds

Instances

Eq DebugUtilsMessengerEXT

Defined in OpenXR.Extensions.Handles

Methods

(==) :: DebugUtilsMessengerEXT -> DebugUtilsMessengerEXT -> Bool

(/=) :: DebugUtilsMessengerEXT -> DebugUtilsMessengerEXT -> Bool

Show DebugUtilsMessengerEXT

Defined in OpenXR.Extensions.Handles

Methods

showsPrec :: Int -> DebugUtilsMessengerEXT -> ShowS

show :: DebugUtilsMessengerEXT -> String

showList :: [DebugUtilsMessengerEXT] -> ShowS

Zero DebugUtilsMessengerEXT

Defined in OpenXR.Extensions.Handles

Methods

zero :: DebugUtilsMessengerEXT

HasObjectType DebugUtilsMessengerEXT

Defined in OpenXR.Extensions.Handles

Methods

objectTypeAndHandle :: DebugUtilsMessengerEXT -> (ObjectType, Word64)

IsHandle DebugUtilsMessengerEXT

Defined in OpenXR.Extensions.Handles