Callback Function prototypes

Typedefs
typedef void()	k4a_logging_message_cb_t(void *context, k4a_log_level_t level, const char *file, const int line, const char *message)
typedef void()	k4a_memory_destroy_cb_t(void *buffer, void *context)
typedef uint8_t *()	k4a_memory_allocate_cb_t(int size, void **context)

Detailed Description

Prototypes used in callbacks.

Typedef Documentation

k4a_logging_message_cb_t

typedef void() k4a_logging_message_cb_t(void *context, k4a_log_level_t level, const char *file, const int line, const char *message)

Callback function for debug messages being generated by the Azure Kinect SDK.

Parameters

context	The context of the callback function. This is the context that was supplied by the caller to k4a_set_debug_message_handler.
level	The level of the message that has been created.
file	The file name of the source file that generated the message.
line	The line number of the source file that generated the message.
message	The messaged generated by the Azure Kinect SDK.

Remarks

The callback is called asynchronously when the Azure Kinext SDK generates a message at a level that is equal to or more critical than the level specified when calling k4a_set_debug_message_handler() to register the callback.

This callback can occur from any thread and blocks the calling thread. The k4a_logging_message_cb_t function user must protect it's logging resources from concurrent calls. All care should be made to minimize the amount of time locks are held.

Definition at line 845 of file k4atypes.h.

k4a_memory_allocate_cb_t

typedef uint8_t *() k4a_memory_allocate_cb_t(int size, void **context)

Callback function for a memory allocation.

Parameters

size	Minimum size in bytes needed for the buffer.
context	Output parameter for a context that will be provided in the subsequent call to the k4a_memory_destroy_cb_t callback.

Returns

A pointer to the newly allocated memory.

Remarks

A callback of this type is provided when there is an application defined allocator.

Definition at line 895 of file k4atypes.h.

k4a_memory_destroy_cb_t

typedef void() k4a_memory_destroy_cb_t(void *buffer, void *context)

Callback function for a memory object being destroyed.

Parameters

buffer	The buffer pointer that was supplied by the caller as buffer_release_cb to k4a_image_create_from_buffer().
context	The context for the memory object that needs to be destroyed that was supplied by the caller as buffer_release_cb_context to k4a_image_create_from_buffer().

Remarks

When all references for the memory object are released, this callback will be invoked as the final destroy for the given memory.

Definition at line 871 of file k4atypes.h.