Package org.lwjgl.vulkan

Interface VkDebugReportCallbackEXTI

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

The prototype for the VkDebugReportCallbackCreateInfoEXT::pfnCallback function implemented by the application is:


 typedef VkBool32 (VKAPI_PTR *PFN_vkDebugReportCallbackEXT)(
     VkDebugReportFlagsEXT                       flags,
     VkDebugReportObjectTypeEXT                  objectType,
     uint64_t                                    object,
     size_t                                      location,
     int32_t                                     messageCode,
     const char*                                 pLayerPrefix,
     const char*                                 pMessage,
     void*                                       pUserData);
Description

The callback must not call vkDestroyDebugReportCallbackEXT.

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.

object must be a Vulkan object or NULL_HANDLE. If objectType is not DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT and object is not NULL_HANDLE, object must be a Vulkan object of the corresponding type associated with objectType as defined in VkDebugReportObjectTypeEXT and Vulkan Handle Relationship.

See Also

VkDebugReportCallbackCreateInfoEXT

  • 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 flags, int objectType, long object, long location, int messageCode, long pLayerPrefix, long pMessage, long pUserData)
    Application-defined debug report 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 flags, int objectType, long object, long location, int messageCode, long pLayerPrefix, long pMessage, long pUserData)
      Application-defined debug report callback function.
      Parameters:
      flags - specifies the VkDebugReportFlagBitsEXT that triggered this callback.
      objectType - a VkDebugReportObjectTypeEXT value specifying the type of object being used or created at the time the event was triggered.
      object - the object where the issue was detected. If objectType is DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, object is undefined.
      location - a component (layer, driver, loader) defined value specifying the location of the trigger. This is an optional value.
      messageCode - a layer-defined value indicating what test triggered this callback.
      pLayerPrefix - a null-terminated UTF-8 string that is an abbreviation of the name of the component making the callback. pLayerPrefix is only valid for the duration of the callback.
      pMessage - a null-terminated UTF-8 string detailing the trigger conditions. pMessage is only valid for the duration of the callback.
      pUserData - the user data given when the VkDebugReportCallbackEXT was created.