Struct nokhwa::CameraControl

pub struct CameraControl { /* fields omitted */ }

This struct tells you everything about a particular KnownCameraControls.
However, you should never need to instantiate this struct, since its usually generated for you by nokhwa. The only time you should be modifying this struct is when you need to set a value and pass it back to the camera.

Implementations

impl CameraControl

pub fn new(
    control: KnownCameraControls,
    minimum: i32,
    maximum: i32,
    value: i32,
    step: i32,
    default: i32,
    flag: KnownCameraControlFlag,
    active: bool
) -> Result<Self, NokhwaError>

Creates a new CameraControl

Errors

If the value is below min, above max, or is not divisible by step, this will error

pub fn control(&self) -> KnownCameraControls

Gets the KnownCameraControls of this CameraControl

pub fn minimum_value(&self) -> i32

Gets the minimum value of this CameraControl

pub fn maximum_value(&self) -> i32

Gets the maximum value of this CameraControl

pub fn value(&self) -> i32

Gets the current value of this CameraControl

pub fn set_value(&mut self, value: i32) -> Result<(), NokhwaError>

Sets the value of this CameraControl

Errors

If the value is below min, above max, or is not divisible by step, this will error

pub fn with_value(self, value: i32) -> Result<Self, NokhwaError>

Creates a new CameraControl but with value

Errors

If the value is below min, above max, or is not divisible by step, this will error

pub fn step(&self) -> i32

Gets the step value of this CameraControl Note that value must be divisible by step

pub fn default(&self) -> i32

Gets the default value of this CameraControl

pub fn flag(&self) -> KnownCameraControlFlag

Gets the KnownCameraControlFlag of this CameraControl, telling you weather this control is automatically set or manually set.

pub fn active(&self) -> bool

Gets active of this CameraControl, telling you weather this control is currently active(in-use).

pub fn valid_values(&self) -> Vec<i32>

Returns a list of i32s that are valid to be set.

Trait Implementations

impl Clone for CameraControl

fn clone(&self) -> CameraControl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CameraControl

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

Formats the value using the given formatter.

impl Hash for CameraControl

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 Ord for CameraControl

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<CameraControl> for CameraControl

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

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

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

This method tests for !=.

impl PartialOrd<CameraControl> for CameraControl

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for CameraControl

impl Eq for CameraControl

impl StructuralEq for CameraControl

impl StructuralPartialEq for CameraControl