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><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/snd/Overview.html">snd</a>::<a href="../../../nw/snd/SoundHandle/Overview.html">SoundHandle</a>::SetBiquadFilter Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundHandle.h&gt;
14void SetBiquadFilter(
15     int type,
16     <span>f32</span> value
17);
18</pre>
19    </div>
20    <h2>Arguments</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26            <th>Name</th>
27            <td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31          <td>in</td>
32          <th>type</th>
33          <td>The filter type (0 - BIQUAD_FILTER_TYPE_USER_MAX).</td>
34        </tr>
35        <tr>
36          <td>in</td>
37          <th>value</th>
38          <td>How to apply the filter (0.0f - 1.0f).</td>
39        </tr> </table>
40    </div>
41    <h2>Return Values</h2>
42    <div class="section">
43                None.
44               </div>
45    <h2>Description</h2>
46    <div class="section">
47      <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) Set using a sound handle<br /> (2) Set using the sound player<br /> (3) Set using an ambient parameter data structure<br /> (4) Set using sequence data</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>
48    <h2>See Also</h2>
49    <div class="section">
50      <p class="reference"><a href="../../../nw/snd/BiquadFilterType.html">BiquadFilterType</a><br /> </p>
51    </div>
52    <h2>Revision History</h2>
53    <div class="section">
54      <dl class="history">
55        <dt>2010/10/15</dt>
56        <dd>Initial version.<br />
57        </dd>
58      </dl>
59    </div>
60  <hr><p>CONFIDENTIAL</p></body>
61</html>
62