Interface VkFreeFunctionI

  • All Superinterfaces:
    CallbackI, CallbackI.V, Pointer
    All Known Implementing Classes:
    VkFreeFunction
    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 VkFreeFunctionI
    extends CallbackI.V
    Application-defined memory free function.
    C Specification

    The type of pfnFree is:

    
     typedef void (VKAPI_PTR *PFN_vkFreeFunction)(
         void*                                       pUserData,
         void*                                       pMemory);
    Description

    pMemory may be NULL, which the callback must handle safely. If pMemory is non-NULL, it must be a pointer previously allocated by pfnAllocation or pfnReallocation. The application should free this memory.

    See Also

    VkAllocationCallbacks

    • 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 void callback​(long args)
        Description copied from interface: CallbackI.V
        Will be called by native code.
        Specified by:
        callback in interface CallbackI.V
        Parameters:
        args - pointer to a DCArgs iterator
      • invoke

        void invoke​(long pUserData,
                    long pMemory)
        Application-defined memory free function.
        Parameters:
        pUserData - the value specified for VkAllocationCallbacks::pUserData in the allocator specified by the application.
        pMemory - the allocation to be freed.