Package org.lwjgl.vulkan

Interface VkDebugUtilsMessengerCallbackEXTI

All Superinterfaces:
org.lwjgl.system.CallbackI, org.lwjgl.system.Pointer
All Known Implementing Classes:
VkDebugUtilsMessengerCallbackEXT
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 VkDebugUtilsMessengerCallbackEXTI extends org.lwjgl.system.CallbackI
Application-defined debug messenger callback function.
C Specification

The prototype for the VkDebugUtilsMessengerCreateInfoEXT::pfnUserCallback function implemented by the application is:


 typedef VkBool32 (VKAPI_PTR *PFN_vkDebugUtilsMessengerCallbackEXT)(
     VkDebugUtilsMessageSeverityFlagBitsEXT           messageSeverity,
     VkDebugUtilsMessageTypeFlagsEXT                  messageTypes,
     const VkDebugUtilsMessengerCallbackDataEXT*      pCallbackData,
     void*                                            pUserData);
Description

The callback returns a VkBool32, which is interpreted in a layer-specified manner. The application should always return FALSE. The TRUE value is reserved for use in layer development.

Valid Usage
  • The callback must not make calls to any Vulkan commands
See Also

VkDebugUtilsMessengerCallbackDataEXT, VkDebugUtilsMessengerCreateInfoEXT

  • 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(int messageSeverity, int messageTypes, long pCallbackData, long pUserData)
    Application-defined debug messenger callback function.

    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(int messageSeverity, int messageTypes, long pCallbackData, long pUserData)
      Application-defined debug messenger callback function.
      Parameters:
      messageSeverity - specifies the VkDebugUtilsMessageSeverityFlagBitsEXT that triggered this callback.
      messageTypes - a bitmask of VkDebugUtilsMessageTypeFlagBitsEXT specifying which type of event(s) triggered this callback.
      pCallbackData - contains all the callback related data in the VkDebugUtilsMessengerCallbackDataEXT structure.
      pUserData - the user data provided when the VkDebugUtilsMessengerEXT was created.