1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3
4<HEAD>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META http-equiv="Content-Style-Type" content="text/css">
7
8    <LINK rel="stylesheet" href="./css/revolution.css" type="text/css">
9
10    <TITLE>HBMFadeoutManualSound</TITLE>
11<style type="text/css" media="all">
12<!--
13@import url("css/hbm_common.css");
14-->
15</style>
16</HEAD>
17<BODY>
18
19
20<H1>HBMFadeoutManualSound</H1>
21
22<H2>Syntax</H2>
23<dl><dd><pre><code>
24#include &lt;revolution/hbm.h&gt;
25
26#define USE_FOR_MANUAL
27
28void HBMFadeoutManualSound( f32 gain );
29</code></pre></dd></dl>
30
31
32<H2>Arguments</H2>
33<TABLE border="1" >
34  <tr>
35    <TD valign="top" width="120" bgcolor="#ffffe8"><CODE><STRONG><EM>gain</EM></STRONG></CODE></TD>
36    <TD width="520">Sound effect volume (maximum = 1.0f, minimum = 0.0f).</TD>
37  </tr>
38</TABLE>
39
40<H2>Return Values</H2>
41<P>
42None.
43</P>
44
45<H2>Description</H2>
46<P>
47Performs a fadeout on the sound effect played in the HOME Menu when a manual is displayed by the application. During fadeout, call this function, decreasing the value passed as <I><B><CODE>gain</CODE></B></I> from 1.0f to 0.0f over a 300 ms period.
48</P>
49<P>Enable the <CODE>USE_FOR_MANUAL</CODE> definition, and link <CODE>homebuttonLib.vcmv.a</CODE> or <CODE>homebuttonMiniLib.vcmv.a</CODE>.</P>
50<H2>See Also</H2>
51<p>
52<code><A href="hbm_HBMPlayManualSound.html">HBMPlayManualSound</A></code>, <code><A href="hbm_HBMUpdateManualSound.html">HBMUpdateManualSound</A></code>
53</P>
54
55<H2>Revision History</H2>
56<DL class="history">
57    <DT>2007/10/26<DD>Revised the header explanation.
58    <DT>2006/11/11<DD>Added information about <CODE>USE_FOR_MANUAL</CODE>.
59    <DT>2006/10/19<DD>Initial version.
60</DL>
61
62<hr><p>CONFIDENTIAL</p></body>
63</HTML>