Top Description Inners Constructors Methods
org.lwjgl.openxr

public abstract Class XrDebugUtilsMessengerCallbackEXT

extends Callback
implements XrDebugUtilsMessengerCallbackEXTI
Class Inheritance
All Implemented Interfaces
org.lwjgl.openxr.XrDebugUtilsMessengerCallbackEXTI, org.lwjgl.system.CallbackI, org.lwjgl.system.Pointer
Known Direct Subclasses
org.lwjgl.openxr.XrDebugUtilsMessengerCallbackEXT.Container
Imports
javax.annotation.*, org.lwjgl.system.*

Type of callback function invoked by the debug utils.
C Specification

typedef XrBool32 (XRAPI_PTR *PFN_xrDebugUtilsMessengerCallbackEXT)(
            XrDebugUtilsMessageSeverityFlagsEXT              messageSeverity,
            XrDebugUtilsMessageTypeFlagsEXT                  messageTypes,
            const XrDebugUtilsMessengerCallbackDataEXT*      callbackData,
            void*                                            userData);
Description

The callback must not call DestroyDebugUtilsMessengerEXT.

The callback returns an 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 XrResult, 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

XrDebugUtilsMessengerCreateInfoEXT, CreateDebugUtilsMessengerEXT

Type


XrBool32 (*invoke) (
    XrDebugUtilsMessageSeverityFlagsEXT messageSeverity,
    XrDebugUtilsMessageTypeFlagsEXT messageTypes,
    XrDebugUtilsMessengerCallbackDataEXT const *callbackData,
    void *userData
)

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Constructor Summary

AccessConstructor and Description
protected
pack-priv
XrDebugUtilsMessengerCallbackEXT(long functionPointer)

Method Summary

Modifier and TypeMethod and Description
public static XrDebugUtilsMessengerCallbackEXT

Returns:

the new XrDebugUtilsMessengerCallbackEXT
create
(long functionPointer)

Creates a XrDebugUtilsMessengerCallbackEXT instance from the specified function pointer.

public static XrDebugUtilsMessengerCallbackEXT
create(XrDebugUtilsMessengerCallbackEXTI instance)

Creates a XrDebugUtilsMessengerCallbackEXT instance that delegates to the specified XrDebugUtilsMessengerCallbackEXTI instance.

public static XrDebugUtilsMessengerCallbackEXT
createSafe(long functionPointer)

Like create, but returns null if functionPointer is NULL.

Inherited from org.lwjgl.system.Callback:
addressequalsfreefreegetgetSafehashCodetoString

Constructor Detail

XrDebugUtilsMessengerCallbackEXTback to summary
protected XrDebugUtilsMessengerCallbackEXT()
XrDebugUtilsMessengerCallbackEXTback to summary
pack-priv XrDebugUtilsMessengerCallbackEXT(long functionPointer)

Method Detail

createback to summary
public static XrDebugUtilsMessengerCallbackEXT create(long functionPointer)

Creates a XrDebugUtilsMessengerCallbackEXT instance from the specified function pointer.

Returns:XrDebugUtilsMessengerCallbackEXT

the new XrDebugUtilsMessengerCallbackEXT

createback to summary
public static XrDebugUtilsMessengerCallbackEXT create(XrDebugUtilsMessengerCallbackEXTI instance)

Creates a XrDebugUtilsMessengerCallbackEXT instance that delegates to the specified XrDebugUtilsMessengerCallbackEXTI instance.

createSafeback to summary
public static XrDebugUtilsMessengerCallbackEXT createSafe(long functionPointer)

Like create, but returns null if functionPointer is NULL.

Annotations
@Nullable
org.lwjgl.openxr back to summary

private final Class XrDebugUtilsMessengerCallbackEXT.Container

extends XrDebugUtilsMessengerCallbackEXT
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final XrDebugUtilsMessengerCallbackEXTI

Constructor Summary

AccessConstructor and Description
pack-priv
Container(long functionPointer, XrDebugUtilsMessengerCallbackEXTI delegate)

Method Summary

Modifier and TypeMethod and Description
public int
invoke(long
indicates the single bit value of XrDebugUtilsMessageSeverityFlagsEXT that triggered this callback.
messageSeverity
,
long
indicates the XrDebugUtilsMessageTypeFlagsEXT specifying which types of event triggered this callback.
messageTypes
,
long
contains all the callback related data in the XrDebugUtilsMessengerCallbackDataEXT structure.
callbackData
,
long
the user data provided when the XrDebugUtilsMessengerEXT was created.
userData
)

Implements org.lwjgl.openxr.XrDebugUtilsMessengerCallbackEXTI.invoke.

Type of callback function invoked by the debug utils.
Inherited from org.lwjgl.openxr.XrDebugUtilsMessengerCallbackEXT:
createcreatecreateSafe

Field Detail

delegateback to summary
private final XrDebugUtilsMessengerCallbackEXTI delegate

Constructor Detail

Containerback to summary
pack-priv Container(long functionPointer, XrDebugUtilsMessengerCallbackEXTI delegate)

Method Detail

invokeback to summary
public int invoke(long messageSeverity, long messageTypes, long callbackData, long userData)

Implements org.lwjgl.openxr.XrDebugUtilsMessengerCallbackEXTI.invoke.

Doc from org.lwjgl.openxr.XrDebugUtilsMessengerCallbackEXTI.invoke.

Type of callback function invoked by the debug utils.

Parameters
messageSeverity:long

indicates the single bit value of XrDebugUtilsMessageSeverityFlagsEXT that triggered this callback.

messageTypes:long

indicates the XrDebugUtilsMessageTypeFlagsEXT specifying which types of event triggered this callback.

callbackData:long

contains all the callback related data in the XrDebugUtilsMessengerCallbackDataEXT structure.

userData:long

the user data provided when the XrDebugUtilsMessengerEXT was created.

Annotations
@Override