Interface VkDebugUtilsMessengerCallbackEXTI

  • All Superinterfaces:
    CallbackI, CallbackI.I, 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 CallbackI.I
    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                  messageType,
         const VkDebugUtilsMessengerCallbackDataEXT*      pCallbackData,
         void*                                            pUserData);
    Description

    The callback must not call DestroyDebugUtilsMessengerEXT.

    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.

    See Also

    VkDebugUtilsMessengerCreateInfoEXT

    • 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 messageSeverity,
                   int messageType,
                   long pCallbackData,
                   long pUserData)
        Application-defined debug messenger callback function.
        Parameters:
        messageSeverity - specifies the VkDebugUtilsMessageSeverityFlagBitsEXT that triggered this callback.
        pCallbackData - contains all the callback related data in the VkDebugUtilsMessengerCallbackDataEXT structure.
        pUserData - the user data provided when the VkDebugUtilsMessengerEXT was created.