Enum HdrMode

#[repr(i32)]
pub enum HdrMode {
    Off = 0,
    MultiExposureUnmerged = 1,
    MultiExposure = 2,
    SingleExposure = 3,
    Night = 4,
}

Set the mode to be used for High Dynamic Range (HDR) imaging.

HDR techniques typically include multiple exposure, image fusion and tone mapping techniques to improve the dynamic range of the resulting images.

When using an HDR mode, images are captured with different sets of AGC settings called HDR channels. Channels indicate in particular the type of exposure (short, medium or long) used to capture the raw image, before fusion. Each HDR image is tagged with the corresponding channel using the HdrChannel control.

\sa HdrChannel

Variants

Off = 0

HDR is disabled.

Metadata for this frame will not include the HdrChannel control.

MultiExposureUnmerged = 1

Multiple exposures will be generated in an alternating fashion.

The multiple exposures will not be merged together and will be returned to the application as they are. Each image will be tagged with the correct HDR channel, indicating what kind of exposure it is. The tag should be the same as in the HdrModeMultiExposure case.

The expectation is that an application using this mode would merge the frames to create HDR images for itself if it requires them.

MultiExposure = 2

Multiple exposures will be generated and merged to create HDR images.

Each image will be tagged with the HDR channel (long, medium or short) that arrived and which caused this image to be output.

Systems that use two channels for HDR will return images tagged alternately as the short and long channel. Systems that use three channels for HDR will cycle through the short, medium and long channel before repeating.

SingleExposure = 3

Multiple frames all at a single exposure will be used to create HDR images.

These images should be reported as all corresponding to the HDR short channel.

Night = 4

Multiple frames will be combined to produce “night mode” images.

It is up to the implementation exactly which HDR channels it uses, and the images will all be tagged accordingly with the correct HDR channel information.

Trait Implementations

impl Clone for HdrMode

fn clone(&self) -> HdrMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ControlEntry for HdrMode

const ID: u32 = 43u32

impl Debug for HdrMode

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

Formats the value using the given formatter.

impl From<HdrMode> for ControlValue

fn from(val: HdrMode) -> Self

Converts to this type from the input type.

impl From<HdrMode> for i32

fn from(enum_value: HdrMode) -> Self

Converts to this type from the input type.

impl PartialEq for HdrMode

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<ControlValue> for HdrMode

type Error = ControlValueError

The type returned in the event of a conversion error.

fn try_from(value: ControlValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i32> for HdrMode

type Error = TryFromPrimitiveError<HdrMode>

The type returned in the event of a conversion error.

fn try_from(number: i32) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.

impl TryFromPrimitive for HdrMode

const NAME: &'static str = "HdrMode"

type Primitive = i32

fn try_from_primitive( number: Self::Primitive, ) -> Result<Self, TryFromPrimitiveError<Self>>

impl Control for HdrMode

impl Copy for HdrMode

impl Eq for HdrMode

impl StructuralPartialEq for HdrMode