Enum AeState

#[repr(i32)]
pub enum AeState {
    Idle = 0,
    Searching = 1,
    Converged = 2,
}

Report the AEGC algorithm state.

The AEGC algorithm computes the exposure time and the analogue gain to be applied to the image sensor.

The AEGC algorithm behaviour is controlled by the ExposureTimeMode and AnalogueGainMode controls, which allow applications to decide how the exposure time and gain are computed, in Auto or Manual mode, independently from one another.

The AeState control reports the AEGC algorithm state through a single value and describes it as a single computation block which computes both the exposure time and the analogue gain values.

When both the exposure time and analogue gain values are configured to be in Manual mode, the AEGC algorithm is quiescent and does not actively compute any value and the AeState control will report AeStateIdle.

When at least the exposure time or analogue gain are configured to be computed by the AEGC algorithm, the AeState control will report if the algorithm has converged to stable values for all of the controls set to be computed in Auto mode.

\sa AnalogueGainMode \sa ExposureTimeMode

Variants

Idle = 0

The AEGC algorithm is inactive.

This state is returned when both AnalogueGainMode and ExposureTimeMode are set to Manual and the algorithm is not actively computing any value.

Searching = 1

The AEGC algorithm is actively computing new values, for either the exposure time or the analogue gain, but has not converged to a stable result yet.

This state is returned if at least one of AnalogueGainMode or ExposureTimeMode is auto and the algorithm hasn’t converged yet.

The AEGC algorithm converges once stable values are computed for all of the controls set to be computed in Auto mode. Once the algorithm converges the state is moved to AeStateConverged.

Converged = 2

The AEGC algorithm has converged.

This state is returned if at least one of AnalogueGainMode or ExposureTimeMode is Auto, and the AEGC algorithm has converged to a stable value.

If the measurements move too far away from the convergence point then the AEGC algorithm might start adjusting again, in which case the state is moved to AeStateSearching.

Trait Implementations

impl Clone for AeState

fn clone(&self) -> AeState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ControlEntry for AeState

const ID: u32 = 2u32

impl Debug for AeState

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

Formats the value using the given formatter.

impl From<AeState> for ControlValue

fn from(val: AeState) -> Self

Converts to this type from the input type.

impl From<AeState> for i32

fn from(enum_value: AeState) -> Self

Converts to this type from the input type.

impl PartialEq for AeState

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

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 AeState

type Error = TryFromPrimitiveError<AeState>

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 AeState

const NAME: &'static str = "AeState"

type Primitive = i32

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

impl Control for AeState

impl Copy for AeState

impl Eq for AeState

impl StructuralPartialEq for AeState