1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
6<TITLE>AXFXChorusInit</TITLE>
7<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
8<META http-equiv="Content-Style-Type" content="text/css">
9</head>
10
11<BODY>
12
13<H1 align="left">AXFXChorusInit</H1>
14
15<H2>C Specification</H2>
16<BLOCKQUOTE>
17<PRE><CODE>#include &lt;revolution.h&gt;
18#include &lt;revolution/axfx.h&gt;
19
20BOOL AXFXChorusInit(AXFX_CHORUS *chorus);</CODE></PRE>
21</BLOCKQUOTE>
22
23<H2>Arguments</H2>
24<TABLE border="1" cellpadding="3" cellspacing="0.1">
25  <TBODY>
26    <TR>
27<TD width="120" bgcolor="#ffffe8"><EM><STRONG><code>chorus&nbsp;&nbsp; </code></STRONG></EM></TD>
28<TD width="520">Pointer to initialized instance of <code>AXFX_CHORUS</code>.</TD>
29    </TR>
30  </TBODY>
31</TABLE>
32
33<H2>Return Values</H2>
34<P><code>TRUE</code> if successful, <code>FALSE</code> if a parameter is out of bounds or memory allocation fails.</P>
35
36<H2>Description</H2>
37<P><code>AXFXChorusInit()</code> initializes the chorus effect using the specified <code>AXFX_CHORUS</code> effects data structure. The user must initialize the <code>AXFX_CHORUS</code> chorus settings prior to calling <code>AXFXChorusInit()</code>. This function will allocate memory for the reverb, and start the effect quietly.</P>
38
39<H2>See Also</H2>
40<P>
41<code><A href="AXFXChorusShutdown.html">AXFXChorusShutdown</A><br> <A href="AXFXChorusSettings.html">AXFXChorusSettings</A><br> <A href="AXFXChorusCallback.html">AXFXChorusCallback</A></code>
42</P>
43
44<H2>Revision History</H2>
45<P>03/01/2006 Initial version.</P>
46
47</BODY>
48</HTML>
49