MusFxBankGetPtrBank()

Syntax

void *MusFxBankGetPtrBank(void *ifxbank);

Arguments

ifxbank

the address of an initialized sound effect bank

Description

It gets the sample bank override associated with the specified initialized sound effect bank. If no sample bank override has been set for the specified sound effect bank, this function will return NULL.

The default sample bank is used when the MusStartEffect() or the MusStartEffect2() function is used to start sound effects, if no sample bank override has been defined. If a sample bank override has been specified with the MusFxBankSetPtrBank() function for the effect bank to which the triggering sound effect belongs, then the MusFxBankSetPtrBank() will be used, unless a higher priority override has been defined using the MusPtrBankSetSingle() function.

The ifxbank must contain the address of a sound effect bank initialized with the MusFxBankInitialize() function.

Return Value

Sample bank address or NULL.

Example

void GameFxBankSetDefault(void *fx_bank)
{
  void *ptr_bank;

  ptr_bank = MusFxBankGetPtrBank(fx_bank);
  MusPtrBankSetCurrent(ptr_bank);
}

See Also

MusFxBankInitialize(), MusFxBankNumberOfEffects(), MusFxBankGetCurrent(), MusFxBankSetCurrent(), MusFxBankSetPtrBank(), MusFxBankSetSingle()