FSOUND_Sample_GetMinMaxDistance

##### [API function]

## FSOUND_Sample_GetMinMaxDistance

Get the minimum and maximum audible distance for a sample.

signed char F_API FSOUND_Sample_GetMinMaxDistance(
FSOUND_SAMPLE *sptr,
F_FLOAT_API *min,
F_FLOAT_API *max
);

### Parameters

sptr | The sample to get minimum and maximum audible distance information from.
min | Pointer to value to be filled with the minimum volume distance for the sample. See remarks for more on units.
max | Pointer to value to be filled with the maximum volume distance for the sample. See remarks for more on units.

### Return Value

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

### Remarks

A 'distance unit' is specified by FSOUND_3D_SetDistanceFactor. By default this is set to meters which is a distance scale of 1.0.
See FSOUND_3D_SetDistanceFactor for more on this.
The default units for minimum and maximum distances are 1.0 and 1000000000.0f.
Volume drops off at mindistance / distance.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

### See Also

FSOUND_3D_SetDistanceFactor , FSOUND_Sample_SetMinMaxDistance

This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Thu Dec 15 17:31:32 2005 by SourceDoc v0.10, the automated source code documenter.