MusPtrBankSetCurrent()

Set the default sample bank.

Syntax

  void MusPtrBankSetCurrent(void *ipbank);

Arguments

• ipbank is the address of an initialized sample pointer bank file

Explanation
Set the address of the current default sample bank.

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. If a sample bank override has been specified with the MusFxBankSetPtrBank() function for the effect bank to which the triggering sound effect belongs, it will be used unless a higher priority override has been set with the MusPtrBankSetSingle() function.

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 StackSampleBank(void *sample_addr)
  {
    sample_bank_stack[stack_ptr++]=MusPtrBankGetCurrent();
    MusPtrBankSetCurrent(sample_addr);
  }

  void UnStackSampleBank(void)
  {
    MusPtrBankSetCurrent(sample_bank_stack[--stack_ptr]);
  }