MusPtrBankSetSingle()

Syntax

void MusPtrBankSetSingle(void *ipbank);

Arguments

ipbank

the address of an initialized sample pointer bank file

Description

It sets the address of the override sample bank. If the override is set to NULL, then it is disabled. The sample bank override is used then cleared when the MusStartSong() or MusStartSongFromMarker() functions are called.

The default sample bank is used when the MusStartSong() or the MusStartSongFromMarker() functions are used to start songs, if no sample bank override has been defined with the MusPtrBankSetSingle() function.

The default sample bank is used when the MusStartEffect() or the MusStartEffect2() function is used to start sound effects, if no sample bank override is defined. The MusFxBankSetSingle() function is used to specify the sound effect override for the sound effect that starts next.

The ipbank must be the address of a sample pointer bank file that has been initialized with the MusPtrBankInitialize() function.

Return Value

None

Example

void StartBankEffect(int effect, void *fx_bank, void *samp_bank)
{
  MusFxBankSetSingle(fx_bank);
  MusPtrBankSetSingle(sample_bank);
  MusStartEffect(effect);
}

See Also

MusPtrBankInitialize(), MusPtrBankSetCurrent(), MusPtrBankGetCurrent()