mirror of
https://github.com/ENSL/NS.git
synced 2024-11-30 08:20:56 +00:00
97 lines
4.1 KiB
HTML
97 lines
4.1 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<META NAME="GENERATOR" Content="SOURCEDOC.EXE">
|
|
<META HTTP-EQUIV="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<TITLE>FSOUND_FX_Enable</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_FX_Disable.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_FX_SetChorus.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_FX_Enable">FSOUND_FX_Enable</A></H2>
|
|
Enables effect processing for the specified channel. This command continues to add effects to a channel (up to 16) until FSOUND_FX_Disable is called.<BR>
|
|
<P>
|
|
<B>int F_API </B><B> </B><B>FSOUND_FX_Enable</B><B>(</B><BR>
|
|
<B>int </B><B> </B><I>channel</I><B>,</B><BR>
|
|
<B>unsigned int </B><B> </B><I>fxtype</I><BR>
|
|
<B>);</B><BR>
|
|
<H3>Parameters</H3>
|
|
<TABLE>
|
|
<TR VALIGN=top><TD><I>channel</I></TD>
|
|
<TD>Channel number/handle to enable fx for.<BR>
|
|
</TD><TR VALIGN=top><TD><I>fx</I></TD>
|
|
<TD>A single fx enum value to enable certain effects. <BR>
|
|
</TD></TABLE>
|
|
<H3>Return Value</H3>
|
|
On success, an FX id is returned.<BR>
|
|
On failure, -1 is returned.<BR>
|
|
<H3>Remarks</H3>
|
|
FSOUND_ALL is supported. Passing this will enable fx on ALL channels available.<BR>
|
|
This command can only be issued while the channel is paused.<BR>
|
|
If an effect is not enabled, then it will not be affected by its corresponding FSOUND_FX_Set functions.<BR>
|
|
This function must be played after a paused PlaySoundEx (ie FSOUND_PlaySoundEx(FSOUND_FREE, sound, NULL, TRUE)), and before<BR>
|
|
the FSOUND_SetPaused(FALSE) so that the hardware can get the resource before it starts playing.<BR>
|
|
A total of 16 FX per channel is allowed, any more will result in an error. FX are reset to 0 after a sound is stopped or played. (but as above, before the unpausing of a play-paused sound).<BR>
|
|
Warning : This function is expensive to call as it has to set up fx buffers etc. It is best to call it once, reserve the channel then reuse the channel index when calling playsound without calling it again.<BR>
|
|
Note : Under DirectX 8, channels with FX enabled sounds cannot have their frequency changed. DirectX 9 and above do not have this limitation.<BR>
|
|
___________________<BR>
|
|
Supported on the following platforms : Win32<BR>
|
|
<H3>See Also</H3>
|
|
<A HREF="FSOUND_FX_Disable.html">FSOUND_FX_Disable</A>
|
|
,
|
|
<A HREF="FSOUND_FX_MODES.html">FSOUND_FX_MODES</A>
|
|
,
|
|
<A HREF="FSOUND_FX_SetChorus.html">FSOUND_FX_SetChorus</A>
|
|
,
|
|
<A HREF="FSOUND_FX_SetCompressor.html">FSOUND_FX_SetCompressor</A>
|
|
,
|
|
<A HREF="FSOUND_FX_SetDistortion.html">FSOUND_FX_SetDistortion</A>
|
|
,
|
|
<A HREF="FSOUND_FX_SetEcho.html">FSOUND_FX_SetEcho</A>
|
|
,
|
|
<A HREF="FSOUND_FX_SetFlanger.html">FSOUND_FX_SetFlanger</A>
|
|
,
|
|
<A HREF="FSOUND_FX_SetGargle.html">FSOUND_FX_SetGargle</A>
|
|
,
|
|
<A HREF="FSOUND_FX_SetI3DL2Reverb.html">FSOUND_FX_SetI3DL2Reverb</A>
|
|
,
|
|
<A HREF="FSOUND_FX_SetParamEQ.html">FSOUND_FX_SetParamEQ</A>
|
|
,
|
|
<A HREF="FSOUND_FX_SetWavesReverb.html">FSOUND_FX_SetWavesReverb</A>
|
|
,
|
|
<A HREF="FSOUND_PlaySound.html">FSOUND_PlaySound</A>
|
|
,
|
|
<A HREF="FSOUND_PlaySoundEx.html">FSOUND_PlaySoundEx</A>
|
|
,
|
|
<A HREF="FSOUND_SetPaused.html">FSOUND_SetPaused</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:29 2005
|
|
by SourceDoc v0.10, the automated source code documenter.</FONT><BR>
|
|
</BODY>
|
|
</HTML>
|