pub type k4a_image_t = *mut _k4a_image_t;Expand description
\class k4a_image_t k4a.h <k4a/k4a.h> Handle to an Azure Kinect image.
\remarks A \ref k4a_image_t manages an image buffer and associated metadata.
\remarks The memory associated with the image buffer in an \ref k4a_image_t may have been allocated by the Azure Kinect APIs or by the application. If the \ref k4a_image_t was created by an Azure Kinect API, its memory will be freed when all references to the \ref k4a_image_t are released. All images retrieved directly from a device will have been created by the API. An application can create a \ref k4a_image_t using memory that it has allocated using k4a_image_create_from_buffer(). In that case the memory is not freed when the references are released but instead the application is provided with a callback. Applications need to create a k4a_image_t to provide as an output to the k4a_transformation_t transformation functions.
\remarks An image has a number of metadata properties that can be set or retrieved using the accessor functions. Not all properties are applicable to images of all types. See the documentation for the individual accessors for more information on their applicability and meaning.
\remarks Images may be of one of the standard \ref k4a_image_format_t formats, or may be of format ::K4A_IMAGE_FORMAT_CUSTOM. The format defines how the underlying image buffer should be interpreted.
\remarks Images from a device are retrieved through a \ref k4a_capture_t object returned by k4a_device_get_capture().
\remarks Images stored in a k4a_capture_t are referenced by the k4a_capture_t until they are replaced or the k4a_capture_t is destroyed.
\remarks The caller must call k4a_image_release() to release its reference to any \ref k4a_image_t that it receives from an Azure Kinect API.
\remarks Additional references to the image may be obtained with k4a_image_reference().
\remarks An invalid k4a_image_t will be set to 0.
\see k4a_capture_t
\xmlonly