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>AXART_VOLUME_MOD</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">AXART_VOLUME_MOD</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
20typedef struct
21{
22    AXART_ART   art;
23    AXART_LFO   lfo;
24
25    // runtime user parameters
26
27    s32         attenuation;
28
29} AXART_VOLUME_MOD;
30</pre></dd></dl>
31
32<h2>Elements</h2>
33<TABLE class="arguments" border="1" >
34  <TR>
35<TH>art</TH>
36<TD>AXART articulator descriptor maintained by AXART. Do not write to this parameter.</TD>
37  </TR>
38  <TR>
39<TH>lfo</TH>
40<TD>This is the LFO. See <a href="AXART_LFO.html"><CODE>AXART_LFO</CODE></a>.</TD>
41  </TR>
42  <TR>
43<TH>attenuation</TH>
44<TD>Volume attenuation for LFO at 1.0 (0x00010000 = 0.1dB).</TD>
45  </TR>
46</TABLE>
47
48<H2>Description</H2>
49<P><CODE>AXART_VOLUME_MOD</CODE> is a data structure used to denote a volume attenuation modulation sound articulator. This articulator will modulate the volume attenuation for an <CODE>AXART_SOUND</CODE> using an LFO. Before calling the <CODE>AXARTInitLfo</CODE> function for the <CODE>AXART_LFO</CODE> member, the user application must call the <CODE>AXARTInitArtVolumeMod</CODE> function for the <CODE>AXART_VOLUME_MOD</CODE>. (The user application must call the <CODE>AXARTInitArtVolumeMod</CODE> function before calling <CODE>AXARTAddArticulator</CODE> for the <CODE>AXART_VOLUME_MOD</CODE>.)</P>
50
51<H2>See Also</H2>
52<P class="reference">
53<A href="AXARTInitLfo.html">AXARTInitLfo</A>,
54<A href="AXARTInitArtVolumeMod.html">AXARTInitArtVolumeMod</A>,
55<A href="AXARTAddArticulator.html">AXARTAddArticulator</A>,
56<A href="AXART_LFO.html">AXART_LFO</A>,
57<A href="AXART_ART.html">AXART_ART</A>,
58<A href="AXART_SOUND.html">AXART_SOUND</A>
59</P>
60
61<H2>Revision History</H2>
62<P>
632007/10/03 Revised the link for <CODE>AXART_ART</CODE> in the Syntax section.<br>2006/03/01 Initial version.<BR>
64</P>
65
66<hr><p>CONFIDENTIAL</p></body>
67</HTML>
68