Previous Topic Index Next Topic
[API function]

FSOUND_3D_Listener_SetRolloffFactor

Sets the global attenuation rolloff factor.
Normally volume for a sample will scale at 1 / distance. This gives a logarithmic
attenuation of volume as the source gets further away (or closer).
Setting this value makes the sound drop off faster or slower. The higher the value, the
faster volume will fall off. The lower the value, the slower it will fall off.
For example a rolloff factor of 1 will simulate the real world, where as a value of 2 will
make sounds attenuate 2 times quicker.

DLL_API void F_API FSOUND_3D_Listener_SetRolloffFactor(
F_FLOAT_API factor
);

Parameters

sptr The sample to have its rolloff factor set.
rolloff The rolloff factor to set for this sample. Valid ranges are 0 to 10.

Return Value

On success, TRUE is returned.
On failure, FALSE is returned.

Remarks

---------
A 'distance unit' is specified by FSOUND_3D_Listener_SetDistanceFactor. By default this is
set to meters which is a distance scale of 1.0. See FSOUND_3D_Listener_SetDistanceFactor
for more on this.
---------
The default rolloff factor is 1.0.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2

See Also

FSOUND_3D_Listener_SetAttributes , FSOUND_3D_Listener_SetDistanceFactor , FSOUND_3D_SetAttributes

This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Fri Aug 16 15:40:21 2002 by SourceDoc v0.10, the automated source code documenter.