Skip to main content

Panning

Struct Panning

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

Expand description

Sound panning (NR51): which channels reach each output.

Bit	Field	Access	Meaning
7	`ch4_left`	R/W	Channel 4 (noise) reaches the left output.
6	`ch3_left`	R/W	Channel 3 (wave) reaches the left output.
5	`ch2_left`	R/W	Channel 2 (pulse) reaches the left output.
4	`ch1_left`	R/W	Channel 1 (pulse) reaches the left output.
3	`ch4_right`	R/W	Channel 4 (noise) reaches the right output.
2	`ch3_right`	R/W	Channel 3 (wave) reaches the right output.
1	`ch2_right`	R/W	Channel 2 (pulse) reaches the right output.
0	`ch1_right`	R/W	Channel 1 (pulse) reaches the right output.

Implementations§

impl Panning

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 ch1_right(&self) -> bool

Channel 1 (pulse) reaches the right output.

Bits: 0..1

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

Channel 1 (pulse) reaches the right output.

Bits: 0..1

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

Channel 1 (pulse) reaches the right output.

Bits: 0..1

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

Channel 1 (pulse) reaches the right output.

Bits: 0..1

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

Channel 1 (pulse) reaches the right output.

Bits: 0..1

pub const fn ch2_right(&self) -> bool

Channel 2 (pulse) reaches the right output.

Bits: 1..2

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

Channel 2 (pulse) reaches the right output.

Bits: 1..2

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

Channel 2 (pulse) reaches the right output.

Bits: 1..2

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

Channel 2 (pulse) reaches the right output.

Bits: 1..2

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

Channel 2 (pulse) reaches the right output.

Bits: 1..2

pub const fn ch3_right(&self) -> bool

Channel 3 (wave) reaches the right output.

Bits: 2..3

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

Channel 3 (wave) reaches the right output.

Bits: 2..3

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

Channel 3 (wave) reaches the right output.

Bits: 2..3

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

Channel 3 (wave) reaches the right output.

Bits: 2..3

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

Channel 3 (wave) reaches the right output.

Bits: 2..3

pub const fn ch4_right(&self) -> bool

Channel 4 (noise) reaches the right output.

Bits: 3..4

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

Channel 4 (noise) reaches the right output.

Bits: 3..4

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

Channel 4 (noise) reaches the right output.

Bits: 3..4

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

Channel 4 (noise) reaches the right output.

Bits: 3..4

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

Channel 4 (noise) reaches the right output.

Bits: 3..4

pub const fn ch1_left(&self) -> bool

Channel 1 (pulse) reaches the left output.

Bits: 4..5

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

Channel 1 (pulse) reaches the left output.

Bits: 4..5

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

Channel 1 (pulse) reaches the left output.

Bits: 4..5

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

Channel 1 (pulse) reaches the left output.

Bits: 4..5

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

Channel 1 (pulse) reaches the left output.

Bits: 4..5

pub const fn ch2_left(&self) -> bool

Channel 2 (pulse) reaches the left output.

Bits: 5..6

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

Channel 2 (pulse) reaches the left output.

Bits: 5..6

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

Channel 2 (pulse) reaches the left output.

Bits: 5..6

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

Channel 2 (pulse) reaches the left output.

Bits: 5..6

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

Channel 2 (pulse) reaches the left output.

Bits: 5..6

pub const fn ch3_left(&self) -> bool

Channel 3 (wave) reaches the left output.

Bits: 6..7

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

Channel 3 (wave) reaches the left output.

Bits: 6..7

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

Channel 3 (wave) reaches the left output.

Bits: 6..7

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

Channel 3 (wave) reaches the left output.

Bits: 6..7

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

Channel 3 (wave) reaches the left output.

Bits: 6..7

pub const fn ch4_left(&self) -> bool

Channel 4 (noise) reaches the left output.

Bits: 7..8

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

Channel 4 (noise) reaches the left output.

Bits: 7..8

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

Channel 4 (noise) reaches the left output.

Bits: 7..8

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

Channel 4 (noise) reaches the left output.

Bits: 7..8

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

Channel 4 (noise) reaches the left output.

Bits: 7..8

Trait Implementations§

impl Clone for Panning

fn clone(&self) -> Panning

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Copy for Panning

impl Debug for Panning

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

Formats the value using the given formatter. Read more

impl Default for Panning

fn default() -> Self

Returns the “default value” for a type. Read more

impl Eq for Panning

impl From<Panning> for u8

fn from(v: Panning) -> Self

Converts to this type from the input type.

impl From<u8> for Panning

fn from(v: u8) -> Self

Converts to this type from the input type.

impl PartialEq for Panning

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl StructuralPartialEq for Panning

Auto Trait Implementations§

impl BankSafe for Panning

impl Freeze for Panning

impl RefUnwindSafe for Panning

impl Send for Panning

impl Sync for Panning

impl Unpin for Panning

impl UnsafeUnpin for Panning

impl UnwindSafe for Panning

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> CellValue for T
where T: Copy + BankSafe,

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.