Enum azure_kinect::bindings::k4a_depth_mode_t

#[repr(u32)]pub enum k4a_depth_mode_t {
    K4A_DEPTH_MODE_OFF,
    K4A_DEPTH_MODE_NFOV_2X2BINNED,
    K4A_DEPTH_MODE_NFOV_UNBINNED,
    K4A_DEPTH_MODE_WFOV_2X2BINNED,
    K4A_DEPTH_MODE_WFOV_UNBINNED,
    K4A_DEPTH_MODE_PASSIVE_IR,
}

Depth sensor capture modes.

\remarks See the hardware specification for additional details on the field of view, and supported frame rates for each mode.

\remarks NFOV and WFOV denote Narrow and Wide Field Of View configurations.

\remarks Binned modes reduce the captured camera resolution by combining adjacent sensor pixels into a bin.

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

Variants

K4A_DEPTH_MODE_OFF

< Depth sensor will be turned off with this setting.

K4A_DEPTH_MODE_NFOV_2X2BINNED

< Depth captured at 320x288. Passive IR is also captured at 320x288.

K4A_DEPTH_MODE_NFOV_UNBINNED

< Depth captured at 640x576. Passive IR is also captured at 640x576.

K4A_DEPTH_MODE_WFOV_2X2BINNED

< Depth captured at 512x512. Passive IR is also captured at 512x512.

K4A_DEPTH_MODE_WFOV_UNBINNED

< Depth captured at 1024x1024. Passive IR is also captured at 1024x1024.

K4A_DEPTH_MODE_PASSIVE_IR

< Passive IR only, captured at 1024x1024.

Implementations

impl k4a_depth_mode_t

pub fn get_dimension(&self) -> Dimension

Gets the dimensions of the depth images that the depth camera will produce for a given depth mode

pub fn get_range(&self) -> Range<u16>

Gets the range of values that we expect to see from the depth camera when using a given depth mode, in millimeters

pub fn get_ir_level(&self) -> Range<u16>

Gets the expected min/max IR brightness levels that we expect to see from the IR camera when using a given depth mode

Trait Implementations

impl Clone for k4a_depth_mode_t

fn clone(&self) -> k4a_depth_mode_t

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for k4a_depth_mode_t

impl Debug for k4a_depth_mode_t

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

Formats the value using the given formatter.

impl Eq for k4a_depth_mode_t

impl Hash for k4a_depth_mode_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_depth_mode_t> for k4a_depth_mode_t

fn eq(&self, other: &k4a_depth_mode_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_depth_mode_t

impl StructuralPartialEq for k4a_depth_mode_t