Package org.lwjgl.openxr

Interface XrDebugUtilsMessengerCallbackEXTI

All Superinterfaces:
org.lwjgl.system.CallbackI, org.lwjgl.system.Pointer
All Known Implementing Classes:
XrDebugUtilsMessengerCallbackEXT
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface XrDebugUtilsMessengerCallbackEXTI extends org.lwjgl.system.CallbackI
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(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
    Modifier and Type
    Field
    Description
    static final org.lwjgl.system.libffi.FFICIF
    CIF
     

    Fields inherited from interface org.lwjgl.system.Pointer

    BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    callback(long ret, long args)
     
    default org.lwjgl.system.libffi.FFICIF
    getCallInterface()
     
    int
    invoke(long messageSeverity, long messageTypes, long callbackData, long userData)
    Type of callback function invoked by the debug utils.

    Methods inherited from interface org.lwjgl.system.CallbackI

    address

  • Field Details

    • CIF

      static final org.lwjgl.system.libffi.FFICIF CIF

  • Method Details

    • getCallInterface

      default org.lwjgl.system.libffi.FFICIF getCallInterface()
      Specified by:
      getCallInterface in interface org.lwjgl.system.CallbackI

    • callback

      default void callback(long ret, long args)
      Specified by:
      callback in interface org.lwjgl.system.CallbackI

    • invoke

      int invoke(long messageSeverity, long messageTypes, long callbackData, long userData)
      Type of callback function invoked by the debug utils.
      Parameters:
      messageSeverity - indicates the single bit value of XrDebugUtilsMessageSeverityFlagsEXT that triggered this callback.
      messageTypes - indicates the XrDebugUtilsMessageTypeFlagsEXT specifying which types of event triggered this callback.
      callbackData - contains all the callback related data in the XrDebugUtilsMessengerCallbackDataEXT structure.
      userData - the user data provided when the XrDebugUtilsMessengerEXT was created.