Safe Haskell	None
Language	Haskell2010

Sound.MikMod.Types

Synopsis

Documentation

newtype Voice Source

MikMod distinguishes module channels from voices. Sound effects and music both work by playing samples on voices. At most one sample can play on a voice at a time. Operations on the voice level take a voice number which you can get using playerGetChannelVoice and samplePlay.

Constructors

Voice
Fields marshalVoice :: SBYTE

Instances

Eq Voice
Ord Voice
Show Voice

data MuteOperation Source

Inclusive or exclusive selection of channels for muting.

Constructors

MuteInclusive
MuteExclusive

Instances

Eq MuteOperation
Show MuteOperation

data CuriousFlag Source

When loading a module, Curious will cause the loader to attempt to load hidden tracks past the end of the song.

Constructors

Curious
NotCurious

Instances

Eq CuriousFlag
Show CuriousFlag

data Pan Source

Pan settings.

Constructors

Pan Int
PanSurround

Instances

Eq Pan
Show Pan

data MDriver Source

data MDriverInfo Source

Constructors

MDriverInfo
Fields mdriverName :: String mdriverHardVoiceLimit :: Int mdriverSoftVoiceLimit :: Int mdriverAlias :: String

Instances

Show MDriverInfo

data Module Source

type ModuleHandle = Ptr Module Source

Handle to a Module object which contains the music data and current playback state of a song.

data ModuleInfo Source

Static info about a module.

Constructors

ModuleInfo
Fields moduleSongname :: String moduleModType :: String moduleComment :: Maybe String moduleFlags :: [ModuleFlag] moduleNumChannels :: Int moduleNumVoices :: Int moduleNumPositions :: Int moduleNumPatterns :: Int moduleNumInstruments :: Int moduleNumSamples :: Int moduleInstruments :: Maybe [String]

Instances

Show ModuleInfo

data Sample Source

type SampleHandle = Ptr Sample Source

data SampleInfo Source

Static info about a sample.

Constructors

SampleInfo
Fields samplePanning :: Pan sampleSpeed :: Int sampleVolume :: Int sampleFlags :: [SampleFlag] sampleInflags :: [SampleFlag] sampleLength :: Int sampleLoopStart :: Int sampleLoopEnd :: Int

Instances

Show SampleInfo

data MReader Source

Collection of IO operations that MikMod can use to load data from an arbitrary source, such as a memory buffer or zip file.

Constructors

MReader

Fields

readerSeek :: Int -> SeekMode -> IO Int: Move the read position. Return 0 for success and -1 for failure.
readerTell :: IO Int: Report the current read position.
readerRead :: Ptr Word8 -> Int -> IO Bool: Write a number of bytes to the destination and advance the read position. Return True if an error occurred or False otherwise. EOF is not an error.
readerGet :: IO Int: Return one byte and advance the read position. If an error occurs or we are at the end-of-stream, then return eof.
readerEof :: IO Bool: Return True if we are at the end of the stream. Otherwise return False.

data Instrument Source