Package org.lwjgl.openxr

Class XrDebugUtilsMessengerCallbackEXT

java.lang.Object

org.lwjgl.system.Callback

org.lwjgl.openxr.XrDebugUtilsMessengerCallbackEXT

All Implemented Interfaces:

AutoCloseable, XrDebugUtilsMessengerCallbackEXTI, org.lwjgl.system.CallbackI, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public abstract class XrDebugUtilsMessengerCallbackEXT
extends org.lwjgl.system.Callback
implements XrDebugUtilsMessengerCallbackEXTI

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 (*XrDebugUtilsMessengerCallbackEXTI.invoke(long, long, long, long)) (
     XrDebugUtilsMessageSeverityFlagsEXT messageSeverity,
     XrDebugUtilsMessageTypeFlagsEXT messageTypes,
     XrDebugUtilsMessengerCallbackDataEXT const *callbackData,
     void *userData
 )

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Fields inherited from interface org.lwjgl.openxr.XrDebugUtilsMessengerCallbackEXTI

CIF

Method Summary

Modifier and Type	Method	Description
static XrDebugUtilsMessengerCallbackEXT	create(long functionPointer)	Creates a XrDebugUtilsMessengerCallbackEXT instance from the specified function pointer.
static XrDebugUtilsMessengerCallbackEXT	create(XrDebugUtilsMessengerCallbackEXTI instance)	Creates a XrDebugUtilsMessengerCallbackEXT instance that delegates to the specified XrDebugUtilsMessengerCallbackEXTI instance.
static @Nullable XrDebugUtilsMessengerCallbackEXT	createSafe(long functionPointer)	Like create, but returns null if functionPointer is NULL.

Methods inherited from class org.lwjgl.system.Callback

address, equals, free, free, get, getSafe, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.CallbackI

address

Methods inherited from interface org.lwjgl.system.NativeResource

close

Methods inherited from interface org.lwjgl.openxr.XrDebugUtilsMessengerCallbackEXTI

callback, getCallInterface, invoke

Method Details

create

public static XrDebugUtilsMessengerCallbackEXT create(long functionPointer)

Creates a XrDebugUtilsMessengerCallbackEXT instance from the specified function pointer.

Returns:

the new XrDebugUtilsMessengerCallbackEXT

createSafe

public static @Nullable XrDebugUtilsMessengerCallbackEXT createSafe(long functionPointer)

Like create, but returns null if functionPointer is NULL.

create

public static XrDebugUtilsMessengerCallbackEXT create(XrDebugUtilsMessengerCallbackEXTI instance)

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