nw::snd::SoundSystem::AppendEffect Member Function

Syntax

#include <nw/snd/snd_SoundSystem.h>
static bool AppendEffect(
     AuxBus bus,
     FxBase* effect
);

Arguments

Name Description
in bus Bus to add the effect to.
in effect The effect.

Return Values

Returns TRUE if the effect starts successfully; otherwise, returns FALSE.

Description

Adds the specified effect to the AUX bus.

Effects are processed independently for each specified bus. For nw::snd effects (effects inheriting nn::snd::FxBase), multiple effects can be registered to a single bus. The effects are processed in the order in which they are added.

To change the order in which effects were connected midway through processing, first call nw::snd::SoundSystem::ClearEffect and delete all registered effects. Then, add the effects again in the desired order.

nw::snd::FxBase::Initialize is called internally when the effects are added.

For an overview of effects processing, see the description for the SoundSystem class.

See Also

AuxBus
FxBase
ClearEffect

Revision History

2010/10/22
Added ClearEffect to See Also, and made minor adjustments
2010/06/16
Initial version.

CONFIDENTIAL