MusFxBankGetCurrent()

Syntax

void MusFxBankGetCurrent(void);

Arguments

None

Description

It gets the current default sound effect bank address. If no default sound effect bank address is set, this function will return NULL.

The default sound effect bank is used when the MusStartEffect() or the MusStartEffect2() function is used to start sound effects, if no sound effect bank override has been defined.

The MusFxBankSetSingle() function can be used to define a sound effect bank override for the next sound effect started.

Return Value

The sound effect bank address or NULL.

Example

void StackEffectBank(void *fx_addr)
{
  effect_bank_stack[stack_ptr++]=MusFxBankGetCurrent();
  MusFxBankSetCurrent(fx_addr);
}

void UnStackEffectBank(void)
{
  MusFxBankSetCurrent(effect_bank_stack[--stack_ptr]);
}

See Also

MusFxBankSetCurrent(), MusFxBankSetSingle(), MusStartEffect(), MusStartEffect2()