Interface VkDebugReportCallbackEXTI

  • All Superinterfaces:
    CallbackI, CallbackI.I, 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 CallbackI.I
    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

    • Field Detail

      • SIGNATURE

        static final java.lang.String SIGNATURE
    • Method Detail

      • getSignature

        default java.lang.String getSignature()
        Description copied from interface: CallbackI
        Returns the dyncall signature for this callback function. [INTERNAL API]
        Specified by:
        getSignature in interface CallbackI
        Returns:
        the dyncall signature
      • callback

        default int callback​(long args)
        Description copied from interface: CallbackI.I
        Will be called by native code.
        Specified by:
        callback in interface CallbackI.I
        Parameters:
        args - pointer to a DCArgs iterator
        Returns:
        the value to store to the result DCValue
      • 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 that specifies 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 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 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.