Codebase list frei0r / d9a8c6d doc / html / structf0r__param__info.html
d9a8c6d

Tree @d9a8c6d (Download .tar.gz)

structf0r__param__info.html @d9a8c6d — raw · history · blame 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>frei0r: f0r_param_info Struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li id="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="dirs.html"><span>Directories</span></a></li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
  </ul></div>
<h1>f0r_param_info Struct Reference</h1><!-- doxytag: class="f0r_param_info" --><code>#include &lt;<a class="el" href="frei0r_8h-source.html">frei0r.h</a>&gt;</code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__param__info.html#ff206a2bd55ec0a5f38f134a9bfa9a66">name</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__param__info.html#9cff757f4e45b1235e8977a83bd1f70a">type</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__param__info.html#234708bd246ba2f8aa94c6e556110cac">explanation</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Similar to f0r_plugin_info_t, this structure is filled by the plugin for every parameter.<p>
All strings are unicode, 0-terminated, and the encoding is utf-8. 
<p>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="234708bd246ba2f8aa94c6e556110cac"></a><!-- doxytag: member="f0r_param_info::explanation" ref="234708bd246ba2f8aa94c6e556110cac" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">const char* <a class="el" href="structf0r__param__info.html#234708bd246ba2f8aa94c6e556110cac">f0r_param_info::explanation</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Optional explanation (can be 0)     </td>
  </tr>
</table>
<a class="anchor" name="ff206a2bd55ec0a5f38f134a9bfa9a66"></a><!-- doxytag: member="f0r_param_info::name" ref="ff206a2bd55ec0a5f38f134a9bfa9a66" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">const char* <a class="el" href="structf0r__param__info.html#ff206a2bd55ec0a5f38f134a9bfa9a66">f0r_param_info::name</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The (short) name of the param     </td>
  </tr>
</table>
<a class="anchor" name="9cff757f4e45b1235e8977a83bd1f70a"></a><!-- doxytag: member="f0r_param_info::type" ref="9cff757f4e45b1235e8977a83bd1f70a" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">int <a class="el" href="structf0r__param__info.html#9cff757f4e45b1235e8977a83bd1f70a">f0r_param_info::type</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The type (see the F0R_PARAM_* defines)     </td>
  </tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>include/<a class="el" href="frei0r_8h-source.html">frei0r.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Wed Nov 7 12:07:53 2007 for frei0r by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>