Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 89de7b48d4fd156f0af7b4735abd1453 > files > 47

libtiger-doc-0.3.4-1.fc14.noarch.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>libtiger: /builddir/build/BUILD/libtiger-0.3.4/include/tiger/tiger.h File 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.3 -->
<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">libtiger&#160;<span id="projectnumber">0.3.4</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="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</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="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<h1>/builddir/build/BUILD/libtiger-0.3.4/include/tiger/tiger.h File Reference</h1>  </div>
</div>
<div class="contents">
<div class="textblock"><code>#include &lt;stddef.h&gt;</code><br/>
<code>#include &lt;kate/kate.h&gt;</code><br/>
<code>#include &quot;tiger/tiger_config.h&quot;</code><br/>
</div>
<p><a href="tiger_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">API version</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tiger_8h.html#a887c74f78bb61e39dcf7b2fcad37c6f3">TIGER_VERSION_MAJOR</a>&#160;&#160;&#160;0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tiger_8h.html#ae3732e558740635b4b7d87714720c51d">TIGER_VERSION_MINOR</a>&#160;&#160;&#160;3</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tiger_8h.html#a4149cd1b4032c98915a40b43aa1bcad9">TIGER_VERSION_PATCH</a>&#160;&#160;&#160;4</td></tr>
<tr><td colspan="2"><div class="groupHeader">Error codes</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tiger_8h.html#abe0984eb0dc353431a986f2454a15aa7">TIGER_E_NOT_FOUND</a>&#160;&#160;&#160;(-1001)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tiger_8h.html#a85a64b84aeaedaf40eadb7f93c9e81ec">TIGER_E_INVALID_PARAMETER</a>&#160;&#160;&#160;(-1002)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tiger_8h.html#a6edd3fbbfcb508e5bc21211bedeb4467">TIGER_E_OUT_OF_MEMORY</a>&#160;&#160;&#160;(-1003)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tiger_8h.html#aad38b2d266bbfcc1dae6c1ea8b45984a">TIGER_E_CAIRO_ERROR</a>&#160;&#160;&#160;(-1004)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tiger_8h.html#a88a14ffc00753edd5af7aef8d9566eaa">TIGER_E_BAD_SURFACE_TYPE</a>&#160;&#160;&#160;(-1005)</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#ga11c041e2f1f0482fde918964eb40cafb">tiger_get_version</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#ga999f2a211c9f176f59ebd1097f170baf">tiger_get_version_string</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__renderer.html#ga27e03677cff75565a7723e1711c498aa">tiger_renderer_create</a> (tiger_renderer **tr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__renderer.html#ga616dfb49c1ea8b4dd44a204e702a51c9">tiger_renderer_set_buffer</a> (tiger_renderer *tr, unsigned char *ptr, int width, int height, int stride, int swap_rgb)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__renderer.html#ga04ee034ba17a605f11801b66205c5ed3">tiger_renderer_set_surface_clear_color</a> (tiger_renderer *tr, int clear, double r, double g, double b, double a)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__renderer.html#ga3a565f4c34b6e125167642a9ead21844">tiger_renderer_set_quality</a> (tiger_renderer *tr, double quality)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__renderer.html#ga3a83f6b639322dbd99dd63ef03820716">tiger_renderer_add_event</a> (tiger_renderer *tr, const kate_info *ki, const kate_event *ev)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__renderer.html#gae15f847d25ce9c1b48ef29ecc75fcb60">tiger_renderer_update</a> (tiger_renderer *tr, kate_float t, int track)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__renderer.html#ga4d0ddb1fe2af844fa424e0a80456fe8c">tiger_renderer_seek</a> (tiger_renderer *tr, kate_float target)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__renderer.html#gab402a7397960e91f82bd7c91c2983435">tiger_renderer_render</a> (tiger_renderer *tr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__renderer.html#ga0f2963d8b49870418a58bfc0d3e7ee06">tiger_renderer_destroy</a> (tiger_renderer *tr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__renderer.html#gaaf7c376dde566e84284036f0c5bb3b6b">tiger_renderer_is_dirty</a> (const tiger_renderer *tr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__renderer.html#gab0003d4d02cfde916fa8bcad6d7ed92f">tiger_renderer_enable_caching</a> (tiger_renderer *tr, int enable)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__renderer.html#gae011b62c293eb03168ff8e1a71c6f889">tiger_renderer_set_default_font_description</a> (tiger_renderer *tr, const char *desc)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__renderer.html#gae587ee65bc447762de2356fc16b6dacd">tiger_renderer_set_default_font</a> (tiger_renderer *tr, const char *font)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__renderer.html#ga6563166deb14f8e59f0df6a777555e33">tiger_renderer_set_default_font_size</a> (tiger_renderer *tr, double size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__renderer.html#ga040d66cd7f0f36145b95adb901771a80">tiger_renderer_set_default_font_color</a> (tiger_renderer *tr, double r, double g, double b, double a)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__renderer.html#gae7a20cd2caf709e45762592f72e5ef73">tiger_renderer_set_default_background_fill_color</a> (tiger_renderer *tr, double r, double g, double b, double a)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__renderer.html#ga1fd5c877c282843fe77cd750022a01ae">tiger_renderer_set_default_font_effect</a> (tiger_renderer *tr, tiger_font_effect effect, double strength)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The libtiger public API. </p>
</div><hr/><h2>Define Documentation</h2>
<a class="anchor" id="a88a14ffc00753edd5af7aef8d9566eaa"></a><!-- doxytag: member="tiger.h::TIGER_E_BAD_SURFACE_TYPE" ref="a88a14ffc00753edd5af7aef8d9566eaa" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TIGER_E_BAD_SURFACE_TYPE&#160;&#160;&#160;(-1005)</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>this surface type is unsupported </p>

</div>
</div>
<a class="anchor" id="aad38b2d266bbfcc1dae6c1ea8b45984a"></a><!-- doxytag: member="tiger.h::TIGER_E_CAIRO_ERROR" ref="aad38b2d266bbfcc1dae6c1ea8b45984a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TIGER_E_CAIRO_ERROR&#160;&#160;&#160;(-1004)</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>the Cairo API returned an error </p>

<p>Referenced by <a class="el" href="group__renderer.html#ga616dfb49c1ea8b4dd44a204e702a51c9">tiger_renderer_set_buffer()</a>.</p>

</div>
</div>
<a class="anchor" id="a85a64b84aeaedaf40eadb7f93c9e81ec"></a><!-- doxytag: member="tiger.h::TIGER_E_INVALID_PARAMETER" ref="a85a64b84aeaedaf40eadb7f93c9e81ec" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TIGER_E_INVALID_PARAMETER&#160;&#160;&#160;(-1002)</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>a bogus parameter was passed (usually NULL) </p>

<p>Referenced by <a class="el" href="group__renderer.html#ga3a83f6b639322dbd99dd63ef03820716">tiger_renderer_add_event()</a>, <a class="el" href="group__renderer.html#ga27e03677cff75565a7723e1711c498aa">tiger_renderer_create()</a>, <a class="el" href="group__renderer.html#ga0f2963d8b49870418a58bfc0d3e7ee06">tiger_renderer_destroy()</a>, <a class="el" href="group__renderer.html#gab402a7397960e91f82bd7c91c2983435">tiger_renderer_render()</a>, <a class="el" href="group__renderer.html#ga4d0ddb1fe2af844fa424e0a80456fe8c">tiger_renderer_seek()</a>, <a class="el" href="group__renderer.html#ga616dfb49c1ea8b4dd44a204e702a51c9">tiger_renderer_set_buffer()</a>, <a class="el" href="group__renderer.html#gae7a20cd2caf709e45762592f72e5ef73">tiger_renderer_set_default_background_fill_color()</a>, <a class="el" href="group__renderer.html#gae587ee65bc447762de2356fc16b6dacd">tiger_renderer_set_default_font()</a>, <a class="el" href="group__renderer.html#ga040d66cd7f0f36145b95adb901771a80">tiger_renderer_set_default_font_color()</a>, <a class="el" href="group__renderer.html#gae011b62c293eb03168ff8e1a71c6f889">tiger_renderer_set_default_font_description()</a>, <a class="el" href="group__renderer.html#ga1fd5c877c282843fe77cd750022a01ae">tiger_renderer_set_default_font_effect()</a>, <a class="el" href="group__renderer.html#ga6563166deb14f8e59f0df6a777555e33">tiger_renderer_set_default_font_size()</a>, <a class="el" href="group__renderer.html#ga3a565f4c34b6e125167642a9ead21844">tiger_renderer_set_quality()</a>, <a class="el" href="group__renderer.html#ga04ee034ba17a605f11801b66205c5ed3">tiger_renderer_set_surface_clear_color()</a>, and <a class="el" href="group__renderer.html#gae15f847d25ce9c1b48ef29ecc75fcb60">tiger_renderer_update()</a>.</p>

</div>
</div>
<a class="anchor" id="abe0984eb0dc353431a986f2454a15aa7"></a><!-- doxytag: member="tiger.h::TIGER_E_NOT_FOUND" ref="abe0984eb0dc353431a986f2454a15aa7" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TIGER_E_NOT_FOUND&#160;&#160;&#160;(-1001)</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>whatever was requested was not found </p>

</div>
</div>
<a class="anchor" id="a6edd3fbbfcb508e5bc21211bedeb4467"></a><!-- doxytag: member="tiger.h::TIGER_E_OUT_OF_MEMORY" ref="a6edd3fbbfcb508e5bc21211bedeb4467" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TIGER_E_OUT_OF_MEMORY&#160;&#160;&#160;(-1003)</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>we're running out of cheese, bring some more </p>

<p>Referenced by <a class="el" href="group__renderer.html#ga3a83f6b639322dbd99dd63ef03820716">tiger_renderer_add_event()</a>, <a class="el" href="group__renderer.html#ga27e03677cff75565a7723e1711c498aa">tiger_renderer_create()</a>, <a class="el" href="group__renderer.html#gae587ee65bc447762de2356fc16b6dacd">tiger_renderer_set_default_font()</a>, <a class="el" href="group__renderer.html#gae011b62c293eb03168ff8e1a71c6f889">tiger_renderer_set_default_font_description()</a>, and <a class="el" href="group__renderer.html#ga6563166deb14f8e59f0df6a777555e33">tiger_renderer_set_default_font_size()</a>.</p>

</div>
</div>
<a class="anchor" id="a887c74f78bb61e39dcf7b2fcad37c6f3"></a><!-- doxytag: member="tiger.h::TIGER_VERSION_MAJOR" ref="a887c74f78bb61e39dcf7b2fcad37c6f3" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TIGER_VERSION_MAJOR&#160;&#160;&#160;0</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>major version number of the libtiger API </p>

<p>Referenced by <a class="el" href="group__version.html#ga11c041e2f1f0482fde918964eb40cafb">tiger_get_version()</a>, and <a class="el" href="group__version.html#ga999f2a211c9f176f59ebd1097f170baf">tiger_get_version_string()</a>.</p>

</div>
</div>
<a class="anchor" id="ae3732e558740635b4b7d87714720c51d"></a><!-- doxytag: member="tiger.h::TIGER_VERSION_MINOR" ref="ae3732e558740635b4b7d87714720c51d" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TIGER_VERSION_MINOR&#160;&#160;&#160;3</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>minor version number of the libtiger API </p>

<p>Referenced by <a class="el" href="group__version.html#ga11c041e2f1f0482fde918964eb40cafb">tiger_get_version()</a>, and <a class="el" href="group__version.html#ga999f2a211c9f176f59ebd1097f170baf">tiger_get_version_string()</a>.</p>

</div>
</div>
<a class="anchor" id="a4149cd1b4032c98915a40b43aa1bcad9"></a><!-- doxytag: member="tiger.h::TIGER_VERSION_PATCH" ref="a4149cd1b4032c98915a40b43aa1bcad9" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TIGER_VERSION_PATCH&#160;&#160;&#160;4</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>patch version number of the libtiger API </p>

<p>Referenced by <a class="el" href="group__version.html#ga11c041e2f1f0482fde918964eb40cafb">tiger_get_version()</a>, and <a class="el" href="group__version.html#ga999f2a211c9f176f59ebd1097f170baf">tiger_get_version_string()</a>.</p>

</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sat Mar 26 2011 for libtiger by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>