Top Description Fields Methods
org.lwjgl.vulkan

public Interface VkDebugReportCallbackEXTI

extends CallbackI
Known Direct Implementers
org.lwjgl.vulkan.VkDebugReportCallbackEXT
Annotations
@FunctionalInterface
@NativeType:PFN_vkDebugReportCallbackEXT
Imports
org.lwjgl.system.*, org.lwjgl.system.libffi.*
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

Field Summary

Modifier and TypeField and Description
public static final FFICIF
CIF

Method Summary

Modifier and TypeMethod and Description
public default void
callback(long
a pointer to the memory used for the function's return value.

If the function is declared as returning void, then this value is garbage and should not be used.

Otherwise, the callback must fill the object to which this points, following the same special promotion behavior as LibFFI#ffi_call. That is, in most cases, ret points to an object of exactly the size of the type specified when CIF was constructed. However, integral types narrower than the system register size are widened. In these cases your program may assume that ret points to an ffi_arg object.

ret, long
a vector of pointers to memory holding the arguments to the function
args)

Implements org.lwjgl.system.CallbackI.callback.

The Java method that will be called from native code when the native callback function is invoked.
public default FFICIF
getCallInterface()

Implements org.lwjgl.system.CallbackI.getCallInterface.

Returns the libffi Call Interface for this callback function.
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)

Application-defined debug report callback function.

Inherited from org.lwjgl.system.CallbackI:
address

Field Detail

CIFback to summary
public static final FFICIF CIF

Method Detail

callbackback to summary
public default void callback(long ret, long args)

Implements org.lwjgl.system.CallbackI.callback.

Doc from org.lwjgl.system.CallbackI.callback.

The Java method that will be called from native code when the native callback function is invoked.

Parameters
ret:long

a pointer to the memory used for the function's return value.

If the function is declared as returning void, then this value is garbage and should not be used.

Otherwise, the callback must fill the object to which this points, following the same special promotion behavior as LibFFI#ffi_call. That is, in most cases, ret points to an object of exactly the size of the type specified when CIF was constructed. However, integral types narrower than the system register size are widened. In these cases your program may assume that ret points to an ffi_arg object.

args:long

a vector of pointers to memory holding the arguments to the function

Annotations
@Override
getCallInterfaceback to summary
public default FFICIF getCallInterface()

Implements org.lwjgl.system.CallbackI.getCallInterface.

Doc from org.lwjgl.system.CallbackI.getCallInterface.

Returns the libffi Call Interface for this callback function. [INTERNAL API]

Returns:FFICIF

the CIF structure for this callback function

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

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
@NativeType:VkBool32