openmpt::mod_command

Enum VolumeCommand

pub enum VolumeCommand {
Show 16 variants    None,
    Volume(u8),
    Panning(u8),
    VolSlideUp(u8),
    VolSlideDown(u8),
    FineVolUp(u8),
    FineVolDown(u8),
    VibratoSpeed(u8),
    VibratoDepth(u8),
    PanSlideLeft(u8),
    PanSlideRight(u8),
    TonePortamento(u8),
    PortaUp(u8),
    PortaDown(u8),
    DelayCut(u8),
    Offset(u8),
}

Expand description

An enum containing the different value for Volume commands.

Each variant contains its own volume parameter where applicable.

§Remarks

The documentation for each effect is there for reference purposes only and can be interpreted very differently depending on the format, internal parameters, tracker last used, whether sub-semitone variations use frequencies or periods, etc.

The libopenmpt developpers do not recommend relying on these, you have been warned.

Variants§

None

Volume(u8)

Panning(u8)

VolSlideUp(u8)

VolSlideDown(u8)

FineVolUp(u8)

FineVolDown(u8)

VibratoSpeed(u8)

VibratoDepth(u8)

PanSlideLeft(u8)

PanSlideRight(u8)

TonePortamento(u8)

PortaUp(u8)

PortaDown(u8)

DelayCut(u8)

Offset(u8)

Auto Trait Implementations§

impl Freeze for VolumeCommand

impl RefUnwindSafe for VolumeCommand

impl Send for VolumeCommand

impl Sync for VolumeCommand

impl Unpin for VolumeCommand

impl UnwindSafe for VolumeCommand

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