2018-04-22 15:55:55 +00:00
< HTML >
< HEAD >
< META NAME = "GENERATOR" Content = "SOURCEDOC.EXE" >
< META HTTP-EQUIV = "Content-Type" content = "text/html; charset=iso-8859-1" >
< TITLE > FSOUND_Sample_SetMode< / TITLE >
< STYLE >
#flush {margin-left: -10p; margin-right: -0p}
#buttonbar {color: white}
< / STYLE >
< / HEAD >
< BODY TOPMARGIN = 0 BGPROPERTIES = "FIXED" BGCOLOR = "white" >
< FONT FACE = "ARIAL" >
< SPAN ID = "flush" >
< A NAME = "SEE ALSO" >
< TABLE WIDTH = "100%" COLS = 2 BORDER = 0 BGCOLOR = "#000000" >
< TR ALIGN = RIGHT >
< TD ALIGN = LEFT >
< IMG SRC = "banner03.gif" WIDTH = "88" HEIGHT = "31" BORDER = 0 >
< / TD >
< TD ALIGN = RIGHT VALIGN = TOP >
< FONT FACE = "ARIAL" SIZE = "2" >
< A ID = buttonbar HREF = "FSOUND_Sample_SetMinMaxDistance.html" >
< IMG SRC = "u_prev.gif" WIDTH = "71" HEIGHT = "16" BORDER = 0 ALT = "Previous Topic" >
< / A >
< A ID = buttonbar HREF = "FSOUND.html" >
< IMG SRC = "u_index.gif" WIDTH = "47" HEIGHT = "16" BORDER = 0 ALT = "Index" >
< / A >
< A ID = buttonbar HREF = "FSOUND_Sample_Unlock.html" >
< IMG SRC = "u_next.gif" WIDTH = "48" HEIGHT = "16" BORDER = 0 ALT = "Next Topic" >
< / A >
< / FONT > < / TD > < TD WIDTH = 15 > < / TD >
< / TR >
< / TABLE >
< / A >
< / SPAN >
< A HREF = "FSOUND.html#Functions" > < H5 > [API function]< / A > < / H5 >
< H2 > < A NAME = "FSOUND_Sample_SetMode" > FSOUND_Sample_SetMode< / A > < / H2 >
Sets a sample's mode. This can only be FSOUND_LOOP_OFF,FSOUND_LOOP_NORMAL, FSOUND_LOOP_BIDI or FSOUND_2D.< BR >
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.< BR >
< P >
< B > signed char F_API < / B > < B > < / B > < B > FSOUND_Sample_SetMode< / B > < B > (< / B > < BR >
< B > FSOUND_SAMPLE *< / B > < I > sptr< / I > < B > ,< / B > < BR >
< B > unsigned int < / B > < B > < / B > < I > mode< / I > < BR >
< B > );< / B > < BR >
< H3 > Parameters< / H3 >
< TABLE >
< TR VALIGN = top > < TD > < I > sptr< / I > < / TD >
< TD > Pointer to the sample to have the mode set.< BR >
< / TD > < TR VALIGN = top > < TD > < I > mode< / I > < / TD >
< TD > The mode bits to set from FSOUND_MODES.< BR >
< / TD > < / TABLE >
< H3 > Return Value< / H3 >
On success, TRUE is returned.< BR >
On failure, FALSE is returned.< BR >
< H3 > Remarks< / H3 >
Only the following modes are accepted, others will be filtered out. < BR >
FSOUND_LOOP_BIDI, FSOUND_LOOP_NORMAL, FSOUND_LOOP_OFF, FSOUND_2D.< BR >
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.< BR >
-------------------< BR >
On Playstation 2, XBox and GameCube, FSOUND_HW2D and FSOUND_HW3D are supported, so you can change between them at runtime.< BR >
-------------------< BR >
On Windows, samples created with FSOUND_HW3D or FSOUND_HW2D do not support FSOUND_LOOP_BIDI. This is a limitation of Direct X.< BR >
___________________< BR >
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube< BR >
< H3 > See Also< / H3 >
< A HREF = "FSOUND_GetLoopMode.html" > FSOUND_GetLoopMode< / A >
,
< A HREF = "FSOUND_MODES.html" > FSOUND_MODES< / A >
,
< A HREF = "FSOUND_Sample_GetLoopPoints.html" > FSOUND_Sample_GetLoopPoints< / A >
,
< A HREF = "FSOUND_Sample_GetMode.html" > FSOUND_Sample_GetMode< / A >
,
< A HREF = "FSOUND_Sample_SetDefaults.html" > FSOUND_Sample_SetDefaults< / A >
,
< A HREF = "FSOUND_Sample_SetLoopPoints.html" > FSOUND_Sample_SetLoopPoints< / A >
< HR > < BR > < FONT SIZE = "-2" > This document copyright © Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.< / FONT > < BR >
< FONT SIZE = "-2" > Generated Thu Dec 15 17:31:32 2005
by SourceDoc v0.10, the automated source code documenter.< / FONT > < BR >
< / BODY >
< / HTML >
