Package org.lwjgl.vulkan

Class VkAllocationFunction

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.CallbackI, org.lwjgl.system.CallbackI.P, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer, VkAllocationFunctionI
    public abstract class VkAllocationFunction
extends org.lwjgl.system.Callback
implements VkAllocationFunctionI
    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

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.lwjgl.system.CallbackI

        org.lwjgl.system.CallbackI.B, org.lwjgl.system.CallbackI.D, org.lwjgl.system.CallbackI.F, org.lwjgl.system.CallbackI.I, org.lwjgl.system.CallbackI.J, org.lwjgl.system.CallbackI.N, org.lwjgl.system.CallbackI.P, org.lwjgl.system.CallbackI.S, org.lwjgl.system.CallbackI.V, org.lwjgl.system.CallbackI.Z

      • Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

        org.lwjgl.system.Pointer.Default

    • Field Summary

      • Fields inherited from interface org.lwjgl.system.Pointer

        BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static VkAllocationFunction create​(long functionPointer)
      Creates a VkAllocationFunction instance from the specified function pointer.
      static VkAllocationFunction create​(VkAllocationFunctionI instance)
      Creates a VkAllocationFunction instance that delegates to the specified VkAllocationFunctionI instance.
      static VkAllocationFunction createSafe​(long functionPointer)
      Like create, but returns null if functionPointer is NULL.

      • Methods inherited from class org.lwjgl.system.Callback

        __stdcall, address, equals, free, free, get, getSafe, hashCode, toString

      • Methods inherited from interface org.lwjgl.system.CallbackI

        address

      • Methods inherited from interface org.lwjgl.system.NativeResource

        close

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • create

        public static VkAllocationFunction create​(long functionPointer)
        Creates a VkAllocationFunction instance from the specified function pointer.
        Returns:
        the new VkAllocationFunction

      • createSafe

        @Nullable
public static VkAllocationFunction createSafe​(long functionPointer)
        Like create, but returns null if functionPointer is NULL.