org.lwjgl.vulkan.VkDebugUtilsMessengerCallbackEXT 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 debug messenger callback function.
 * 
 * C Specification
 * 
 * The prototype for the {@link VkDebugUtilsMessengerCreateInfoEXT}{@code ::pfnUserCallback} function implemented by the application is:
 * 
 * 
 * typedef VkBool32 (VKAPI_PTR *PFN_vkDebugUtilsMessengerCallbackEXT)(
 *     VkDebugUtilsMessageSeverityFlagBitsEXT           messageSeverity,
 *     VkDebugUtilsMessageTypeFlagsEXT                  messageTypes,
 *     const VkDebugUtilsMessengerCallbackDataEXT*      pCallbackData,
 *     void*                                            pUserData);
 * 
 * Description
 * 
 * The callback returns a {@code VkBool32}, which is interpreted in a layer-specified manner. The application should always return {@link VK10#VK_FALSE FALSE}. The {@link VK10#VK_TRUE TRUE} value is reserved for use in layer development.
 * 
 * Valid Usage
 * 
 * 
 * The callback must not make calls to any Vulkan commands
 * 
 * 
 * See Also
 * 
 * {@link VkDebugUtilsMessengerCreateInfoEXT}
 */
public abstract class VkDebugUtilsMessengerCallbackEXT extends Callback implements VkDebugUtilsMessengerCallbackEXTI {

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

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

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

    protected VkDebugUtilsMessengerCallbackEXT() {
        super(CIF);
    }

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

    private static final class Container extends VkDebugUtilsMessengerCallbackEXT {

        private final VkDebugUtilsMessengerCallbackEXTI delegate;

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

        @Override
        public int invoke(int messageSeverity, int messageTypes, long pCallbackData, long pUserData) {
            return delegate.invoke(messageSeverity, messageTypes, pCallbackData, pUserData);
        }

    }

}