Skip to main content
← PSoXide SDK guides and examples · SDK f2fec1c301f1 · All Cargo features enabled; check feature gates before use.

Volume

Struct Volume 

Source
#[repr(transparent)]
pub struct Volume(pub i16);
Expand description

A 16-bit signed SPU voice/main volume.

Static voice/main volume uses -0x4000..=0x3FFF as its linear range. Positive magnitudes are the normal “louder” direction and a negative one inverts the phase. A value outside the range is limited to it when it is written to the register, so it never reaches the sweep-mode bit.

Tuple Fields§

§0: i16

Implementations§

Source§

impl Volume

Source

pub const SILENCE: Self

Silence.

Source

pub const MAX: Self

Maximum linear-positive volume (0x3FFF = +1.0).

Source

pub const HALF: Self

Half-scale convenience (0x2000 ≈ 0.5).

Source

pub const fn linear(num: u16, den: u16) -> Self

Build from a normalized float-ish 0.0..=1.0 value without actually using floats (since we’re no_std, no FPU). num and den are integer – Volume::linear(3, 4) is 0.75.

Trait Implementations§

Source§

impl Clone for Volume

Source§

fn clone(&self) -> Volume

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Volume

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Volume

Source§

fn default() -> Self

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

impl PartialEq for Volume

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for Volume

Source§

impl Eq for Volume

Source§

impl StructuralPartialEq for Volume

Auto Trait Implementations§

§

impl Freeze for Volume

§

impl RefUnwindSafe for Volume

§

impl Send for Volume

§

impl Sync for Volume

§

impl Unpin for Volume

§

impl UnsafeUnpin for Volume

§

impl UnwindSafe for Volume

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<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, 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.