Struct Envelope 

pub struct Envelope(/* private fields */);

Volume and envelope (NR12 / NR22 / NR42).

Bit	Field	Access	Meaning
7-4	volume	R/W	Initial volume.
3	increase	R/W	Direction: set raises volume over time, clear lowers it.
2-0	pace	R/W	A step every pace 64 Hz ticks; 0 disables the envelope.

Implementations

impl Envelope

pub const fn new() -> Self

Creates a new default initialized bitfield.

pub const fn from_bits(bits: u8) -> Self

Convert from bits.

pub const fn into_bits(self) -> u8

Convert into bits.

pub const fn pace(&self) -> u8

Envelope pace: a step every pace 64 Hz ticks (0 disables the envelope).

Bits: 0..3

pub const fn with_pace_checked(self, value: u8) -> Result<Self, ()>

Envelope pace: a step every pace 64 Hz ticks (0 disables the envelope).

Bits: 0..3

pub const fn with_pace(self, value: u8) -> Self

Envelope pace: a step every pace 64 Hz ticks (0 disables the envelope).

Bits: 0..3

pub const fn set_pace(&mut self, value: u8)

Envelope pace: a step every pace 64 Hz ticks (0 disables the envelope).

Bits: 0..3

pub const fn set_pace_checked(&mut self, value: u8) -> Result<(), ()>

Envelope pace: a step every pace 64 Hz ticks (0 disables the envelope).

Bits: 0..3

pub const fn increase(&self) -> bool

Direction: true increases volume over time, false decreases.

Bits: 3..4

pub const fn with_increase_checked(self, value: bool) -> Result<Self, ()>

Direction: true increases volume over time, false decreases.

Bits: 3..4

pub const fn with_increase(self, value: bool) -> Self

Direction: true increases volume over time, false decreases.

Bits: 3..4

pub const fn set_increase(&mut self, value: bool)

Direction: true increases volume over time, false decreases.

Bits: 3..4

pub const fn set_increase_checked(&mut self, value: bool) -> Result<(), ()>

Direction: true increases volume over time, false decreases.

Bits: 3..4

pub const fn volume(&self) -> u8

Initial volume.

Bits: 4..8

pub const fn with_volume_checked(self, value: u8) -> Result<Self, ()>

Initial volume.

Bits: 4..8

pub const fn with_volume(self, value: u8) -> Self

Initial volume.

Bits: 4..8

pub const fn set_volume(&mut self, value: u8)

Initial volume.

Bits: 4..8

pub const fn set_volume_checked(&mut self, value: u8) -> Result<(), ()>

Initial volume.

Bits: 4..8

Trait Implementations

impl Clone for Envelope

fn clone(&self) -> Envelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Envelope

impl Debug for Envelope

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

Formats the value using the given formatter.

impl Default for Envelope

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Envelope

impl From<Envelope> for u8

fn from(v: Envelope) -> Self

Converts to this type from the input type.

impl From<u8> for Envelope

fn from(v: u8) -> Self

Converts to this type from the input type.

impl PartialEq for Envelope

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Envelope