Package org.lwjgl.vulkan
Interface VkDebugReportCallbackEXTI
-
- All Superinterfaces:
org.lwjgl.system.CallbackI
,org.lwjgl.system.CallbackI.I
,org.lwjgl.system.Pointer
- All Known Implementing Classes:
VkDebugReportCallbackEXT
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface VkDebugReportCallbackEXTI extends org.lwjgl.system.CallbackI.I
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 returnFALSE
. TheTRUE
value is reserved for use in layer development.object
must be a Vulkan object orNULL_HANDLE
. IfobjectType
is notDEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT
andobject
is notNULL_HANDLE
,object
must be a Vulkan object of the corresponding type associated withobjectType
as defined inVkDebugReportObjectTypeEXT
and Vulkan Handle Relationship.See Also
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.lwjgl.system.CallbackI
org.lwjgl.system.CallbackI.B, org.lwjgl.system.CallbackI.D, org.lwjgl.system.CallbackI.F, org.lwjgl.system.CallbackI.I, org.lwjgl.system.CallbackI.J, org.lwjgl.system.CallbackI.N, org.lwjgl.system.CallbackI.P, org.lwjgl.system.CallbackI.S, org.lwjgl.system.CallbackI.V, org.lwjgl.system.CallbackI.Z
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
SIGNATURE
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default int
callback(long args)
default java.lang.String
getSignature()
int
invoke(int flags, int objectType, long object, long location, int messageCode, long pLayerPrefix, long pMessage, long pUserData)
Application-defined debug report callback function.
-
-
-
Method Detail
-
getSignature
default java.lang.String getSignature()
- Specified by:
getSignature
in interfaceorg.lwjgl.system.CallbackI
-
callback
default int callback(long args)
- Specified by:
callback
in interfaceorg.lwjgl.system.CallbackI.I
-
invoke
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
- specifies theVkDebugReportFlagBitsEXT
that triggered this callback.objectType
- aVkDebugReportObjectTypeEXT
value specifying the type of object being used or created at the time the event was triggered.object
- the object where the issue was detected. IfobjectType
isDEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT
,object
is undefined.location
- a component (layer, driver, loader) defined value that specifies the location of the trigger. This is an optional: value.messageCode
- a layer-defined value indicating what test triggered this callback.pLayerPrefix
- 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
- a null-terminated string detailing the trigger conditions.pMessage
is only valid for the duration of the callback.pUserData
- the user data given when theVkDebugReportCallbackEXT
was created.
-
-