Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 191a8a9815631149211a94f0cdc8f64d > files > 128

libnjb-devel-2.2.7-1.fc14.i686.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libnjb: njb_eax_struct Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">libnjb&#160;<span id="projectnumber">2.2.7</span></div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">njb_eax_struct Struct Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="njb_eax_struct" -->
<p><code>#include &lt;<a class="el" href="libnjb_8h_source.html">libnjb.h</a>&gt;</code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u_int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__eax__struct.html#ac5e49d1efecf648a4e066d6a27e6b470">number</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__eax__struct.html#abdb3bc8dbe965974e31dfe8a60de6125">name</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u_int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__eax__struct.html#a52136d50f154229d9df24ea389478687">exclusive</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">u_int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__eax__struct.html#aa8c7d20648860165ae69bd6c4ab3a450">group</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="libnjb_8h.html#a31a8a9da84fa42ffdc7eed0cd2978192">njb_eax_control_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__eax__struct.html#a920778f9df1f740be70efca4340197f2">type</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__eax__struct.html#a4133ff6ae8d2d821fdda1a40e9e6c9b6">current_value</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__eax__struct.html#a1500b0227c7537a7644bb5a638257998">min_value</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__eax__struct.html#ae605e5c3487bef32a97186fae24e6b8e">max_value</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__eax__struct.html#a827b00e65663f69ac950247913fba496">option_names</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structnjb__eax__struct.html">njb_eax_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnjb__eax__struct.html#a533be0dfe083727c31caf49e2ef3d33e">next</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This is the EAX API type. </p>
<dl><dt><b>Examples: </b></dt><dd>
<p><a class="el" href="dumpeax_8c-example.html#_a2">dumpeax.c</a>.</p>
</dd>
</dl></div><hr/><h2>Field Documentation</h2>
<a class="anchor" id="a4133ff6ae8d2d821fdda1a40e9e6c9b6"></a><!-- doxytag: member="njb_eax_struct::current_value" ref="a4133ff6ae8d2d821fdda1a40e9e6c9b6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int16_t <a class="el" href="structnjb__eax__struct.html#a4133ff6ae8d2d821fdda1a40e9e6c9b6">njb_eax_struct::current_value</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The current value of this effect. Notice that this value may be negative! </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="dumpeax_8c-example.html#a15">dumpeax.c</a>.</dd>
</dl>
<p>Referenced by <a class="el" href="eax_8c.html#a618df2014818da5cdef1764186d825e6">eax_unpack()</a>, and <a class="el" href="eax_8c.html#a307b5211bd175a2c324b0c1180ea69fc">new_eax_type()</a>.</p>

</div>
</div>
<a class="anchor" id="a52136d50f154229d9df24ea389478687"></a><!-- doxytag: member="njb_eax_struct::exclusive" ref="a52136d50f154229d9df24ea389478687" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u_int8_t <a class="el" href="structnjb__eax__struct.html#a52136d50f154229d9df24ea389478687">njb_eax_struct::exclusive</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>0x00 = not exclusive, 0x01 = exclusive The "exclusive" attribute signifies if this effect can be used in parallell with other EAX effects, GUI:s shall make sure all other effects are reset to default values when one effect is chosen. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="dumpeax_8c-example.html#a13">dumpeax.c</a>.</dd>
</dl>
<p>Referenced by <a class="el" href="eax_8c.html#a307b5211bd175a2c324b0c1180ea69fc">new_eax_type()</a>.</p>

</div>
</div>
<a class="anchor" id="aa8c7d20648860165ae69bd6c4ab3a450"></a><!-- doxytag: member="njb_eax_struct::group" ref="aa8c7d20648860165ae69bd6c4ab3a450" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u_int8_t <a class="el" href="structnjb__eax__struct.html#aa8c7d20648860165ae69bd6c4ab3a450">njb_eax_struct::group</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The visual group for this effect - effects appearing after each other are grouped if their group numbers are identical </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="dumpeax_8c-example.html#a12">dumpeax.c</a>.</dd>
</dl>
<p>Referenced by <a class="el" href="eax_8c.html#a618df2014818da5cdef1764186d825e6">eax_unpack()</a>, and <a class="el" href="eax_8c.html#a307b5211bd175a2c324b0c1180ea69fc">new_eax_type()</a>.</p>

</div>
</div>
<a class="anchor" id="ae605e5c3487bef32a97186fae24e6b8e"></a><!-- doxytag: member="njb_eax_struct::max_value" ref="ae605e5c3487bef32a97186fae24e6b8e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int16_t <a class="el" href="structnjb__eax__struct.html#ae605e5c3487bef32a97186fae24e6b8e">njb_eax_struct::max_value</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The maximum value for this effect. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="dumpeax_8c-example.html#a16">dumpeax.c</a>.</dd>
</dl>
<p>Referenced by <a class="el" href="eax_8c.html#a68d4cf24e77a020af43da96e63159bfd">destroy_eax_type()</a>, <a class="el" href="eax_8c.html#a618df2014818da5cdef1764186d825e6">eax_unpack()</a>, and <a class="el" href="eax_8c.html#a307b5211bd175a2c324b0c1180ea69fc">new_eax_type()</a>.</p>

</div>
</div>
<a class="anchor" id="a1500b0227c7537a7644bb5a638257998"></a><!-- doxytag: member="njb_eax_struct::min_value" ref="a1500b0227c7537a7644bb5a638257998" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int16_t <a class="el" href="structnjb__eax__struct.html#a1500b0227c7537a7644bb5a638257998">njb_eax_struct::min_value</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The minumum value for this effect. Notice that this value may be negative! </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="dumpeax_8c-example.html#a17">dumpeax.c</a>.</dd>
</dl>
<p>Referenced by <a class="el" href="eax_8c.html#a68d4cf24e77a020af43da96e63159bfd">destroy_eax_type()</a>, <a class="el" href="eax_8c.html#a618df2014818da5cdef1764186d825e6">eax_unpack()</a>, and <a class="el" href="eax_8c.html#a307b5211bd175a2c324b0c1180ea69fc">new_eax_type()</a>.</p>

</div>
</div>
<a class="anchor" id="abdb3bc8dbe965974e31dfe8a60de6125"></a><!-- doxytag: member="njb_eax_struct::name" ref="abdb3bc8dbe965974e31dfe8a60de6125" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* <a class="el" href="structnjb__eax__struct.html#abdb3bc8dbe965974e31dfe8a60de6125">njb_eax_struct::name</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The name of this effect </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="dumpeax_8c-example.html#a11">dumpeax.c</a>.</dd>
</dl>
<p>Referenced by <a class="el" href="eax_8c.html#a68d4cf24e77a020af43da96e63159bfd">destroy_eax_type()</a>, <a class="el" href="eax_8c.html#a618df2014818da5cdef1764186d825e6">eax_unpack()</a>, and <a class="el" href="eax_8c.html#a307b5211bd175a2c324b0c1180ea69fc">new_eax_type()</a>.</p>

</div>
</div>
<a class="anchor" id="a533be0dfe083727c31caf49e2ef3d33e"></a><!-- doxytag: member="njb_eax_struct::next" ref="a533be0dfe083727c31caf49e2ef3d33e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structnjb__eax__struct.html">njb_eax_t</a>* <a class="el" href="structnjb__eax__struct.html#a533be0dfe083727c31caf49e2ef3d33e">njb_eax_struct::next</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Only to be used inside of libnjb </p>

<p>Referenced by <a class="el" href="eax_8c.html#a618df2014818da5cdef1764186d825e6">eax_unpack()</a>, <a class="el" href="eax_8c.html#a307b5211bd175a2c324b0c1180ea69fc">new_eax_type()</a>, and <a class="el" href="protocol_8c.html#ad9259496f4562d52937c0296d8a6812c">njb_get_nexteax()</a>.</p>

</div>
</div>
<a class="anchor" id="ac5e49d1efecf648a4e066d6a27e6b470"></a><!-- doxytag: member="njb_eax_struct::number" ref="ac5e49d1efecf648a4e066d6a27e6b470" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u_int16_t <a class="el" href="structnjb__eax__struct.html#ac5e49d1efecf648a4e066d6a27e6b470">njb_eax_struct::number</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The number of this effect </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="dumpeax_8c-example.html#a10">dumpeax.c</a>.</dd>
</dl>
<p>Referenced by <a class="el" href="eax_8c.html#a618df2014818da5cdef1764186d825e6">eax_unpack()</a>, and <a class="el" href="eax_8c.html#a307b5211bd175a2c324b0c1180ea69fc">new_eax_type()</a>.</p>

</div>
</div>
<a class="anchor" id="a827b00e65663f69ac950247913fba496"></a><!-- doxytag: member="njb_eax_struct::option_names" ref="a827b00e65663f69ac950247913fba496" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char** <a class="el" href="structnjb__eax__struct.html#a827b00e65663f69ac950247913fba496">njb_eax_struct::option_names</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Array with names for the selections, if this is a fixed option control. It may not be dereferenced for slider controls. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="dumpeax_8c-example.html#a18">dumpeax.c</a>.</dd>
</dl>
<p>Referenced by <a class="el" href="eax_8c.html#a68d4cf24e77a020af43da96e63159bfd">destroy_eax_type()</a>, <a class="el" href="eax_8c.html#a618df2014818da5cdef1764186d825e6">eax_unpack()</a>, and <a class="el" href="eax_8c.html#a307b5211bd175a2c324b0c1180ea69fc">new_eax_type()</a>.</p>

</div>
</div>
<a class="anchor" id="a920778f9df1f740be70efca4340197f2"></a><!-- doxytag: member="njb_eax_struct::type" ref="a920778f9df1f740be70efca4340197f2" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="libnjb_8h.html#a31a8a9da84fa42ffdc7eed0cd2978192">njb_eax_control_t</a> <a class="el" href="structnjb__eax__struct.html#a920778f9df1f740be70efca4340197f2">njb_eax_struct::type</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>NJB_EAX_NO_CONTROL, NJB_EAX_SLIDER_CONTROL, NJB_EAX_FIXED_OPTION_CONTROL</p>
<p>this replaces selectable, scalable with a single variable </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="dumpeax_8c-example.html#a14">dumpeax.c</a>.</dd>
</dl>
<p>Referenced by <a class="el" href="eax_8c.html#a68d4cf24e77a020af43da96e63159bfd">destroy_eax_type()</a>, <a class="el" href="eax_8c.html#a618df2014818da5cdef1764186d825e6">eax_unpack()</a>, and <a class="el" href="eax_8c.html#a307b5211bd175a2c324b0c1180ea69fc">new_eax_type()</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/builddir/build/BUILD/libnjb-2.2.7/src/<a class="el" href="libnjb_8h_source.html">libnjb.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sat Jun 25 2011 for libnjb by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>