nw::snd::SoundSystem::ClearEffect Member Function

#include <nw/snd/snd_SoundSystem.h>

static void ClearEffect(
     AuxBus bus,
     int fadeTimes = 0
);

	Name	Description
in	bus	The effect bus.
in	fadeTimes	Fade-out time (in milliseconds).

None.

Deletes from the bus all effects registered to the specified AUX bus.

A fade-out can be applied when closing the effect using fadeTimes. The effect will not close until the fade-out completes. To find out whether the fade-out has completed, call nw::snd::SoundSystem::IsFinishedClearEffect.

nw::snd::FxBase::Finalize is called internally when deleting an effect from the bus.

IsFinishedClearEffect
AuxBus
FxBase

2010/06/16

Initial version.