1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7    <title>SetBiquadFilter</title>
8  </head>
9  <body>
10    <h1>nw::snd::SoundHandle::SetBiquadFilter Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundHandle.h&gt;
14
15void SetBiquadFilter(
16     int type,
17     <span>f32</span> value
18);
19</pre>
20    </div>
21    <h2>Arguments</h2>
22    <div class="section">
23      <table class="arguments">
24        <thead>
25          <tr>
26            <td width="15" />
27            <th>Name</th>
28            <td>Description</td>
29          </tr>
30        </thead>
31        <tr>
32          <td>in</td>
33          <th>type</th>
34          <td>The filter type (0 - BIQUAD_FILTER_TYPE_USER_MAX).</td>
35        </tr>
36        <tr>
37          <td>in</td>
38          <th>value</th>
39          <td>How to apply the filter (0.0f - 1.0f).</td>
40        </tr> </table>
41    </div>
42    <h2>Return Values</h2>
43    <div class="section">
44                None.
45               </div>
46    <h2>Description</h2>
47    <div class="section">
48      <p>Changes the biquad filter setting for sound.</p><p>Changes the biquad filter settings for the sound associated with the handle. If the handle is invalid, the function does nothing.</p><p>The biquad filter is set according to the priority given below rather than using overlapping settings for multiple locations. If parameter settings with higher priority have been made for a location, all settings for locations with lower priority are overwritten.</p><p>(1) Sound handle settings <br /> (2) Sound player settings <br /> (3) Ambient parameter structure settings <br /> (4) Sequence data settings</p><p>The filter type, &quot;type&quot; uses the <a href="../../../nw/snd/BiquadFilterType.html">BiquadFilterType</a> value. In addition to preset filter types, filters registered by the user can be selected.</p><p>Specify a value from 0 - BIQUAD_FILTER_TYPE_USER_MAX for type. See <a href="../../../nw/snd/BiquadFilterType.html">BiquadFilterType</a> regarding BIQUAD_FILTER_TYPE_USER_MAX. When a value that is out-of-range is set, operations stop with an assert for the Debug and Development versions. It is ignored in the Release version.</p><p>value, which specifies how to apply the filter, is specified by a value from 0.0f to 1.0f. The meaning of this value varies depending on the type of coefficient used by the filter.</p></div>
49    <h2>See Also</h2>
50    <div class="section">
51      <p class="reference"><a href="../../../nw/snd/BiquadFilterType.html">BiquadFilterType</a><br /> </p>
52    </div>
53    <h2>Revision History</h2>
54    <div class="section">
55      <dl class="history">
56        <dt>2010/10/15</dt>
57        <dd>Initial version.<br />
58        </dd>
59      </dl>
60    </div>
61  <hr><p>CONFIDENTIAL</p></body>
62</html>