Enum azure_kinect::bindings::k4a_image_format_t

#[repr(u32)]pub enum k4a_image_format_t {
    K4A_IMAGE_FORMAT_COLOR_MJPG,
    K4A_IMAGE_FORMAT_COLOR_NV12,
    K4A_IMAGE_FORMAT_COLOR_YUY2,
    K4A_IMAGE_FORMAT_COLOR_BGRA32,
    K4A_IMAGE_FORMAT_DEPTH16,
    K4A_IMAGE_FORMAT_IR16,
    K4A_IMAGE_FORMAT_CUSTOM8,
    K4A_IMAGE_FORMAT_CUSTOM16,
    K4A_IMAGE_FORMAT_CUSTOM,
}

Image format type.

\remarks The image format indicates how the \ref k4a_image_t buffer data is interpreted.

\xmlonly k4atypes.h (include k4a/k4a.h) \endxmlonly

Variants

K4A_IMAGE_FORMAT_COLOR_MJPG

Color image type MJPG.

\details The buffer for each image is encoded as a JPEG and can be decoded by a JPEG decoder.

\details Because the image is compressed, the stride parameter for the \ref k4a_image_t is not applicable.

\details Each MJPG encoded image in a stream may be of differing size depending on the compression efficiency.

K4A_IMAGE_FORMAT_COLOR_NV12

Color image type NV12.

\details NV12 images separate the luminance and chroma data such that all the luminance is at the beginning of the buffer, and the chroma lines follow immediately after.

\details Stride indicates the length of each line in bytes and should be used to determine the start location of each line of the image in memory. Chroma has half as many lines of height and half the width in pixels of the luminance. Each chroma line has the same width in bytes as a luminance line.

K4A_IMAGE_FORMAT_COLOR_YUY2

Color image type YUY2.

\details YUY2 stores chroma and luminance data in interleaved pixels.

\details Stride indicates the length of each line in bytes and should be used to determine the start location of each line of the image in memory.

K4A_IMAGE_FORMAT_COLOR_BGRA32

Color image type BGRA32.

\details Each pixel of BGRA32 data is four bytes. The first three bytes represent Blue, Green, and Red data. The fourth byte is the alpha channel and is unused in the Azure Kinect APIs.

\details Stride indicates the length of each line in bytes and should be used to determine the start location of each line of the image in memory.

\details The Azure Kinect device does not natively capture in this format. Requesting images of this format requires additional computation in the API.

K4A_IMAGE_FORMAT_DEPTH16

Depth image type DEPTH16.

\details Each pixel of DEPTH16 data is two bytes of little endian unsigned depth data. The unit of the data is in millimeters from the origin of the camera.

\details Stride indicates the length of each line in bytes and should be used to determine the start location of each line of the image in memory.

K4A_IMAGE_FORMAT_IR16

Image type IR16.

\details Each pixel of IR16 data is two bytes of little endian unsigned depth data. The value of the data represents brightness.

\details This format represents infrared light and is captured by the depth camera.

\details Stride indicates the length of each line in bytes and should be used to determine the start location of each line of the image in memory.

K4A_IMAGE_FORMAT_CUSTOM8

Single channel image type CUSTOM8.

\details Each pixel of CUSTOM8 is a single channel one byte of unsigned data.

\details Stride indicates the length of each line in bytes and should be used to determine the start location of each line of the image in memory.

K4A_IMAGE_FORMAT_CUSTOM16

Single channel image type CUSTOM16.

\details Each pixel of CUSTOM16 is a single channel two bytes of little endian unsigned data.

\details Stride indicates the length of each line in bytes and should be used to determine the start location of each line of the image in memory.

K4A_IMAGE_FORMAT_CUSTOM

Custom image format.

\details Used in conjunction with user created images or images packing non-standard data.

\details See the originator of the custom formatted image for information on how to interpret the data.

Trait Implementations

impl Clone for k4a_image_format_t

fn clone(&self) -> k4a_image_format_t

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for k4a_image_format_t

impl Debug for k4a_image_format_t

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for k4a_image_format_t

impl Hash for k4a_image_format_t

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<k4a_image_format_t> for k4a_image_format_t

fn eq(&self, other: &k4a_image_format_t) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralEq for k4a_image_format_t

impl StructuralPartialEq for k4a_image_format_t