Top Description Fields Methods
org.lwjgl.vulkan

public Interface VkDebugUtilsMessengerCallbackEXTI

extends CallbackI
Known Direct Implementers
org.lwjgl.vulkan.VkDebugUtilsMessengerCallbackEXT
Annotations
@FunctionalInterface
@NativeType:PFN_vkDebugUtilsMessengerCallbackEXT
Imports
org.lwjgl.system.*, org.lwjgl.system.libffi.*
Application-defined debug messenger callback function.
C Specification

The prototype for the VkDebugUtilsMessengerCreateInfoEXT::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 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.

Valid Usage
See Also

VkDebugUtilsMessengerCreateInfoEXT

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 VkDebugUtilsMessageSeverityFlagBitsEXT that triggered this callback.
messageSeverity, int
a bitmask of VkDebugUtilsMessageTypeFlagBitsEXT specifying which type of event(s) triggered this callback.
messageTypes, long
contains all the callback related data in the VkDebugUtilsMessengerCallbackDataEXT structure.
pCallbackData, long
the user data provided when the VkDebugUtilsMessengerEXT was created.
pUserData)

Application-defined debug messenger 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 messageSeverity, int messageTypes, long pCallbackData, long pUserData)

Application-defined debug messenger callback function.

Parameters
messageSeverity:int

specifies the VkDebugUtilsMessageSeverityFlagBitsEXT that triggered this callback.

messageTypes:int

a bitmask of VkDebugUtilsMessageTypeFlagBitsEXT specifying which type of event(s) triggered this callback.

pCallbackData:long

contains all the callback related data in the VkDebugUtilsMessengerCallbackDataEXT structure.

pUserData:long

the user data provided when the VkDebugUtilsMessengerEXT was created.

Annotations
@NativeType:VkBool32