[−][src]Struct mod_player::Song

pub struct Song {
    pub name: String,
    pub format: FormatDescription,
    pub samples: Vec<Sample>,
    pub patterns: Vec<Pattern>,
    pub pattern_table: Vec<u8>,
    pub num_used_patterns: u32,
    pub end_position: u32,
}

Contains the entire mod song

Fields

name: String

The name of the song as specified in the mod file

format: FormatDescription

Features of the song

samples: Vec<Sample>

The audio samples used by the song

patterns: Vec<Pattern>

Patterns contain all the note data

pattern_table: Vec<u8>

Specifies the order in whcih the patterns should be played in. The same pattern may played several times in the same song

num_used_patterns: u32

How many patterns in the pattern table should be used. The pattern table is a fixed length can usually longer than the song

end_position: u32

Which pattern should be played after the last pattern in the pattern_table. Used for infinitely looping repeating songs

Auto Trait Implementations

impl Send for Song

impl Sync for Song

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, [src]

impl<T> From for T[src]

impl<T, U> TryFrom for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized, [src]

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

impl<T> BorrowMut for T where
    T: ?Sized, [src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.