nw::snd::StreamSoundHandle::SetPan Member Function

Syntax

#include <nw/snd/snd_StreamSoundHandle.h>

void SetPan(
     f32 pan
);

Arguments

Name Description
in pan Relative change in the pan with 0.0 as the base value.

Return Values

None.

Description

Changes the pan (right/left location) of the sound.

Changes the pan of the sound associated with the handle. If the handle is invalid, the function does nothing.

The value specified by this function operates independently of other pan parameters, which are all layered.

pan specifies a value representing the relative change in the location of the sound. If 0.0 is specified, the pan value set within data is unchanged. When 1.0 is specified, a sound located at the center will be located at the far right, and when -1.0 is specified, a sound that located at the center will be located at the far left. The default value is 0.0.

Revision History

2010/01/22
Initial version.

CONFIDENTIAL