Top Description Inners Constructors Methods
org.lwjgl.vulkan

public abstract Class VkDebugReportCallbackEXT

extends Callback
implements VkDebugReportCallbackEXTI
Class Inheritance
All Implemented Interfaces
org.lwjgl.vulkan.VkDebugReportCallbackEXTI, org.lwjgl.system.CallbackI, org.lwjgl.system.Pointer
Known Direct Subclasses
org.lwjgl.vulkan.VkDebugReportCallbackEXT.Container
Imports
javax.annotation.*, org.lwjgl.system.*

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 and Inner Type Summary

Modifier and TypeClass and Description
private static class

Constructor Summary

AccessConstructor and Description
protected
pack-priv
VkDebugReportCallbackEXT(long functionPointer)

Method Summary

Modifier and TypeMethod and Description
public static VkDebugReportCallbackEXT

Returns:

the new VkDebugReportCallbackEXT
create
(long functionPointer)

Creates a VkDebugReportCallbackEXT instance from the specified function pointer.

public static VkDebugReportCallbackEXT
create(VkDebugReportCallbackEXTI instance)

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

public static VkDebugReportCallbackEXT
createSafe(long functionPointer)

Like create, but returns null if functionPointer is NULL.

public static String

Returns:

the message as a String
getString
(long
the argument to decode
string
)

Converts the specified VkDebugReportCallbackEXT argument to a String.

Inherited from org.lwjgl.system.Callback:
addressequalsfreefreegetgetSafehashCodetoString

Constructor Detail

VkDebugReportCallbackEXTback to summary
protected VkDebugReportCallbackEXT()
VkDebugReportCallbackEXTback to summary
pack-priv VkDebugReportCallbackEXT(long functionPointer)

Method Detail

createback to summary
public static VkDebugReportCallbackEXT create(long functionPointer)

Creates a VkDebugReportCallbackEXT instance from the specified function pointer.

Returns:VkDebugReportCallbackEXT

the new VkDebugReportCallbackEXT

createback to summary
public static VkDebugReportCallbackEXT create(VkDebugReportCallbackEXTI instance)

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

createSafeback to summary
public static VkDebugReportCallbackEXT createSafe(long functionPointer)

Like create, but returns null if functionPointer is NULL.

Annotations
@Nullable
getStringback to summary
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:long

the argument to decode

Returns:String

the message as a String

org.lwjgl.vulkan back to summary

private final Class VkDebugReportCallbackEXT.Container

extends VkDebugReportCallbackEXT
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final VkDebugReportCallbackEXTI

Constructor Summary

AccessConstructor and Description
pack-priv
Container(long functionPointer, VkDebugReportCallbackEXTI delegate)

Method Summary

Modifier and TypeMethod and Description
public int
invoke(int
specifies the VkDebugReportFlagBitsEXT that triggered this callback.
flags
,
int
a VkDebugReportObjectTypeEXT value specifying the type of object being used or created at the time the event was triggered.
objectType
,
long
the object where the issue was detected. If objectType is DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, object is undefined.
object
,
long
a component (layer, driver, loader) defined value specifying the location of the trigger. This is an optional value.
location
,
int
a layer-defined value indicating what test triggered this callback.
messageCode
,
long
a null-terminated string that is an abbreviation of the name of the component making the callback. pLayerPrefix is only valid for the duration of the callback.
pLayerPrefix
,
long
a null-terminated string detailing the trigger conditions. pMessage is only valid for the duration of the callback.
pMessage
,
long
the user data given when the VkDebugReportCallbackEXT was created.
pUserData
)

Implements org.lwjgl.vulkan.VkDebugReportCallbackEXTI.invoke.

Application-defined debug report callback function.
Inherited from org.lwjgl.vulkan.VkDebugReportCallbackEXT:
createcreatecreateSafegetString

Field Detail

delegateback to summary
private final VkDebugReportCallbackEXTI delegate

Constructor Detail

Containerback to summary
pack-priv Container(long functionPointer, VkDebugReportCallbackEXTI delegate)

Method Detail

invokeback to summary
public int invoke(int flags, int objectType, long object, long location, int messageCode, long pLayerPrefix, long pMessage, long pUserData)

Implements org.lwjgl.vulkan.VkDebugReportCallbackEXTI.invoke.

Doc from org.lwjgl.vulkan.VkDebugReportCallbackEXTI.invoke.

Application-defined debug report callback function.

Parameters
flags:int

specifies the VkDebugReportFlagBitsEXT that triggered this callback.

objectType:int

a VkDebugReportObjectTypeEXT value specifying the type of object being used or created at the time the event was triggered.

object:long

the object where the issue was detected. If objectType is DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, object is undefined.

location:long

a component (layer, driver, loader) defined value specifying the location of the trigger. This is an optional value.

messageCode:int

a layer-defined value indicating what test triggered this callback.

pLayerPrefix:long

a null-terminated string that is an abbreviation of the name of the component making the callback. pLayerPrefix is only valid for the duration of the callback.

pMessage:long

a null-terminated string detailing the trigger conditions. pMessage is only valid for the duration of the callback.

pUserData:long

the user data given when the VkDebugReportCallbackEXT was created.

Annotations
@Override