Enum azure_kinect::bindings::k4a_color_control_command_t

#[repr(u32)]pub enum k4a_color_control_command_t {
    K4A_COLOR_CONTROL_EXPOSURE_TIME_ABSOLUTE,
    K4A_COLOR_CONTROL_AUTO_EXPOSURE_PRIORITY,
    K4A_COLOR_CONTROL_BRIGHTNESS,
    K4A_COLOR_CONTROL_CONTRAST,
    K4A_COLOR_CONTROL_SATURATION,
    K4A_COLOR_CONTROL_SHARPNESS,
    K4A_COLOR_CONTROL_WHITEBALANCE,
    K4A_COLOR_CONTROL_BACKLIGHT_COMPENSATION,
    K4A_COLOR_CONTROL_GAIN,
    K4A_COLOR_CONTROL_POWERLINE_FREQUENCY,
}

Color sensor control commands

\remarks The current settings can be read with k4a_device_get_color_control(). The settings can be set with k4a_device_set_color_control().

\remarks Control values set on a device are reset only when the device is power cycled. The device will retain the settings even if the \ref k4a_device_t is closed or the application is restarted.

\see k4a_color_control_mode_t

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

Variants

K4A_COLOR_CONTROL_EXPOSURE_TIME_ABSOLUTE

Exposure time setting.

\details May be set to ::K4A_COLOR_CONTROL_MODE_AUTO or ::K4A_COLOR_CONTROL_MODE_MANUAL.

\details The Azure Kinect supports a limited number of fixed expsore settings. When setting this, expect the exposure to be rounded up to the nearest setting. Exceptions are 1) The last value in the table is the upper limit, so a value larger than this will be overridden to the largest entry in the table. 2) The exposure time cannot be larger than the equivelent FPS. So expect 100ms exposure time to be reduced to 30ms or 33.33ms when the camera is started. The most recent copy of the table 'device_exposure_mapping' is in https://github.com/microsoft/Azure-Kinect-Sensor-SDK/blob/develop/src/color/color_priv.h

\details Exposure time is measured in microseconds.

K4A_COLOR_CONTROL_AUTO_EXPOSURE_PRIORITY

Exposure or Framerate priority setting.

\details May only be set to ::K4A_COLOR_CONTROL_MODE_MANUAL.

\details Value of 0 means framerate priority. Value of 1 means exposure priority.

\details Using exposure priority may impact the framerate of both the color and depth cameras.

\details Deprecated starting in 1.2.0. Please discontinue usage, firmware does not support this.

K4A_COLOR_CONTROL_BRIGHTNESS

Brightness setting.

\details May only be set to ::K4A_COLOR_CONTROL_MODE_MANUAL.

\details The valid range is 0 to 255. The default value is 128.

K4A_COLOR_CONTROL_CONTRAST

Contrast setting.

\details May only be set to ::K4A_COLOR_CONTROL_MODE_MANUAL.

K4A_COLOR_CONTROL_SATURATION

Saturation setting.

\details May only be set to ::K4A_COLOR_CONTROL_MODE_MANUAL.

K4A_COLOR_CONTROL_SHARPNESS

Sharpness setting.

\details May only be set to ::K4A_COLOR_CONTROL_MODE_MANUAL.

K4A_COLOR_CONTROL_WHITEBALANCE

White balance setting.

\details May be set to ::K4A_COLOR_CONTROL_MODE_AUTO or ::K4A_COLOR_CONTROL_MODE_MANUAL.

\details The unit is degrees Kelvin. The setting must be set to a value evenly divisible by 10 degrees.

K4A_COLOR_CONTROL_BACKLIGHT_COMPENSATION

Backlight compensation setting.

\details May only be set to ::K4A_COLOR_CONTROL_MODE_MANUAL.

\details Value of 0 means backlight compensation is disabled. Value of 1 means backlight compensation is enabled.

K4A_COLOR_CONTROL_GAIN

Gain setting.

\details May only be set to ::K4A_COLOR_CONTROL_MODE_MANUAL.

K4A_COLOR_CONTROL_POWERLINE_FREQUENCY

Powerline frequency setting.

\details May only be set to ::K4A_COLOR_CONTROL_MODE_MANUAL.

\details Value of 1 sets the powerline compensation to 50 Hz. Value of 2 sets the powerline compensation to 60 Hz.

Trait Implementations

impl Clone for k4a_color_control_command_t

fn clone(&self) -> k4a_color_control_command_t

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for k4a_color_control_command_t

impl Debug for k4a_color_control_command_t

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

Formats the value using the given formatter.

impl Eq for k4a_color_control_command_t

impl Hash for k4a_color_control_command_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_color_control_command_t> for k4a_color_control_command_t

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

impl StructuralPartialEq for k4a_color_control_command_t