<!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: Renderer</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 <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 Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>Renderer</h1> </div>
</div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </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 </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 </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 </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 </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 </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 </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 </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 </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 </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 </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 </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 </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 </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 </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 </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>
<tr><td class="memItemLeft" align="right" valign="top">int </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>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga3a83f6b639322dbd99dd63ef03820716"></a><!-- doxytag: member="tiger_renderer.c::tiger_renderer_add_event" ref="ga3a83f6b639322dbd99dd63ef03820716" args="(tiger_renderer *tr, const kate_info *ki, const kate_event *ev)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tiger_renderer_add_event </td>
<td>(</td>
<td class="paramtype">tiger_renderer * </td>
<td class="paramname"><em>tr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const kate_info * </td>
<td class="paramname"><em>ki</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const kate_event * </td>
<td class="paramname"><em>ev</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds an event to the renderer </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">tr</td><td>the Tiger renderer to add the event to </td></tr>
<tr><td class="paramname">ki</td><td>the kate_info for the stream this events belongs to </td></tr>
<tr><td class="paramname">ev</td><td>the event to add to the renderer </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
TIGER_E_* error </dd></dl>
<p>References <a class="el" href="tiger_8h.html#a85a64b84aeaedaf40eadb7f93c9e81ec">TIGER_E_INVALID_PARAMETER</a>, and <a class="el" href="tiger_8h.html#a6edd3fbbfcb508e5bc21211bedeb4467">TIGER_E_OUT_OF_MEMORY</a>.</p>
</div>
</div>
<a class="anchor" id="ga27e03677cff75565a7723e1711c498aa"></a><!-- doxytag: member="tiger_renderer.c::tiger_renderer_create" ref="ga27e03677cff75565a7723e1711c498aa" args="(tiger_renderer **tr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tiger_renderer_create </td>
<td>(</td>
<td class="paramtype">tiger_renderer ** </td>
<td class="paramname"><em>tr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new Tiger renderer </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">tr</td><td>where to store a pointer to the newly created renderer </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
TIGER_E_* error </dd></dl>
<p>References <a class="el" href="tiger_8h.html#a85a64b84aeaedaf40eadb7f93c9e81ec">TIGER_E_INVALID_PARAMETER</a>, and <a class="el" href="tiger_8h.html#a6edd3fbbfcb508e5bc21211bedeb4467">TIGER_E_OUT_OF_MEMORY</a>.</p>
</div>
</div>
<a class="anchor" id="ga0f2963d8b49870418a58bfc0d3e7ee06"></a><!-- doxytag: member="tiger_renderer.c::tiger_renderer_destroy" ref="ga0f2963d8b49870418a58bfc0d3e7ee06" args="(tiger_renderer *tr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tiger_renderer_destroy </td>
<td>(</td>
<td class="paramtype">tiger_renderer * </td>
<td class="paramname"><em>tr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroys a previously initialized Tiger renderer </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">tr</td><td>the Tiger renderer to clear </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
TIGER_E_* error </dd></dl>
<p>References <a class="el" href="tiger_8h.html#a85a64b84aeaedaf40eadb7f93c9e81ec">TIGER_E_INVALID_PARAMETER</a>.</p>
</div>
</div>
<a class="anchor" id="gab0003d4d02cfde916fa8bcad6d7ed92f"></a><!-- doxytag: member="tiger_renderer.c::tiger_renderer_enable_caching" ref="gab0003d4d02cfde916fa8bcad6d7ed92f" args="(tiger_renderer *tr, int enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tiger_renderer_enable_caching </td>
<td>(</td>
<td class="paramtype">tiger_renderer * </td>
<td class="paramname"><em>tr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>enable</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enables or disables internal caching of text layouts </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">tr</td><td>the Tiger renderer for which to enable or disable caching </td></tr>
<tr><td class="paramname">enable</td><td>whether to enable or disable caching </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
TIGER_E_* error </dd></dl>
</div>
</div>
<a class="anchor" id="gaaf7c376dde566e84284036f0c5bb3b6b"></a><!-- doxytag: member="tiger_renderer.c::tiger_renderer_is_dirty" ref="gaaf7c376dde566e84284036f0c5bb3b6b" args="(const tiger_renderer *tr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tiger_renderer_is_dirty </td>
<td>(</td>
<td class="paramtype">const tiger_renderer * </td>
<td class="paramname"><em>tr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks whether the Tiger renderer is dirty or not (eg, whether rendering a frame now would yield a different frame from the previous frame). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">tr</td><td>the Tiger renderer to query </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success, and the Tiger renderer is not dirrty </dd>
<dd>
!0 success, the Tiger renderer is dirty </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The client code may choose not to call tiger_renderer_render if the renderer is not dirty as an optimization. However, care should be taken if the buffer the frame was rendered onto was changed (eg, if a new video frame was drawn onto it); in this case, a new frame should be rendered on top of the video, even if the Tiger frame would be the same as the previous frame, as it would have been erased by the video. </dd></dl>
</div>
</div>
<a class="anchor" id="gab402a7397960e91f82bd7c91c2983435"></a><!-- doxytag: member="tiger_renderer.c::tiger_renderer_render" ref="gab402a7397960e91f82bd7c91c2983435" args="(tiger_renderer *tr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tiger_renderer_render </td>
<td>(</td>
<td class="paramtype">tiger_renderer * </td>
<td class="paramname"><em>tr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Renders the current state of the renderer </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">tr</td><td>the Tiger renderer to update </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
TIGER_E_* error </dd></dl>
<p>References <a class="el" href="tiger_8h.html#a85a64b84aeaedaf40eadb7f93c9e81ec">TIGER_E_INVALID_PARAMETER</a>.</p>
</div>
</div>
<a class="anchor" id="ga4d0ddb1fe2af844fa424e0a80456fe8c"></a><!-- doxytag: member="tiger_renderer.c::tiger_renderer_seek" ref="ga4d0ddb1fe2af844fa424e0a80456fe8c" args="(tiger_renderer *tr, kate_float target)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tiger_renderer_seek </td>
<td>(</td>
<td class="paramtype">tiger_renderer * </td>
<td class="paramname"><em>tr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_float </td>
<td class="paramname"><em>target</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Registers that a seek occured </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">tr</td><td>the Tiger renderer on which the seek occured </td></tr>
<tr><td class="paramname">target</td><td>the target time of the seek </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
TIGER_E_* error </dd></dl>
<p>References <a class="el" href="tiger_8h.html#a85a64b84aeaedaf40eadb7f93c9e81ec">TIGER_E_INVALID_PARAMETER</a>.</p>
</div>
</div>
<a class="anchor" id="ga616dfb49c1ea8b4dd44a204e702a51c9"></a><!-- doxytag: member="tiger_renderer.c::tiger_renderer_set_buffer" ref="ga616dfb49c1ea8b4dd44a204e702a51c9" args="(tiger_renderer *tr, unsigned char *ptr, int width, int height, int stride, int swap_rgb)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tiger_renderer_set_buffer </td>
<td>(</td>
<td class="paramtype">tiger_renderer * </td>
<td class="paramname"><em>tr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>stride</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>swap_rgb</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a buffer where to render the Kate stream. This buffer should be a linear buffer with 32 bits per pixel, with 8 bits per color component in ARGB order (or ABGR is swap_rgb is non zero) in host endianness. This buffer will be used as backing store for a Cairo surface, so any other requirement by Cairo also applies here. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">tr</td><td>the Tiger renderer for which to set the buffer </td></tr>
<tr><td class="paramname">ptr</td><td>the data to use as backing store for the Cairo surface </td></tr>
<tr><td class="paramname">width</td><td>the width of the Cairo surface to create </td></tr>
<tr><td class="paramname">height</td><td>the height of the Cairo surface to create </td></tr>
<tr><td class="paramname">stride</td><td>the stride of the Cairo surface to create </td></tr>
<tr><td class="paramname">swap_rgb</td><td>if non zero, red and blue components are swapped </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
TIGER_E_* error </dd></dl>
<p>References <a class="el" href="tiger_8h.html#aad38b2d266bbfcc1dae6c1ea8b45984a">TIGER_E_CAIRO_ERROR</a>, and <a class="el" href="tiger_8h.html#a85a64b84aeaedaf40eadb7f93c9e81ec">TIGER_E_INVALID_PARAMETER</a>.</p>
</div>
</div>
<a class="anchor" id="gae7a20cd2caf709e45762592f72e5ef73"></a><!-- doxytag: member="tiger_renderer.c::tiger_renderer_set_default_background_fill_color" ref="gae7a20cd2caf709e45762592f72e5ef73" args="(tiger_renderer *tr, double r, double g, double b, double a)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tiger_renderer_set_default_background_fill_color </td>
<td>(</td>
<td class="paramtype">tiger_renderer * </td>
<td class="paramname"><em>tr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>g</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>a</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the default font color to use for background. The default is to not fill the background (though a Kate event may specify a background), but in cases where the text may be hard to read over a video, specifying a background fill color will allow the text to stand out more. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">tr</td><td>the Tiger renderer for which to set the background fill color </td></tr>
<tr><td class="paramname">r</td><td>the red component of the background fill color, in the 0-1 range </td></tr>
<tr><td class="paramname">g</td><td>the green component of the background fill color, in the 0-1 range </td></tr>
<tr><td class="paramname">b</td><td>the blue component of the background fill color, in the 0-1 range </td></tr>
<tr><td class="paramname">a</td><td>the alpha component of the background fill color, in the 0-1 range </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
TIGER_E_* error </dd></dl>
<p>References <a class="el" href="tiger_8h.html#a85a64b84aeaedaf40eadb7f93c9e81ec">TIGER_E_INVALID_PARAMETER</a>.</p>
</div>
</div>
<a class="anchor" id="gae587ee65bc447762de2356fc16b6dacd"></a><!-- doxytag: member="tiger_renderer.c::tiger_renderer_set_default_font" ref="gae587ee65bc447762de2356fc16b6dacd" args="(tiger_renderer *tr, const char *font)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tiger_renderer_set_default_font </td>
<td>(</td>
<td class="paramtype">tiger_renderer * </td>
<td class="paramname"><em>tr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>font</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the default font to use if none is specified </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">tr</td><td>the Tiger renderer for which to set the default font </td></tr>
<tr><td class="paramname">font</td><td>the font to use as default, a copy of which is made </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
TIGER_E_* error </dd></dl>
<p>References <a class="el" href="tiger_8h.html#a85a64b84aeaedaf40eadb7f93c9e81ec">TIGER_E_INVALID_PARAMETER</a>, and <a class="el" href="tiger_8h.html#a6edd3fbbfcb508e5bc21211bedeb4467">TIGER_E_OUT_OF_MEMORY</a>.</p>
</div>
</div>
<a class="anchor" id="ga040d66cd7f0f36145b95adb901771a80"></a><!-- doxytag: member="tiger_renderer.c::tiger_renderer_set_default_font_color" ref="ga040d66cd7f0f36145b95adb901771a80" args="(tiger_renderer *tr, double r, double g, double b, double a)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tiger_renderer_set_default_font_color </td>
<td>(</td>
<td class="paramtype">tiger_renderer * </td>
<td class="paramname"><em>tr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>g</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>a</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the default font color to use if none is specified </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">tr</td><td>the Tiger renderer for which to set the default font color </td></tr>
<tr><td class="paramname">r</td><td>the red component of the default color, in the 0-1 range </td></tr>
<tr><td class="paramname">g</td><td>the green component of the default color, in the 0-1 range </td></tr>
<tr><td class="paramname">b</td><td>the blue component of the default color, in the 0-1 range </td></tr>
<tr><td class="paramname">a</td><td>the alpha component of the default color, in the 0-1 range </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
TIGER_E_* error </dd></dl>
<p>References <a class="el" href="tiger_8h.html#a85a64b84aeaedaf40eadb7f93c9e81ec">TIGER_E_INVALID_PARAMETER</a>.</p>
</div>
</div>
<a class="anchor" id="gae011b62c293eb03168ff8e1a71c6f889"></a><!-- doxytag: member="tiger_renderer.c::tiger_renderer_set_default_font_description" ref="gae011b62c293eb03168ff8e1a71c6f889" args="(tiger_renderer *tr, const char *desc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tiger_renderer_set_default_font_description </td>
<td>(</td>
<td class="paramtype">tiger_renderer * </td>
<td class="paramname"><em>tr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>desc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the default font description to use if no override is specified </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">tr</td><td>the Tiger renderer for which to set the default font </td></tr>
<tr><td class="paramname">desc</td><td>the font description to use as default </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
TIGER_E_* error </dd></dl>
<p>References <a class="el" href="tiger_8h.html#a85a64b84aeaedaf40eadb7f93c9e81ec">TIGER_E_INVALID_PARAMETER</a>, and <a class="el" href="tiger_8h.html#a6edd3fbbfcb508e5bc21211bedeb4467">TIGER_E_OUT_OF_MEMORY</a>.</p>
</div>
</div>
<a class="anchor" id="ga1fd5c877c282843fe77cd750022a01ae"></a><!-- doxytag: member="tiger_renderer.c::tiger_renderer_set_default_font_effect" ref="ga1fd5c877c282843fe77cd750022a01ae" args="(tiger_renderer *tr, tiger_font_effect effect, double strength)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tiger_renderer_set_default_font_effect </td>
<td>(</td>
<td class="paramtype">tiger_renderer * </td>
<td class="paramname"><em>tr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">tiger_font_effect </td>
<td class="paramname"><em>effect</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>strength</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the default font effect. The default is to have no effect (tiger_font_plain). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">tr</td><td>the Tiger renderer for which to set which font effect to use </td></tr>
<tr><td class="paramname">effect</td><td>the font effect to use </td></tr>
<tr><td class="paramname">strength</td><td>how pronounced to make the effect (effect dependent) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
TIGER_E_* error </dd></dl>
<p>References <a class="el" href="tiger_8h.html#a85a64b84aeaedaf40eadb7f93c9e81ec">TIGER_E_INVALID_PARAMETER</a>.</p>
</div>
</div>
<a class="anchor" id="ga6563166deb14f8e59f0df6a777555e33"></a><!-- doxytag: member="tiger_renderer.c::tiger_renderer_set_default_font_size" ref="ga6563166deb14f8e59f0df6a777555e33" args="(tiger_renderer *tr, double size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tiger_renderer_set_default_font_size </td>
<td>(</td>
<td class="paramtype">tiger_renderer * </td>
<td class="paramname"><em>tr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the default font size to use if none is specified </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">tr</td><td>the Tiger renderer for which to set the default font size </td></tr>
<tr><td class="paramname">size</td><td>the font size to use as default </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
TIGER_E_* error </dd></dl>
<p>References <a class="el" href="tiger_8h.html#a85a64b84aeaedaf40eadb7f93c9e81ec">TIGER_E_INVALID_PARAMETER</a>, and <a class="el" href="tiger_8h.html#a6edd3fbbfcb508e5bc21211bedeb4467">TIGER_E_OUT_OF_MEMORY</a>.</p>
</div>
</div>
<a class="anchor" id="ga3a565f4c34b6e125167642a9ead21844"></a><!-- doxytag: member="tiger_renderer.c::tiger_renderer_set_quality" ref="ga3a565f4c34b6e125167642a9ead21844" args="(tiger_renderer *tr, double quality)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tiger_renderer_set_quality </td>
<td>(</td>
<td class="paramtype">tiger_renderer * </td>
<td class="paramname"><em>tr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>quality</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a relative quality for the rendering </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">tr</td><td>the Tiger renderer for which to set the quality </td></tr>
<tr><td class="paramname">quality</td><td>rendering quality, between 0 (lowest, fastest) and 1 (highest, slowest), or negative for default quality </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
TIGER_E_* error </dd></dl>
<p>References <a class="el" href="tiger_8h.html#a85a64b84aeaedaf40eadb7f93c9e81ec">TIGER_E_INVALID_PARAMETER</a>.</p>
</div>
</div>
<a class="anchor" id="ga04ee034ba17a605f11801b66205c5ed3"></a><!-- doxytag: member="tiger_renderer.c::tiger_renderer_set_surface_clear_color" ref="ga04ee034ba17a605f11801b66205c5ed3" args="(tiger_renderer *tr, int clear, double r, double g, double b, double a)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tiger_renderer_set_surface_clear_color </td>
<td>(</td>
<td class="paramtype">tiger_renderer * </td>
<td class="paramname"><em>tr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>clear</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>g</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>a</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets whether to clear the surface before rendering, and the clearing color </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">tr</td><td>the Tiger renderer to modify </td></tr>
<tr><td class="paramname">clear</td><td>whether to clear before rendering </td></tr>
<tr><td class="paramname">r</td><td>the red value of the clear color </td></tr>
<tr><td class="paramname">g</td><td>the green value of the clear color </td></tr>
<tr><td class="paramname">b</td><td>the blue value of the clear color </td></tr>
<tr><td class="paramname">a</td><td>the alpha value of the clear color </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
TIGER_E_* error </dd></dl>
<p>References <a class="el" href="tiger_8h.html#a85a64b84aeaedaf40eadb7f93c9e81ec">TIGER_E_INVALID_PARAMETER</a>.</p>
</div>
</div>
<a class="anchor" id="gae15f847d25ce9c1b48ef29ecc75fcb60"></a><!-- doxytag: member="tiger_renderer.c::tiger_renderer_update" ref="gae15f847d25ce9c1b48ef29ecc75fcb60" args="(tiger_renderer *tr, kate_float t, int track)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int tiger_renderer_update </td>
<td>(</td>
<td class="paramtype">tiger_renderer * </td>
<td class="paramname"><em>tr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_float </td>
<td class="paramname"><em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>track</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the renderer at the new time </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">tr</td><td>the Tiger renderer to update </td></tr>
<tr><td class="paramname">t</td><td>the time to update to renderer to </td></tr>
<tr><td class="paramname">track</td><td>whether to update item trackers </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
1 success, but no Kate events are currently active </dd>
<dd>
TIGER_E_* error </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Even if 0 is returned, a call to draw may not actually change the rendering surface, for instance if all active Kate events have a text with fully transparent color and no background, etc. </dd></dl>
<p>References <a class="el" href="tiger_8h.html#a85a64b84aeaedaf40eadb7f93c9e81ec">TIGER_E_INVALID_PARAMETER</a>.</p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sat Mar 26 2011 for libtiger by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
89de7b48d4fd156f0af7b4735abd1453
>
files
>
23
