DemoGL::Reference::Functions::DEMOGL_SoundSystemSet3DFactors

DEMOGL_SoundSystemSet3DFactors

DEMOGL_SoundSystemSet3DFactors sets the factors that will affect all 3D sound calculations.

int
DEMOGL_SoundSystemSet3DFactors(
	const float fDistanceFactor, 
	const float fRollOffFactor, 
	const float fDopplerFactor
);
	
Parameters.
fDistanceFactor
Specifies the fraction of a meter to use as a unit in the distance calculations of the 3D sound logic. When fDistanceFactor is < 0.0, the current value is left untouched. General example values: 1.0 for 1 meter/unit. 0.9144 for 1 yard/unit or 0.3048 for 1 foot/unit.
fRollOffFactor
Specifies how fast sound quiets with the distance. When fRollOffFactor is < 0.0, the current value is left untouched. Minimum value for fRollOfffactor is 0.0, maximum is 10.0. General example values: 0.0 for no roll off, 1.0 for real world simulation, 2.0 for 2 times real world etc.
fDopplerFactor
Specifies the doppler factor. The doppler effect is the way a sound appears to change pitch when it is moving towards or away from you. The listener and sound velocity settings are used to calculate this effect, fDopplerFactor value can be used to lessen or exaggerate the effect. When fDopplerFactor is < 0.0, the current value is left untouched. Minimum value for fDopplerFactor is 0.0, maximum is 10.0. General example values: 0.0 for no doppler effect, 1.0 for real world simulation, 2.0 for 2 times real world etc.

Return values.
If the function succeeds, it returns SYS_OK.
If the function fails, it returns SYS_NOK.

Remarks.

Example.

Requirements.
DemoGL v1.3 (build 0112 or higher)

See also.

Last changed on 18-jan-2001

©1999-2001 Solutions Design