Mus Library Reference

MusPtrBankGetCurrent()

Get the default sample bank.

Syntax

  void *MusPtrBankGetCurrent(void);

Arguments
None

Explanation
Get the address of the 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.

Return Value
Sample bank address.

Example

  void StackSampleBank(void *sample_addr)
  {
    sample_bank_stack[stack_ptr++]=MusPtrBankGetCurrent();
    MusPtrBankSetCurrent(sample_addr);
  }

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

See Also
MusPtrBankInitialize()
MusPtrBankSetCurrent()
MusPtrBankSetSingle()

Nintendo® Confidential Warning: all information in this document is confidential and covered by a non-disclosure agreement. You are responsible for keeping this information confidential and protected. Nintendo will vigorously enforce this responsibility. Copyright © 1998-1999 Nintendo of America Inc. All rights reserved Nintendo and N64 are registered trademarks of Nintendo Last updated March 1999