<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>libcaca documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.8.11 -->
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">libcaca basic functions</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga00caafb33b9d7033d064a642bcad83da"><td class="memItemLeft" align="right" valign="top">__extern <a class="el" href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libcaca.html#ga00caafb33b9d7033d064a642bcad83da">caca_create_canvas</a> (int, int)</td></tr>
<tr class="memdesc:ga00caafb33b9d7033d064a642bcad83da"><td class="mdescLeft"> </td><td class="mdescRight">Initialise a <em>libcaca</em> canvas. <a href="#ga00caafb33b9d7033d064a642bcad83da">More...</a><br /></td></tr>
<tr class="separator:ga00caafb33b9d7033d064a642bcad83da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab5f079a934949a06c100b0db604d697e"><td class="memItemLeft" align="right" valign="top">__extern int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libcaca.html#gab5f079a934949a06c100b0db604d697e">caca_manage_canvas</a> (<a class="el" href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a> *, int(*)(void *), void *)</td></tr>
<tr class="memdesc:gab5f079a934949a06c100b0db604d697e"><td class="mdescLeft"> </td><td class="mdescRight">Manage a canvas. <a href="#gab5f079a934949a06c100b0db604d697e">More...</a><br /></td></tr>
<tr class="separator:gab5f079a934949a06c100b0db604d697e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9a793c6b42c90884e650fa03f4640b17"><td class="memItemLeft" align="right" valign="top">__extern int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libcaca.html#ga9a793c6b42c90884e650fa03f4640b17">caca_unmanage_canvas</a> (<a class="el" href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a> *, int(*)(void *), void *)</td></tr>
<tr class="memdesc:ga9a793c6b42c90884e650fa03f4640b17"><td class="mdescLeft"> </td><td class="mdescRight">unmanage a canvas. <a href="#ga9a793c6b42c90884e650fa03f4640b17">More...</a><br /></td></tr>
<tr class="separator:ga9a793c6b42c90884e650fa03f4640b17"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8814d2faa76cad0d7d15381b7eeacab6"><td class="memItemLeft" align="right" valign="top">__extern int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libcaca.html#ga8814d2faa76cad0d7d15381b7eeacab6">caca_set_canvas_size</a> (<a class="el" href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a> *, int, int)</td></tr>
<tr class="memdesc:ga8814d2faa76cad0d7d15381b7eeacab6"><td class="mdescLeft"> </td><td class="mdescRight">Resize a canvas. <a href="#ga8814d2faa76cad0d7d15381b7eeacab6">More...</a><br /></td></tr>
<tr class="separator:ga8814d2faa76cad0d7d15381b7eeacab6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad85b2ff4c7f952b3cc32f117343a6375"><td class="memItemLeft" align="right" valign="top">__extern int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libcaca.html#gad85b2ff4c7f952b3cc32f117343a6375">caca_get_canvas_width</a> (<a class="el" href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a> const *)</td></tr>
<tr class="memdesc:gad85b2ff4c7f952b3cc32f117343a6375"><td class="mdescLeft"> </td><td class="mdescRight">Get the canvas width. <a href="#gad85b2ff4c7f952b3cc32f117343a6375">More...</a><br /></td></tr>
<tr class="separator:gad85b2ff4c7f952b3cc32f117343a6375"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa529140e8cf31379a6b57af7c37c9d2f"><td class="memItemLeft" align="right" valign="top">__extern int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libcaca.html#gaa529140e8cf31379a6b57af7c37c9d2f">caca_get_canvas_height</a> (<a class="el" href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a> const *)</td></tr>
<tr class="memdesc:gaa529140e8cf31379a6b57af7c37c9d2f"><td class="mdescLeft"> </td><td class="mdescRight">Get the canvas height. <a href="#gaa529140e8cf31379a6b57af7c37c9d2f">More...</a><br /></td></tr>
<tr class="separator:gaa529140e8cf31379a6b57af7c37c9d2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7112bdf128f94eeae9d66fbc49f96d81"><td class="memItemLeft" align="right" valign="top">__extern uint32_t const * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libcaca.html#ga7112bdf128f94eeae9d66fbc49f96d81">caca_get_canvas_chars</a> (<a class="el" href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a> const *)</td></tr>
<tr class="memdesc:ga7112bdf128f94eeae9d66fbc49f96d81"><td class="mdescLeft"> </td><td class="mdescRight">Get the canvas character array. <a href="#ga7112bdf128f94eeae9d66fbc49f96d81">More...</a><br /></td></tr>
<tr class="separator:ga7112bdf128f94eeae9d66fbc49f96d81"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6d451ebbe4f6af86851f1f2abefabbd4"><td class="memItemLeft" align="right" valign="top">__extern uint32_t const * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libcaca.html#ga6d451ebbe4f6af86851f1f2abefabbd4">caca_get_canvas_attrs</a> (<a class="el" href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a> const *)</td></tr>
<tr class="memdesc:ga6d451ebbe4f6af86851f1f2abefabbd4"><td class="mdescLeft"> </td><td class="mdescRight">Get the canvas attribute array. <a href="#ga6d451ebbe4f6af86851f1f2abefabbd4">More...</a><br /></td></tr>
<tr class="separator:ga6d451ebbe4f6af86851f1f2abefabbd4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga12394c16c9ca94b61198be929ef8580d"><td class="memItemLeft" align="right" valign="top">__extern int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libcaca.html#ga12394c16c9ca94b61198be929ef8580d">caca_free_canvas</a> (<a class="el" href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a> *)</td></tr>
<tr class="memdesc:ga12394c16c9ca94b61198be929ef8580d"><td class="mdescLeft"> </td><td class="mdescRight">Free a <em>libcaca</em> canvas. <a href="#ga12394c16c9ca94b61198be929ef8580d">More...</a><br /></td></tr>
<tr class="separator:ga12394c16c9ca94b61198be929ef8580d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga685374ff836369f58a5c32a414096f2e"><td class="memItemLeft" align="right" valign="top">__extern int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libcaca.html#ga685374ff836369f58a5c32a414096f2e">caca_rand</a> (int, int)</td></tr>
<tr class="memdesc:ga685374ff836369f58a5c32a414096f2e"><td class="mdescLeft"> </td><td class="mdescRight">Generate a random integer within a range. <a href="#ga685374ff836369f58a5c32a414096f2e">More...</a><br /></td></tr>
<tr class="separator:ga685374ff836369f58a5c32a414096f2e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3c7edc520b7ea69a721317a9d8649440"><td class="memItemLeft" align="right" valign="top">__extern char const * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libcaca.html#ga3c7edc520b7ea69a721317a9d8649440">caca_get_version</a> (void)</td></tr>
<tr class="memdesc:ga3c7edc520b7ea69a721317a9d8649440"><td class="mdescLeft"> </td><td class="mdescRight">Return the <em>libcaca</em> version. <a href="#ga3c7edc520b7ea69a721317a9d8649440">More...</a><br /></td></tr>
<tr class="separator:ga3c7edc520b7ea69a721317a9d8649440"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>These functions provide the basic <em>libcaca</em> routines for library initialisation, system information retrieval and configuration. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga00caafb33b9d7033d064a642bcad83da"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern <a class="el" href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a>* caca_create_canvas </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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialise internal <em>libcaca</em> structures and the backend that will be used for subsequent graphical operations. It must be the first <em>libcaca</em> function to be called in a function. <a class="el" href="group__libcaca.html#ga12394c16c9ca94b61198be929ef8580d" title="Free a libcaca canvas. ">caca_free_canvas()</a> should be called at the end of the program to free all allocated resources.</p>
<p>Both the cursor and the canvas' handle are initialised at the top-left corner.</p>
<p>If an error occurs, NULL is returned and <b>errno</b> is set accordingly:</p><ul>
<li><code>EINVAL</code> Specified width or height is invalid.</li>
<li><code>ENOMEM</code> Not enough memory for the requested canvas size.</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">width</td><td>The desired canvas width </td></tr>
<tr><td class="paramname">height</td><td>The desired canvas height </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A libcaca canvas handle upon success, NULL if an error occurred. </dd></dl>
<p>References <a class="el" href="group__caca__attr.html#gga9db83488c6f07a5f7d773c380b3126a9a75851cb7e307bd85518cc33cfe8e9a89">CACA_DEFAULT</a>, <a class="el" href="group__caca__attributes.html#ga1cd39df80cc6b537a4df18415a8605cf">caca_set_color_ansi()</a>, and <a class="el" href="group__caca__attr.html#gga9db83488c6f07a5f7d773c380b3126a9a5828387b58020523f4c6da94961c2f77">CACA_TRANSPARENT</a>.</p>
<p>Referenced by <a class="el" href="group__conio.html#ga574080c56d612712622918e7ee1d5973">caca_conio_movetext()</a>, <a class="el" href="group__conio.html#gad736275d1dd50c2ad3afcb5d63303f18">caca_conio_window()</a>, <a class="el" href="group__caca__display.html#ga4b2517558ff72b670a1e747b5415417e">caca_create_display_with_driver()</a>, <a class="el" href="group__caca__importexport.html#ga026c45b9247dc7f9fb39878f9deca03c">caca_export_area_to_memory()</a>, <a class="el" href="group__caca__figfont.html#gad86d0785a97d54ebe796dcda02d7900f">caca_flush_figlet()</a>, <a class="el" href="group__caca__importexport.html#gae6bcaa3e30d6ba075c14a817a2464f55">caca_import_area_from_file()</a>, <a class="el" href="group__caca__importexport.html#ga4455d225b91573e265211e5c41553a37">caca_import_area_from_memory()</a>, <a class="el" href="group__libcaca.html#ga685374ff836369f58a5c32a414096f2e">caca_rand()</a>, and <a class="el" href="group__caca__canvas.html#ga194b440e32158e876bb25849105db74d">caca_set_canvas_boundaries()</a>.</p>
</div>
</div>
<a class="anchor" id="gab5f079a934949a06c100b0db604d697e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern int caca_manage_canvas </td>
<td>(</td>
<td class="paramtype"><a class="el" href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a> * </td>
<td class="paramname"><em>cv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int(*)(void *) </td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>p</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Lock a canvas to prevent it from being resized. If non-NULL, the <em>callback</em> function pointer will be called upon each <em>caca_set_canvas_size</em> call and if the returned value is zero, the canvas resize request will be denied.</p>
<p>This function is only useful for display drivers such as the <em>libcaca</em> library.</p>
<p>If an error occurs, -1 is returned and <b>errno</b> is set accordingly:</p><ul>
<li><code>EBUSY</code> The canvas is already being managed.</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cv</td><td>A libcaca canvas. </td></tr>
<tr><td class="paramname">callback</td><td>An optional callback function pointer. </td></tr>
<tr><td class="paramname">p</td><td>The argument to be passed to <em>callback</em>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 in case of success, -1 if an error occurred. </dd></dl>
<p>Referenced by <a class="el" href="group__caca__display.html#ga4b2517558ff72b670a1e747b5415417e">caca_create_display_with_driver()</a>, and <a class="el" href="group__libcaca.html#ga685374ff836369f58a5c32a414096f2e">caca_rand()</a>.</p>
</div>
</div>
<a class="anchor" id="ga9a793c6b42c90884e650fa03f4640b17"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern int caca_unmanage_canvas </td>
<td>(</td>
<td class="paramtype"><a class="el" href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a> * </td>
<td class="paramname"><em>cv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int(*)(void *) </td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>p</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>unlock a canvas previously locked by <a class="el" href="group__libcaca.html#gab5f079a934949a06c100b0db604d697e" title="Manage a canvas. ">caca_manage_canvas()</a>. for safety reasons, the callback and callback data arguments must be the same as for the <a class="el" href="group__libcaca.html#gab5f079a934949a06c100b0db604d697e" title="Manage a canvas. ">caca_manage_canvas()</a> call.</p>
<p>this function is only useful for display drivers such as the <em>libcaca</em> library.</p>
<p>if an error occurs, -1 is returned and <b>errno</b> is set accordingly:</p><ul>
<li><code>einval</code> the canvas is not managed, or the callback arguments do not match.</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cv</td><td>a libcaca canvas. </td></tr>
<tr><td class="paramname">callback</td><td>the <em>callback</em> argument previously passed to <a class="el" href="group__libcaca.html#gab5f079a934949a06c100b0db604d697e" title="Manage a canvas. ">caca_manage_canvas()</a>. </td></tr>
<tr><td class="paramname">p</td><td>the <em>p</em> argument previously passed to <a class="el" href="group__libcaca.html#gab5f079a934949a06c100b0db604d697e" title="Manage a canvas. ">caca_manage_canvas()</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 in case of success, -1 if an error occurred. </dd></dl>
<p>Referenced by <a class="el" href="group__caca__display.html#ga4b2517558ff72b670a1e747b5415417e">caca_create_display_with_driver()</a>, <a class="el" href="group__caca__display.html#gac1b5b4540a500dd59eaa673d784fab1f">caca_free_display()</a>, and <a class="el" href="group__libcaca.html#ga685374ff836369f58a5c32a414096f2e">caca_rand()</a>.</p>
</div>
</div>
<a class="anchor" id="ga8814d2faa76cad0d7d15381b7eeacab6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern int caca_set_canvas_size </td>
<td>(</td>
<td class="paramtype"><a class="el" href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a> * </td>
<td class="paramname"><em>cv</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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the canvas' width and height, in character cells.</p>
<p>The contents of the canvas are preserved to the extent of the new canvas size. Newly allocated character cells at the right and/or at the bottom of the canvas are filled with spaces.</p>
<p>If as a result of the resize the cursor coordinates fall outside the new canvas boundaries, they are readjusted. For instance, if the current X cursor coordinate is 11 and the requested width is 10, the new X cursor coordinate will be 10.</p>
<p>It is an error to try to resize the canvas if an output driver has been attached to the canvas using <a class="el" href="group__caca__display.html#gac393d4446d813f6e4ba93d2b583c1edb" title="Attach a caca graphical context to a caca canvas. ">caca_create_display()</a>. You need to remove the output driver using <a class="el" href="group__caca__display.html#gac1b5b4540a500dd59eaa673d784fab1f" title="Detach a caca graphical context from a caca backend context. ">caca_free_display()</a> before you can change the canvas size again. However, the caca output driver can cause a canvas resize through user interaction. See the <a class="el" href="structcaca__event.html" title="Handling of user events. ">caca_event()</a> documentation for more about this.</p>
<p>If an error occurs, -1 is returned and <b>errno</b> is set accordingly:</p><ul>
<li><code>EINVAL</code> Specified width or height is invalid.</li>
<li><code>EBUSY</code> The canvas is in use by a display driver and cannot be resized.</li>
<li><code>ENOMEM</code> Not enough memory for the requested canvas size. If this happens, the canvas handle becomes invalid and should not be used.</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cv</td><td>A libcaca canvas. </td></tr>
<tr><td class="paramname">width</td><td>The desired canvas width. </td></tr>
<tr><td class="paramname">height</td><td>The desired canvas height. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 in case of success, -1 if an error occurred. </dd></dl>
<p>Referenced by <a class="el" href="group__caca__figfont.html#ga59aa7a3c5c0988152386aad3751a2381">caca_canvas_set_figfont()</a>, <a class="el" href="group__caca__figfont.html#gad86d0785a97d54ebe796dcda02d7900f">caca_flush_figlet()</a>, <a class="el" href="group__caca__importexport.html#gaf49776c6092b0d3f47624e837acaa8a6">caca_get_import_list()</a>, <a class="el" href="group__caca__figfont.html#ga53d156bf4e4f7606c9f1a8f558d06ef1">caca_put_figchar()</a>, <a class="el" href="group__libcaca.html#ga685374ff836369f58a5c32a414096f2e">caca_rand()</a>, and <a class="el" href="group__caca__display.html#ga2a1d361cd5accd39925fb0e92bf15579">caca_set_mouse()</a>.</p>
</div>
</div>
<a class="anchor" id="gad85b2ff4c7f952b3cc32f117343a6375"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern int caca_get_canvas_width </td>
<td>(</td>
<td class="paramtype"><a class="el" href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a> const * </td>
<td class="paramname"><em>cv</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the current canvas' width, in character cells.</p>
<p>This function never fails.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cv</td><td>A libcaca canvas. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The canvas width. </dd></dl>
<p>Referenced by <a class="el" href="group__conio.html#ga0b97285ca8ed957c6787495fad7ba35c">caca_conio_clreol()</a>, <a class="el" href="group__conio.html#ga574080c56d612712622918e7ee1d5973">caca_conio_movetext()</a>, <a class="el" href="group__caca__primitives.html#gaf7639315e8de3e0c1f3aa7fc557e155f">caca_fill_triangle()</a>, <a class="el" href="group__caca__event.html#ga20d8da5ded5ae58fa3050c8fadc40a46">caca_get_event_resize_height()</a>, <a class="el" href="group__caca__importexport.html#ga264bcf9f821d67f33bd5ee5aa5e048a0">caca_get_export_list()</a>, <a class="el" href="group__caca__event.html#gaf01ff2ff5f63e38eed2052b53181da2d">caca_get_mouse_x()</a>, <a class="el" href="group__libcaca.html#ga3c7edc520b7ea69a721317a9d8649440">caca_get_version()</a>, <a class="el" href="group__libcaca.html#ga685374ff836369f58a5c32a414096f2e">caca_rand()</a>, and <a class="el" href="group__caca__display.html#ga2a1d361cd5accd39925fb0e92bf15579">caca_set_mouse()</a>.</p>
</div>
</div>
<a class="anchor" id="gaa529140e8cf31379a6b57af7c37c9d2f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern int caca_get_canvas_height </td>
<td>(</td>
<td class="paramtype"><a class="el" href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a> const * </td>
<td class="paramname"><em>cv</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current canvas' height, in character cells.</p>
<p>This function never fails.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cv</td><td>A libcaca canvas. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The canvas height. </dd></dl>
<p>Referenced by <a class="el" href="group__caca__primitives.html#gaf7639315e8de3e0c1f3aa7fc557e155f">caca_fill_triangle()</a>, <a class="el" href="group__caca__figfont.html#gad86d0785a97d54ebe796dcda02d7900f">caca_flush_figlet()</a>, <a class="el" href="group__caca__event.html#ga20d8da5ded5ae58fa3050c8fadc40a46">caca_get_event_resize_height()</a>, <a class="el" href="group__caca__importexport.html#ga264bcf9f821d67f33bd5ee5aa5e048a0">caca_get_export_list()</a>, <a class="el" href="group__caca__event.html#gac3310eaf44cc95e46be5c3e9a8a6818e">caca_get_mouse_y()</a>, <a class="el" href="group__libcaca.html#ga3c7edc520b7ea69a721317a9d8649440">caca_get_version()</a>, <a class="el" href="group__libcaca.html#ga685374ff836369f58a5c32a414096f2e">caca_rand()</a>, and <a class="el" href="group__caca__display.html#ga2a1d361cd5accd39925fb0e92bf15579">caca_set_mouse()</a>.</p>
</div>
</div>
<a class="anchor" id="ga7112bdf128f94eeae9d66fbc49f96d81"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern uint32_t const* caca_get_canvas_chars </td>
<td>(</td>
<td class="paramtype"><a class="el" href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a> const * </td>
<td class="paramname"><em>cv</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the current canvas' internal character array. The array elements consist in native endian 32-bit Unicode values as returned by <a class="el" href="group__caca__canvas.html#ga66bd04edac05780b3fd4435e3ef874af" title="Get the Unicode character at the given coordinates. ">caca_get_char()</a>.</p>
<p>This function is probably only useful for <em>libcaca</em> 's internal display drivers.</p>
<p>This function never fails.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cv</td><td>A libcaca canvas. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The canvas character array. </dd></dl>
<p>Referenced by <a class="el" href="group__libcaca.html#ga685374ff836369f58a5c32a414096f2e">caca_rand()</a>.</p>
</div>
</div>
<a class="anchor" id="ga6d451ebbe4f6af86851f1f2abefabbd4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern uint32_t const* caca_get_canvas_attrs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a> const * </td>
<td class="paramname"><em>cv</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current canvas' internal attribute array. The array elements consist in native endian 32-bit attribute values as returned by <a class="el" href="group__caca__attributes.html#gafb35087f212d75b431fc501b3a777b6b" title="Get the text attribute at the given coordinates. ">caca_get_attr()</a>.</p>
<p>This function is probably only useful for <em>libcaca</em> 's internal display drivers.</p>
<p>This function never fails.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cv</td><td>A libcaca canvas. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The canvas attribute array. </dd></dl>
<p>Referenced by <a class="el" href="group__libcaca.html#ga685374ff836369f58a5c32a414096f2e">caca_rand()</a>.</p>
</div>
</div>
<a class="anchor" id="ga12394c16c9ca94b61198be929ef8580d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern int caca_free_canvas </td>
<td>(</td>
<td class="paramtype"><a class="el" href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a> * </td>
<td class="paramname"><em>cv</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free all resources allocated by <a class="el" href="group__libcaca.html#ga00caafb33b9d7033d064a642bcad83da" title="Initialise a libcaca canvas. ">caca_create_canvas()</a>. The canvas pointer becomes invalid and must no longer be used unless a new call to <a class="el" href="group__libcaca.html#ga00caafb33b9d7033d064a642bcad83da" title="Initialise a libcaca canvas. ">caca_create_canvas()</a> is made.</p>
<p>If an error occurs, -1 is returned and <b>errno</b> is set accordingly:</p><ul>
<li><code>EBUSY</code> The canvas is in use by a display driver and cannot be freed.</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cv</td><td>A libcaca canvas. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 in case of success, -1 if an error occurred. </dd></dl>
<p>References <a class="el" href="group__caca__figfont.html#ga59aa7a3c5c0988152386aad3751a2381">caca_canvas_set_figfont()</a>.</p>
<p>Referenced by <a class="el" href="group__caca__figfont.html#ga59aa7a3c5c0988152386aad3751a2381">caca_canvas_set_figfont()</a>, <a class="el" href="group__conio.html#gad736275d1dd50c2ad3afcb5d63303f18">caca_conio_window()</a>, <a class="el" href="group__caca__display.html#ga4b2517558ff72b670a1e747b5415417e">caca_create_display_with_driver()</a>, <a class="el" href="group__caca__importexport.html#ga026c45b9247dc7f9fb39878f9deca03c">caca_export_area_to_memory()</a>, <a class="el" href="group__caca__figfont.html#gad86d0785a97d54ebe796dcda02d7900f">caca_flush_figlet()</a>, <a class="el" href="group__caca__display.html#gac1b5b4540a500dd59eaa673d784fab1f">caca_free_display()</a>, <a class="el" href="group__caca__importexport.html#gae6bcaa3e30d6ba075c14a817a2464f55">caca_import_area_from_file()</a>, <a class="el" href="group__caca__importexport.html#ga4455d225b91573e265211e5c41553a37">caca_import_area_from_memory()</a>, and <a class="el" href="group__libcaca.html#ga685374ff836369f58a5c32a414096f2e">caca_rand()</a>.</p>
</div>
</div>
<a class="anchor" id="ga685374ff836369f58a5c32a414096f2e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern int caca_rand </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>min</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>max</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate a random integer within the given range.</p>
<p>This function never fails.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">min</td><td>The lower bound of the integer range. </td></tr>
<tr><td class="paramname">max</td><td>The upper bound of the integer range. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A random integer comprised between <code>min</code> and <code>max</code> - 1 (inclusive). </dd></dl>
<p>References <a class="el" href="group__caca__dirty.html#ga97855769d4e2742d6e52c0466e88fe11">caca_add_dirty_rect()</a>, <a class="el" href="group__libcaca.html#ga00caafb33b9d7033d064a642bcad83da">caca_create_canvas()</a>, <a class="el" href="group__libcaca.html#ga12394c16c9ca94b61198be929ef8580d">caca_free_canvas()</a>, <a class="el" href="group__libcaca.html#ga6d451ebbe4f6af86851f1f2abefabbd4">caca_get_canvas_attrs()</a>, <a class="el" href="group__libcaca.html#ga7112bdf128f94eeae9d66fbc49f96d81">caca_get_canvas_chars()</a>, <a class="el" href="group__libcaca.html#gaa529140e8cf31379a6b57af7c37c9d2f">caca_get_canvas_height()</a>, <a class="el" href="group__libcaca.html#gad85b2ff4c7f952b3cc32f117343a6375">caca_get_canvas_width()</a>, <a class="el" href="group__libcaca.html#gab5f079a934949a06c100b0db604d697e">caca_manage_canvas()</a>, <a class="el" href="group__libcaca.html#ga8814d2faa76cad0d7d15381b7eeacab6">caca_set_canvas_size()</a>, and <a class="el" href="group__libcaca.html#ga9a793c6b42c90884e650fa03f4640b17">caca_unmanage_canvas()</a>.</p>
<p>Referenced by <a class="el" href="group__caca__dither.html#ga5b23aea21bcbbcec02e45383721a00f6">caca_free_dither()</a>.</p>
</div>
</div>
<a class="anchor" id="ga3c7edc520b7ea69a721317a9d8649440"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern char const* caca_get_version </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a read-only string with the <em>libcaca</em> version information.</p>
<p>This function never fails.</p>
<dl class="section return"><dt>Returns</dt><dd>The <em>libcaca</em> version information. </dd></dl>
<p>References <a class="el" href="caca_8h.html#a40754185ca237fc44a95357afba34aeaaaa0b1e20607444a2233e28758897f512">CACA_EVENT_NONE</a>, <a class="el" href="group__libcaca.html#gaa529140e8cf31379a6b57af7c37c9d2f">caca_get_canvas_height()</a>, <a class="el" href="group__libcaca.html#gad85b2ff4c7f952b3cc32f117343a6375">caca_get_canvas_width()</a>, and <a class="el" href="group__libcaca.html#ga3c7edc520b7ea69a721317a9d8649440">caca_get_version()</a>.</p>
<p>Referenced by <a class="el" href="group__caca__importexport.html#ga264bcf9f821d67f33bd5ee5aa5e048a0">caca_get_export_list()</a>, and <a class="el" href="group__libcaca.html#ga3c7edc520b7ea69a721317a9d8649440">caca_get_version()</a>.</p>
</div>
</div>
</div><!-- contents -->
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-release
>
by-pkgid
>
2a9a0500ba8dfb95025148f22d49b751
>
files
>
68
