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>GetCoefficients</title>
8  </head>
9  <body>
10    <h1>nw::snd::BiquadFilterCallback::GetCoefficients Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14virtual void GetCoefficients(
15     int type,
16     <span>f32</span> value,
17     <a href="../../../nw/snd/BiquadFilterCallback/Coefficients.html">Coefficients</a> * coef
18) const = 0;
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 (BIQUAD_FILTER_TYPE_USER_MIN - 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>
41        <tr>
42          <td>out</td>
43          <th>coef</th>
44          <td>Structure to store the calculated filter coefficient.</td>
45        </tr> </table>
46    </div>
47    <h2>Return Values</h2>
48    <div class="section">
49                None.
50               </div>
51    <h2>Description</h2>
52    <div class="section">
53      <p>Returns the biquad filter coefficient.</p><p>The biquad filter coefficient in the <a href="../../../nw/snd/Overview.html">nw::snd</a> library is called at the required time. Classes that inherit <a href="../../../nw/snd/BiquadFilterCallback/Overview.html">BiquadFilterCallback</a> must implement filter coefficients in this function.</p><p>type is the type number when the callback class is registered with <a href="../../../nw/snd/SoundSystem/SetBiquadFilterCallback.html">SoundSystem::SetBiquadFilterCallback</a>. A value between BIQUAD_FILTER_TYPE_USER_MIN and BIQUAD_FILTER_TYPE_USER_MAX defined in <a href="../../../nw/snd/BiquadFilterType.html">BiquadFilterType</a> is entered.</p><p>value is a value between 0.0f and 1.0f indicated how to apply the filter. The filter coefficient corresponding to this value is implemented to be stored in coef.</p></div>
54    <h2>See Also</h2>
55    <div class="section">
56      <p class="reference"><a href="../../../nw/snd/SoundSystem/SetBiquadFilterCallback.html">SoundSystem::SetBiquadFilterCallback</a><br /><a href="../../../nw/snd/BiquadFilterType.html">BiquadFilterType</a><br /> </p>
57    </div>
58    <h2>Revision History</h2>
59    <div class="section">
60      <dl class="history">
61        <dt>2010/10/15</dt>
62        <dd>Initial version.<br />
63        </dd>
64      </dl>
65    </div>
66  <hr><p>CONFIDENTIAL</p></body>
67</html>