Interface VkAllocationFunctionI

  • All Superinterfaces:
    CallbackI, CallbackI.P, Pointer
    All Known Implementing Classes:
    VkAllocationFunction
    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 VkAllocationFunctionI
    extends CallbackI.P
    Application-defined memory allocation function.
    C Specification

    The type of pfnAllocation is:

    
     typedef void* (VKAPI_PTR *PFN_vkAllocationFunction)(
         void*                                       pUserData,
         size_t                                      size,
         size_t                                      alignment,
         VkSystemAllocationScope                     allocationScope);
    Description

    If pfnAllocation is unable to allocate the requested memory, it must return NULL. If the allocation was successful, it must return a valid pointer to memory allocation containing at least size bytes, and with the pointer value being a multiple of alignment.

    Note

    Correct Vulkan operation cannot be assumed if the application does not follow these rules.

    For example, pfnAllocation (or pfnReallocation) could cause termination of running Vulkan instance(s) on a failed allocation for debugging purposes, either directly or indirectly. In these circumstances, it cannot be assumed that any part of any affected VkInstance objects are going to operate correctly (even DestroyInstance), and the application must ensure it cleans up properly via other means (e.g. process termination).

    If pfnAllocation returns NULL, and if the implementation is unable to continue correct processing of the current command without the requested allocation, it must treat this as a run-time error, and generate ERROR_OUT_OF_HOST_MEMORY at the appropriate time for the command in which the condition was detected, as described in Return Codes.

    If the implementation is able to continue correct processing of the current command without the requested allocation, then it may do so, and must not generate ERROR_OUT_OF_HOST_MEMORY as a result of this failed allocation.

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

        long invoke​(long pUserData,
                    long size,
                    long alignment,
                    int allocationScope)
        Application-defined memory allocation function.
        Parameters:
        pUserData - the value specified for VkAllocationCallbacks::pUserData in the allocator specified by the application.
        size - the size in bytes of the requested allocation.
        alignment - the requested alignment of the allocation in bytes and must be a power of two.
        allocationScope - a VkSystemAllocationScope value specifying the allocation scope of the lifetime of the allocation, as described here.