Interface VkDebugReportCallbackEXTI
- 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.
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
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
callback
(long ret, long args) The Java method that will be called from native code when the native callback function is invoked.default FFICIF
Returns the libffi Call Interface for this callback function.int
invoke
(int flags, int objectType, long object, long location, int messageCode, long pLayerPrefix, long pMessage, long pUserData) Application-defined debug report callback function.
-
Field Details
-
CIF
-
-
Method Details
-
getCallInterface
Description copied from interface:CallbackI
Returns the libffi Call Interface for this callback function. [INTERNAL API]- Specified by:
getCallInterface
in interfaceCallbackI
- Returns:
- the CIF structure for this callback function
-
callback
default void callback(long ret, long args) Description copied from interface:CallbackI
The Java method that will be called from native code when the native callback function is invoked.- Specified by:
callback
in interfaceCallbackI
- Parameters:
ret
- 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(org.lwjgl.system.libffi.FFICIF, long, java.nio.ByteBuffer, org.lwjgl.PointerBuffer)
. That is, in most cases,ret
points to an object of exactly the size of the type specified whenCIF
was constructed. However, integral types narrower than the system register size are widened. In these cases your program may assume thatret
points to anffi_arg
object.args
- a vector of pointers to memory holding the arguments to the function
-
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 specifying 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.
-