org.lwjgl.vulkan.VkDebugReportCallbackEXT 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 org.lwjgl.system.*;

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

/**
 * Application-defined debug report callback function.
 * 
 * C Specification
 * 
 * The prototype for the callback function implemented by the application is:
 * 
 * typedef VkBool32 (VKAPI_PTR *PFN_vkDebugReportCallbackEXT)(
    VkDebugReportFlagsEXT                       flags,
    VkDebugReportObjectTypeEXT                  objectType,
    uint64_t                                    object,
    size_t                                      location,
    int32_t                                     messageCode,
    const char*                                 pLayerPrefix,
    const char*                                 pMessage,
    void*                                       pUserData);
 * 
 * Description
 * 
 * The callback returns a {@code VkBool32} that indicates to the calling layer if the Vulkan call should be aborted or not. Applications should always return {@link VK10#VK_FALSE FALSE} so that they see the same behavior with and without validation layers enabled.
 * 
 * If the application returns {@link VK10#VK_TRUE TRUE} from its callback and the Vulkan call being aborted returns a {@code VkResult}, the layer will return {@link EXTDebugReport#VK_ERROR_VALIDATION_FAILED_EXT ERROR_VALIDATION_FAILED_EXT}.
 * 
 * Note
 * 
 * The primary expected use of {@link EXTDebugReport#VK_ERROR_VALIDATION_FAILED_EXT ERROR_VALIDATION_FAILED_EXT} is for validation layer testing. It is not expected that an application would see this error code during normal use of the validation layers.
 * 
 * 
 * See Also
 * 
 * {@link VkDebugReportCallbackCreateInfoEXT}
 */
public abstract class VkDebugReportCallbackEXT extends Callback implements VkDebugReportCallbackEXTI {

	/** Creates a {@code VkDebugReportCallbackEXT} instance from the specified function pointer. */
	public static VkDebugReportCallbackEXT create(long functionPointer) {
		if ( functionPointer == NULL )
			return null;

		VkDebugReportCallbackEXTI instance = Callback.get(functionPointer);
		return instance instanceof VkDebugReportCallbackEXT
			? (VkDebugReportCallbackEXT)instance
			: new Container(functionPointer, instance);
	}

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

	protected VkDebugReportCallbackEXT() {
		super(SIGNATURE);
	}

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

	/**
	 * Converts the specified {@link VkDebugReportCallbackEXT} argument to a String.
	 *
	 * This method may only be used inside a {@code VkDebugReportCallbackEXT} invocation.
	 *
	 * @param string the argument to decode
	 *
	 * @return the message as a String
	 */
	public static String getString(long string) {
		return memUTF8(string);
	}

	private static final class Container extends VkDebugReportCallbackEXT {

		private final VkDebugReportCallbackEXTI delegate;

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

		@Override
		public int invoke(int flags, int objectType, long object, long location, int messageCode, long pLayerPrefix, long pMessage, long pUserData) {
			return delegate.invoke(flags, objectType, object, location, messageCode, pLayerPrefix, pMessage, pUserData);
		}

	}

}