Maxmod
Loading...
Searching...
No Matches
Functions
maxmod_common.h File Reference

Global include of Maxmod for functions common to all platforms. More...

#include <mm_types.h>

Functions

mm_bool mmActive (void)
 Used to determine if a module is playing.
 
static mm_bool mmActiveSub (void)
 Check if a jingle is playing or not.
 
mm_sfxhand mmEffect (mm_word sample_ID)
 Plays a sound effect with default settings.
 
mm_bool mmEffectActive (mm_sfxhand handle)
 Indicates if a sound effect is active or not.
 
mm_word mmEffectCancel (mm_sfxhand handle)
 Stops a sound effect. The handle will be invalidated.
 
void mmEffectCancelAll (void)
 Stop all sound effects and reset the effect system.
 
mm_sfxhand mmEffectEx (mm_sound_effect *sound)
 Plays a sound effect with custom settings.
 
mm_word mmEffectPanning (mm_sfxhand handle, mm_byte panning)
 Changes the panning of a sound effect.
 
mm_word mmEffectRate (mm_sfxhand handle, mm_word rate)
 Changes the playback rate for a sound effect.
 
mm_word mmEffectRelease (mm_sfxhand handle)
 Marks a sound effect as unimportant.
 
mm_word mmEffectScaleRate (mm_sfxhand handle, mm_word factor)
 Scales the rate of the sound effect by a certain factor.
 
mm_word mmEffectVolume (mm_sfxhand handle, mm_word volume)
 Changes the volume of a sound effect.
 
mm_sword mmGetModuleIdByName (const char *name)
 Get the ID of the module with the provided name.
 
const char * mmGetModuleNameById (mm_sword id)
 Get the name of the module with the provided ID.
 
mm_word mmGetPosition (void)
 Get current pattern order being played.
 
mm_word mmGetPositionRow (void)
 Get current row being played.
 
mm_word mmGetPositionTick (void)
 Get current number of elapsed ticks in the row being played.
 
mm_sword mmGetSampleIdByName (const char *name)
 Get the ID of the sample with the provided name.
 
const char * mmGetSampleNameById (mm_sword id)
 Get the name of the sample with the provided ID.
 
static void mmJingle (mm_word module_ID)
 Plays a jingle.
 
mm_bool mmJingleActive (void)
 Check if a jingle is playing or not.
 
void mmJinglePause (void)
 Pauses playback of the active jingle.
 
void mmJingleResume (void)
 Resume jingle playback.
 
mm_word mmJingleStart (mm_word module_ID, mm_pmode mode)
 Plays a jingle.
 
void mmJingleStop (void)
 Stops playback of the active jingle.
 
void mmPause (void)
 Pauses playback of the active module.
 
void mmPlayMAS (uintptr_t address, mm_word mode, mm_word layer)
 Play individual MAS file from RAM.
 
void mmPlayModule (uintptr_t address, mm_word mode, mm_word layer)
 Play individual MAS file from RAM.
 
static void mmPosition (mm_word position)
 Set playback position.
 
void mmResume (void)
 Resume module playback.
 
void mmSetEffectsVolume (mm_word volume)
 Set master volume scale for effect playback.
 
void mmSetJinglePitch (mm_word pitch)
 Change the master pitch scale for jingle playback.
 
void mmSetJingleTempo (mm_word tempo)
 Change the master tempo for jingle playback.
 
void mmSetJingleVolume (mm_word volume)
 Use this function to change the master volume scale for jingle playback.
 
void mmSetModulePitch (mm_word pitch)
 Change the master pitch scale for module playback.
 
void mmSetModuleTempo (mm_word tempo)
 Change the master tempo for module playback.
 
void mmSetModuleVolume (mm_word volume)
 Use this function to change the master volume scale for module playback.
 
static void mmSetPosition (mm_word position)
 Set the current sequence [aka order-list] position for the active module.
 
void mmSetPositionEx (mm_word position, mm_word row)
 Set the current playback position.
 
mm_word mmStart (mm_word module_ID, mm_pmode mode)
 Begins playback of a module.
 
void mmStop (void)
 Stops playback of the active module.
 

Detailed Description

Global include of Maxmod for functions common to all platforms.