org.lwjgl.glfw.GLFWReallocateCallback Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lwjgl-glfw Show documentation

An multi-platform library for OpenGL, OpenGL ES and Vulkan development on the desktop. It provides a simple API for creating windows, contexts and surfaces, receiving input and events.

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.glfw;

import javax.annotation.*;

import org.lwjgl.system.*;

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

/**
 * The function pointer type for memory reallocation callbacks.
 * 
 * This is the function pointer type for memory reallocation callbacks. A memory reallocation callback function has the following signature:
 * 
 * 
 * void* function_name(void* block, size_t size, void* user)            
 * 
 * This function must return a memory block at least {@code size} bytes long, or {@code NULL} if allocation failed. Note that not all parts of GLFW handle
 * allocation failures gracefully yet.
 * 
 * This function may be called during {@link GLFW#glfwInit Init} but before the library is flagged as initialized, as well as during {@link GLFW#glfwTerminate Terminate} after the library is no
 * longer flagged as initialized.
 * 
 * Any memory allocated by this function will be deallocated during library termination or earlier.
 * 
 * The block address will never be {@code NULL} and the size will always be greater than zero. Reallocations of a block to size zero are converted into
 * deallocations. Reallocations of {@code NULL} to a non-zero size are converted into regular allocations.
 * 
 * Note
 * 
 * 
 * The returned memory block must be valid at least until it is deallocated.
 * This function should not call any GLFW function.
 * This function may be called from any thread that calls GLFW functions.
 * 
 * 
 * Type
 * 
 * 
 * void * (*{@link #invoke}) (
 *     void *block,
 *     size_t size,
 *     void *user
 * )
 *
 * @since version 3.4
 */
public abstract class GLFWReallocateCallback extends Callback implements GLFWReallocateCallbackI {

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

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

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

    protected GLFWReallocateCallback() {
        super(CIF);
    }

    GLFWReallocateCallback(long functionPointer) {
        super(functionPointer);
    }

    private static final class Container extends GLFWReallocateCallback {

        private final GLFWReallocateCallbackI delegate;

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

        @Override
        public long invoke(long block, long size, long user) {
            return delegate.invoke(block, size, user);
        }

    }

}