org.lwjgl.vulkan.VkAllocationFunction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-vulkan Show documentation
A new generation graphics and compute API that provides high-efficiency, cross-platform access to modern GPUs used in a wide variety of devices from PCs and consoles to mobile phones and embedded platforms.
There is a newer version: 3.3.4
Show newest version
/*
 * Copyright LWJGL. All rights reserved.
 * License terms: https://www.lwjgl.org/license
 * MACHINE GENERATED FILE, DO NOT EDIT
 */
package org.lwjgl.vulkan;

import javax.annotation.*;

import org.lwjgl.system.*;

import static org.lwjgl.system.MemoryUtil.*;

/**
 * Application-defined memory allocation function.
 * 
 * C Specification
 * 
 * The type of {@code pfnAllocation} is:
 * 
 *  * typedef void* (VKAPI_PTR *PFN_vkAllocationFunction)(
 *     void*                                       pUserData,
 *     size_t                                      size,
 *     size_t                                      alignment,
 *     VkSystemAllocationScope                     allocationScope);
 * 
 * Description
 * 
 * If {@code pfnAllocation} is unable to allocate the requested memory, it must return {@code NULL}. If the allocation was successful, it must return a valid pointer to memory allocation containing at least {@code size} bytes, and with the pointer value being a multiple of {@code alignment}.
 * 
 * Note
 * 
 * Correct Vulkan operation cannot be assumed if the application does not follow these rules.
 * 
 * For example, {@code pfnAllocation} (or {@code 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 {@code VkInstance} objects are going to operate correctly (even {@link VK10#vkDestroyInstance DestroyInstance}), and the application must ensure it cleans up properly via other means (e.g. process termination).
 * 
 * 
 * If {@code pfnAllocation} returns {@code 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 {@link VK10#VK_ERROR_OUT_OF_HOST_MEMORY 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 {@link VK10#VK_ERROR_OUT_OF_HOST_MEMORY ERROR_OUT_OF_HOST_MEMORY} as a result of this failed allocation.
 * 
 * See Also
 * 
 * {@link VkAllocationCallbacks}
 */
public abstract class VkAllocationFunction extends Callback implements VkAllocationFunctionI {

    /**
     * Creates a {@code VkAllocationFunction} instance from the specified function pointer.
     *
     * @return the new {@code VkAllocationFunction}
     */
    public static VkAllocationFunction create(long functionPointer) {
        VkAllocationFunctionI instance = Callback.get(functionPointer);
        return instance instanceof VkAllocationFunction
            ? (VkAllocationFunction)instance
            : new Container(functionPointer, instance);
    }

    /** Like {@link #create(long) create}, but returns {@code null} if {@code functionPointer} is {@code NULL}. */
    @Nullable
    public static VkAllocationFunction createSafe(long functionPointer) {
        return functionPointer == NULL ? null : create(functionPointer);
    }

    /** Creates a {@code VkAllocationFunction} instance that delegates to the specified {@code VkAllocationFunctionI} instance. */
    public static VkAllocationFunction create(VkAllocationFunctionI instance) {
        return instance instanceof VkAllocationFunction
            ? (VkAllocationFunction)instance
            : new Container(instance.address(), instance);
    }

    protected VkAllocationFunction() {
        super(SIGNATURE);
    }

    private VkAllocationFunction(long functionPointer) {
        super(functionPointer);
    }

    private static final class Container extends VkAllocationFunction {

        private final VkAllocationFunctionI delegate;

        Container(long functionPointer, VkAllocationFunctionI delegate) {
            super(functionPointer);
            this.delegate = delegate;
        }

        @Override
        public long invoke(long pUserData, long size, long alignment, int allocationScope) {
            return delegate.invoke(pUserData, size, alignment, allocationScope);
        }

    }

}