nw::snd::SoundActor::SetPitch Member Function

Syntax

#include <nw/snd/snd_SoundActor.h>
void SetPitch(
     f32 pitch
);

Arguments

Name Description
in pitch The frequency ratio of the pitch change.

Return Values

None.

Description

Changes the pitch of the actor.

The actor pitch affects all sounds that the actor is playing.

The value specified by this function operates independently of other low-pass filter cut-off parameters, which are all superimposed on top of each other.

pitch specifies the frequency ratio. In other words, there is no effect on the pitch if 1.0 will be specified. When 2.0 is specified, the frequency to be reproduced is doubled, and the pitch is one octave higher. If 0.5 is specified, the pitch will be one octave lower. The default value is 1.0.

See Also

GetPitch

Revision History

2010/02/23
Initial version.

CONFIDENTIAL