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>AXARTInitLfo</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">AXARTInitLfo</H1>
14
15<H2>Syntax</H2>
16<dl><dd><pre class="construction">
17#include &lt;revolution.h&gt;
18#include &lt;revolution/axart.h&gt;
19
20void AXARTInitLfo(AXART_LFO *lfo, f32 *samples, u32 length, f32 delta);
21</pre></dd></dl>
22
23<H2>Arguments</H2>
24<TABLE class="arguments" border="1" >
25  <TBODY>
26    <TR>
27<TH>lfo</TH>
28<TD>Pointer to <CODE>AXART_LFO</CODE> to initialize.</TD>
29    </TR>
30    <TR>
31<TH>samples</TH>
32<TD>Pointer to first sample of LFO shape</TD>
33    </TR>
34    <TR>
35<TH>length</TH>
36<TD>Number of samples in the LFO shape</TD>
37    </TR>
38    <TR>
39<TH>delta</TH>
40<TD>Delta per audio frame.<BR><SPAN class="argument">delta</SPAN> = Hz * (length / 333)</TD>
41    </TR>
42  </TBODY>
43</TABLE>
44<P>The AXART library provides the following LFO shapes for use.</P>
45<TABLE class="arguments" border="1" >
46  <TBODY>
47    <TR>
48<TH>Shape</TH>
49<TH>*Samples</TH>
50<TH>Length</TH>
51    </TR>
52    <TR>
53<TD>Sine</TD>
54<TD><CODE>AXARTSine</CODE></TD>
55<TD><CODE>AXART_SINE_SAMPLES</CODE></TD>
56    </TR>
57    <TR>
58<TD>Square</TD>
59<TD><CODE>AXARTSquare</CODE></TD>
60<TD><CODE>AXART_SQUARE_SAMPLES</CODE></TD>
61    </TR>
62    <TR>
63<TD>Saw</TD>
64<TD><CODE>AXARTSaw</CODE></TD>
65<TD><CODE>AXART_SAW_SAMPLES</CODE></TD>
66    </TR>
67    <TR>
68<TD>Reverse Saw</TD>
69<TD><CODE>AXARTReverseSaw</CODE></TD>
70<TD><CODE>AXART_REVERSESAW_SAMPLES</CODE></TD>
71    </TR>
72    <TR>
73<TD>Triangle</TD>
74<TD><CODE>AXARTTriangle</CODE></TD>
75<TD><CODE>AXART_TRIANGLE_SAMPLES</CODE></TD>
76    </TR>
77    <TR>
78<TD>Noise</TD>
79<TD><CODE>AXARTNoise</CODE></TD>
80<TD><CODE>AXART_NOISE_SAMPLES</CODE></TD>
81    </TR>
82  </TBODY>
83</TABLE>
84
85<h2>Return Values</h2>
86<p>None.</p>
87
88<H2>Description</H2>
89<P>The <CODE>AXARTInitLfo</CODE> function initializes an <CODE>AXART_LFO</CODE> for use with articulators that contain an LFO for modulation.</P>
90
91<H2>See Also</H2>
92<P class="reference">
93<A href="AXART_LFO.html">AXART_LFO</A>
94</P>
95
96<h2>Revision History</h2>
97<P>
982006/11/28 Corrected the <SPAN class="argument">delta</SPAN> calculation formula to match the change in audio frame length (from 5 ms to 3 ms).<br>2006/03/01 Initial version.<BR>
99</P>
100
101<hr><p>CONFIDENTIAL</p></body>
102</HTML>
103