pub struct Dimming { /* private fields */ }
Expand description
Display dimming.
The whole display is dimmed via PWM @ N/16 duty cycle; individual LEDs cannot be dimmed independently.
The value should be in the inclusive range BRIGHTNESS_MIN
to BRIGHTNESS_MAX
. Use the from_u8
helper to create a validated Dimming
value.
Implementations
sourceimpl Dimming
impl Dimming
sourcepub const BRIGHTNESS_MIN: Self = _
pub const BRIGHTNESS_MIN: Self = _
Minimum brightness @ 1/16 PWM duty cycle. (Same as BRIGHTNESS_1_16
)
sourcepub const BRIGHTNESS_1_16: Self = _
pub const BRIGHTNESS_1_16: Self = _
Brightness @ 1/16 PWM duty cycle.
sourcepub const BRIGHTNESS_2_16: Self = _
pub const BRIGHTNESS_2_16: Self = _
Brightness @ 2/16 PWM duty cycle.
sourcepub const BRIGHTNESS_3_16: Self = _
pub const BRIGHTNESS_3_16: Self = _
Brightness @ 3/16 PWM duty cycle.
sourcepub const BRIGHTNESS_4_16: Self = _
pub const BRIGHTNESS_4_16: Self = _
Brightness @ 4/16 PWM duty cycle.
sourcepub const BRIGHTNESS_5_16: Self = _
pub const BRIGHTNESS_5_16: Self = _
Brightness @ 5/16 PWM duty cycle.
sourcepub const BRIGHTNESS_6_16: Self = _
pub const BRIGHTNESS_6_16: Self = _
Brightness @ 6/16 PWM duty cycle.
sourcepub const BRIGHTNESS_7_16: Self = _
pub const BRIGHTNESS_7_16: Self = _
Brightness @ 7/16 PWM duty cycle.
sourcepub const BRIGHTNESS_8_16: Self = _
pub const BRIGHTNESS_8_16: Self = _
Brightness @ 8/16 PWM duty cycle.
sourcepub const BRIGHTNESS_9_16: Self = _
pub const BRIGHTNESS_9_16: Self = _
Brightness @ 9/16 PWM duty cycle.
sourcepub const BRIGHTNESS_10_16: Self = _
pub const BRIGHTNESS_10_16: Self = _
Brightness @ 10/16 PWM duty cycle.
sourcepub const BRIGHTNESS_11_16: Self = _
pub const BRIGHTNESS_11_16: Self = _
Brightness @ 11/16 PWM duty cycle.
sourcepub const BRIGHTNESS_12_16: Self = _
pub const BRIGHTNESS_12_16: Self = _
Brightness @ 12/16 PWM duty cycle.
sourcepub const BRIGHTNESS_13_16: Self = _
pub const BRIGHTNESS_13_16: Self = _
Brightness @ 13/16 PWM duty cycle.
sourcepub const BRIGHTNESS_14_16: Self = _
pub const BRIGHTNESS_14_16: Self = _
Brightness @ 14/16 PWM duty cycle.
sourcepub const BRIGHTNESS_15_16: Self = _
pub const BRIGHTNESS_15_16: Self = _
Brightness @ 15/16 PWM duty cycle.
sourcepub const BRIGHTNESS_16_16: Self = _
pub const BRIGHTNESS_16_16: Self = _
Brightness @ 16/16 PWM duty cycle.
sourcepub const BRIGHTNESS_MAX: Self = _
pub const BRIGHTNESS_MAX: Self = _
Maximum brightness @ 16/16 PWM duty cycle. (Same as BRIGHTNESS_16_16
)
This is the Power-on Reset default.
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> Self
pub const unsafe fn from_bits_unchecked(bits: u8) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
sourceimpl Dimming
impl Dimming
sourcepub fn from_u8(value: u8) -> Result<Self, ValidationError>
pub fn from_u8(value: u8) -> Result<Self, ValidationError>
Return a validated Dimming
value from the given u8
.
NOTE: The brightness values are 0-indexed, e.g. 0u8
is equivalent to 1/16
, and 15u8
is 16/16
.
Errors
The value is validated to be in the inclusive range BRIGHTNESS_MIN
to BRIGHTNESS_MAX
. If
the given u8
value is too large then ht16k33::ValidationError::ValueTooLarge
is returned.
Example
use ht16k33::Dimming;
let brightness = Dimming::from_u8(1u8)?;
assert_eq!(1u8, brightness.bits());
Error Example
use ht16k33::Dimming;
use ht16k33::ValidationError;
// Greater than the `BRIGHTNESS_MAX` value of `15u8`.
let value = 16u8;
let brightness = match Dimming::from_u8(value) {
Ok(brightness) => brightness,
Err(ValidationError) => panic!(),
};
Trait Implementations
sourceimpl BitAndAssign<Dimming> for Dimming
impl BitAndAssign<Dimming> for Dimming
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOrAssign<Dimming> for Dimming
impl BitOrAssign<Dimming> for Dimming
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXorAssign<Dimming> for Dimming
impl BitXorAssign<Dimming> for Dimming
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Extend<Dimming> for Dimming
impl Extend<Dimming> for Dimming
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)sourceimpl FromIterator<Dimming> for Dimming
impl FromIterator<Dimming> for Dimming
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
sourceimpl Ord for Dimming
impl Ord for Dimming
1.21.0 · sourcefn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
1.21.0 · sourcefn min(self, other: Self) -> Selfwhere
Self: Sized,
fn min(self, other: Self) -> Selfwhere
Self: Sized,
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,
sourceimpl PartialOrd<Dimming> for Dimming
impl PartialOrd<Dimming> for Dimming
sourcefn partial_cmp(&self, other: &Dimming) -> Option<Ordering>
fn partial_cmp(&self, other: &Dimming) -> Option<Ordering>
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresourceimpl SubAssign<Dimming> for Dimming
impl SubAssign<Dimming> for Dimming
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.