FSOUND_Sample_SetMode

##### [API function]

## FSOUND_Sample_SetMode

Sets a sample's mode. This can only be FSOUND_LOOP_OFF,FSOUND_LOOP_NORMAL, FSOUND_LOOP_BIDI or FSOUND_2D.
You cannot change the description of the contents of a sample or its location. FSOUND_2D will be ignored on the Win32 platform if FSOUND_HW3D was used to create the sample.

signed char F_API FSOUND_Sample_SetMode(
FSOUND_SAMPLE *sptr,
unsigned int mode
);

### Parameters

sptr | Pointer to the sample to have the mode set.
mode | The mode bits to set from FSOUND_MODES.

### Return Value

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

### Remarks

Only the following modes are accepted, others will be filtered out.
FSOUND_LOOP_BIDI, FSOUND_LOOP_NORMAL, FSOUND_LOOP_OFF, FSOUND_2D.
Normally FSOUND_2D is accepted only if the sound is software mixed. If this is not set, the mode is set for the sample to be 3D processed.
-------------------
On Playstation 2, XBox and GameCube, FSOUND_HW2D and FSOUND_HW3D are supported, so you can change between them at runtime.
-------------------
On Windows, samples created with FSOUND_HW3D or FSOUND_HW2D do not support FSOUND_LOOP_BIDI. This is a limitation of Direct X.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

### See Also

FSOUND_GetLoopMode , FSOUND_MODES , FSOUND_Sample_GetLoopPoints , FSOUND_Sample_GetMode , FSOUND_Sample_SetDefaults , FSOUND_Sample_SetLoopPoints

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.