Package org.lwjgl.vulkan

Class VkDebugReportCallbackEXT

java.lang.Object

org.lwjgl.system.Callback

org.lwjgl.vulkan.VkDebugReportCallbackEXT

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.CallbackI, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer, VkDebugReportCallbackEXTI

public abstract class VkDebugReportCallbackEXT
extends org.lwjgl.system.Callback
implements VkDebugReportCallbackEXTI

Application-defined debug report callback function.

C Specification

The prototype for the VkDebugReportCallbackCreateInfoEXT::pfnCallback 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 must not call vkDestroyDebugReportCallbackEXT.

The callback returns a VkBool32, which is interpreted in a layer-specified manner. The application should always return FALSE. The TRUE value is reserved for use in layer development.

object must be a Vulkan object or NULL_HANDLE. If objectType is not DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT and object is not NULL_HANDLE, object must be a Vulkan object of the corresponding type associated with objectType as defined in VkDebugReportObjectTypeEXT and Vulkan Handle Relationship.

See Also

VkDebugReportCallbackCreateInfoEXT

Nested Class Summary

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

Fields inherited from interface org.lwjgl.vulkan.VkDebugReportCallbackEXTI

CIF

Method Summary

Modifier and Type	Method	Description
static VkDebugReportCallbackEXT	create(long functionPointer)	Creates a VkDebugReportCallbackEXT instance from the specified function pointer.
static VkDebugReportCallbackEXT	create(VkDebugReportCallbackEXTI instance)	Creates a VkDebugReportCallbackEXT instance that delegates to the specified VkDebugReportCallbackEXTI instance.
static @Nullable VkDebugReportCallbackEXT	createSafe(long functionPointer)	Like create, but returns null if functionPointer is NULL.
static String	getString(long string)	Converts the specified VkDebugReportCallbackEXT argument to a String.

Methods inherited from class org.lwjgl.system.Callback

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.CallbackI

address

Methods inherited from interface org.lwjgl.system.NativeResource

close

Methods inherited from interface org.lwjgl.vulkan.VkDebugReportCallbackEXTI

callback, getCallInterface, invoke

Method Details

create

public static VkDebugReportCallbackEXT create(long functionPointer)

Creates a VkDebugReportCallbackEXT instance from the specified function pointer.

Returns:

the new VkDebugReportCallbackEXT

createSafe

public static @Nullable VkDebugReportCallbackEXT createSafe(long functionPointer)

Like create, but returns null if functionPointer is NULL.

create

public static VkDebugReportCallbackEXT create(VkDebugReportCallbackEXTI instance)

Creates a VkDebugReportCallbackEXT instance that delegates to the specified VkDebugReportCallbackEXTI instance.

getString

public static String getString(long string)

Converts the specified VkDebugReportCallbackEXT argument to a String.

This method may only be used inside a VkDebugReportCallbackEXT invocation.

Parameters:

string - the argument to decode

Returns:

the message as a String