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>SetFilter</title>
8  </head>
9  <body>
10    <h1><CODE><a href="../../../../../nn/Overview.html">nn</a>::<a href="../../../../../nn/gd/Overview.html">gd</a>::<a href="../../../../../nn/gd/CTR/Overview.html">CTR</a>::<a href="../../../../../nn/gd/CTR/System/Overview.html">System</a>::<a href="../../../../../nn/gd/CTR/System/Debug/Overview.html">Debug</a>::SetFilter</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14static <a href="../../../../../nnResult/Overview.html">nnResult</a> SetFilter(
15     <a href="../../../../../nn_types/u32.html">u32</a> filterFlag,
16     <a href="../../../../../nn_types/u32.html">u32</a> drawStartIndex,
17     <a href="../../../../../nn_types/s32.html">s32</a> drawCount
18);
19</pre>
20    </div>
21    <h2>Parameters</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>filterFlag</th>
34          <td>Specifies the status or effect to be changed.</td>
35        </tr>
36        <tr>
37          <td>in</td>
38          <th>drawStartIndex</th>
39          <td>Specifies the number of draw executions to put on standby before enabling the effect. If <CODE>0</CODE> is specified for <CODE>drawStartIndex</CODE>, the effect is enabled the next time a draw is executed.</td>
40        </tr>
41        <tr>
42          <td>in</td>
43          <th>drawCount</th>
44          <td>Specifies the number of draw executions for which to enable the effect.</td>
45        </tr> </table>
46    </div>
47    <h2>Return Values</h2>
48    <div class="section">Returns the result of the operation. <br />
49      <table class="arguments">
50        <thead>
51          <tr>
52            <th>Value</th>
53            <td>Description</td>
54          </tr>
55        </thead>
56        <tr>
57          <th><CODE>Result::IsSuccess</CODE></th>
58          <td>Process was successful.</td>
59        </tr>
60      </table> </div>
61    <h2>Description</h2>
62    <div class="section">
63      <p>Sets a filter capable of making several status changes upon the next draw. The <SPAN class="argument">filterFlag</SPAN> parameter can be specified by OR'ing <CODE>System::Filter</CODE> enum members.</p><p>This function can be used when the compile mode is debug or development. It does nothing in the case of release builds. This function has been designed so the user can test performance, state of the visual image, and feature effects. The state and features specified by the <SPAN class="argument">filterFlag</SPAN> parameter can be switched to, beginning after the drawing given by <SPAN class="argument">drawStartIndex</SPAN> for the number of drawings given by <SPAN class="argument">drawCount</SPAN>. The GD API automatically restores the user-defined state after the effect is no longer changed.</p><!-- write here --></div>
64    <h2>Revision History</h2>
65    <div class="section">
66      <dl class="history">
67        <dt>2011/12/27</dt>
68        <dd>Initial version.<br />
69        </dd>
70      </dl>
71    </div>
72  <hr><p>CONFIDENTIAL</p></body>
73</html>