nw::snd::SoundHandle::SetSurroundPan Member Function

#include <nw/snd/snd_SoundHandle.h>

void SetSurroundPan(
     float surroundPan
);

	Name	Description
in	surroundPan	Relative change in the surround pan, taking 0.0 as a reference point.

None.

Changes the surround pan (front-to-back location) of the sound.

Changes the surround 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 surround pan parameters, which are all layered.

surroundPan 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. If 1.0 is specified, a sound located in the center is relocated to the front. If 2.0 is specified, a sound located in the center is relocated to the back. Specify a negative number if you wish to move the location toward the front.

The default value is 0.0.

2010/08/10

Initial version.