k4a_image_get_format()

k4a_image_format_t k4a_image_get_format ( k4a_image_t  image_handle )

related

Get the format of the image.

Parameters

image_handle

Handle of the image for which the get operation is performed on.

Remarks

Use this function to determine the format of the image buffer.

Returns

This function is not expected to fail, all k4a_image_t's are created with a known format. If the image_handle is invalid, the function will return K4A_IMAGE_FORMAT_CUSTOM.