| Current Path : /usr/share/doc/libcaca-dev/html/ |
Linux ift1.ift-informatik.de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 |
| Current File : //usr/share/doc/libcaca-dev/html/libcaca-tutorial.html |
<!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.17 -->
</div><!-- top -->
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">A libcaca tutorial </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>First, a very simple working program, to check for basic libcaca functionalities.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include <<a class="code" href="caca_8h.html">caca.h</a>></span></div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">void</span>)</div>
<div class="line">{</div>
<div class="line"> <a class="code" href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a> *cv; <a class="code" href="caca_8h.html#ada5af7a20f3e2f6c103078181b07393e">caca_display_t</a> *dp; <a class="code" href="structcaca__event.html">caca_event_t</a> ev;</div>
<div class="line"> </div>
<div class="line"> dp = <a class="code" href="group__caca__display.html#gac393d4446d813f6e4ba93d2b583c1edb">caca_create_display</a>(NULL);</div>
<div class="line"> <span class="keywordflow">if</span>(!dp) <span class="keywordflow">return</span> 1;</div>
<div class="line"> cv = <a class="code" href="group__caca__display.html#ga65670cdec61ba57879b893c997cd26da">caca_get_canvas</a>(dp);</div>
<div class="line"> </div>
<div class="line"> <a class="code" href="group__caca__display.html#gadab2bf1e8d0bf5c3cfb3e29ab07d5641">caca_set_display_title</a>(dp, <span class="stringliteral">"Hello!"</span>);</div>
<div class="line"> <a class="code" href="group__caca__attributes.html#ga1cd39df80cc6b537a4df18415a8605cf">caca_set_color_ansi</a>(cv, <a class="code" href="group__caca__attr.html#gga9db83488c6f07a5f7d773c380b3126a9a9280adda765037612d94743bdc3f346d">CACA_BLACK</a>, <a class="code" href="group__caca__attr.html#gga9db83488c6f07a5f7d773c380b3126a9a1bd1244f952d10b9599fb314e41862ad">CACA_WHITE</a>);</div>
<div class="line"> <a class="code" href="group__caca__canvas.html#gac9370c0854f358b88d0cb8caf07fb6d3">caca_put_str</a>(cv, 0, 0, <span class="stringliteral">"This is a message"</span>);</div>
<div class="line"> <a class="code" href="group__caca__display.html#ga8c710eac721d05d807491a1534d1cbe7">caca_refresh_display</a>(dp);</div>
<div class="line"> <a class="code" href="group__caca__event.html#ga98e74dedbe1629c0fc9460761696e050">caca_get_event</a>(dp, <a class="code" href="group__caca__attr.html#gga40754185ca237fc44a95357afba34aeaab1da825755a2ac3593cca73721b77e22">CACA_EVENT_KEY_PRESS</a>, &ev, -1);</div>
<div class="line"> <a class="code" href="group__caca__display.html#gac1b5b4540a500dd59eaa673d784fab1f">caca_free_display</a>(dp);</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
</div><!-- fragment --><p>What does it do?</p><ul>
<li>Create a display. Physically, the display is either a window or a context in a terminal (ncurses, slang) or even the whole screen (VGA).</li>
<li>Get the display's associated canvas. A canvas is the surface where everything happens: writing characters, sprites, strings, images... It is unavoidable. Here the size of the canvas is set by the display.</li>
<li>Set the display's window name (only available in windowed displays, does nothing otherwise).</li>
<li>Set the current canvas colours to black background and white foreground.</li>
<li>Write the string <code>"This is a message"</code> onto the canvas, using the current colour pair.</li>
<li>Refresh the display, causing the text to be effectively displayed.</li>
<li>Wait for an event of type <code>CACA_EVENT_KEY_PRESS</code>.</li>
<li>Free the display (release memory). Since it was created together with the display, the canvas will be automatically freed as well.</li>
</ul>
<p>You can then compile this code on an UNIX-like system using the following commans (requiring <code>pkg-config</code> and <code>gcc</code>): </p><div class="fragment"><div class="line">gcc `pkg-config --libs --cflags caca` example.c -o example</div>
</div><!-- fragment --> </div></div><!-- contents -->
</div><!-- PageDoc -->
<div class="ttc" id="agroup__caca__display_html_gac393d4446d813f6e4ba93d2b583c1edb"><div class="ttname"><a href="group__caca__display.html#gac393d4446d813f6e4ba93d2b583c1edb">caca_create_display</a></div><div class="ttdeci">caca_display_t * caca_create_display(caca_canvas_t *cv)</div><div class="ttdoc">Attach a caca graphical context to a caca canvas.</div><div class="ttdef"><b>Definition:</b> caca/caca.c:68</div></div>
<div class="ttc" id="agroup__caca__attributes_html_ga1cd39df80cc6b537a4df18415a8605cf"><div class="ttname"><a href="group__caca__attributes.html#ga1cd39df80cc6b537a4df18415a8605cf">caca_set_color_ansi</a></div><div class="ttdeci">int caca_set_color_ansi(caca_canvas_t *cv, uint8_t fg, uint8_t bg)</div><div class="ttdoc">Set the default colour pair for text (ANSI version).</div><div class="ttdef"><b>Definition:</b> attr.c:234</div></div>
<div class="ttc" id="astructcaca__event_html"><div class="ttname"><a href="structcaca__event.html">caca_event</a></div><div class="ttdoc">Handling of user events.</div><div class="ttdef"><b>Definition:</b> caca.h:129</div></div>
<div class="ttc" id="agroup__caca__display_html_ga65670cdec61ba57879b893c997cd26da"><div class="ttname"><a href="group__caca__display.html#ga65670cdec61ba57879b893c997cd26da">caca_get_canvas</a></div><div class="ttdeci">caca_canvas_t * caca_get_canvas(caca_display_t *dp)</div><div class="ttdoc">Get the canvas attached to a caca graphical context.</div><div class="ttdef"><b>Definition:</b> caca/caca.c:259</div></div>
<div class="ttc" id="agroup__caca__display_html_ga8c710eac721d05d807491a1534d1cbe7"><div class="ttname"><a href="group__caca__display.html#ga8c710eac721d05d807491a1534d1cbe7">caca_refresh_display</a></div><div class="ttdeci">__extern int caca_refresh_display(caca_display_t *)</div><div class="ttdoc">Flush pending changes and redraw the screen.</div><div class="ttdef"><b>Definition:</b> graphics.c:146</div></div>
<div class="ttc" id="agroup__caca__display_html_gac1b5b4540a500dd59eaa673d784fab1f"><div class="ttname"><a href="group__caca__display.html#gac1b5b4540a500dd59eaa673d784fab1f">caca_free_display</a></div><div class="ttdeci">int caca_free_display(caca_display_t *dp)</div><div class="ttdoc">Detach a caca graphical context from a caca backend context.</div><div class="ttdef"><b>Definition:</b> caca/caca.c:238</div></div>
<div class="ttc" id="agroup__caca__attr_html_gga40754185ca237fc44a95357afba34aeaab1da825755a2ac3593cca73721b77e22"><div class="ttname"><a href="group__caca__attr.html#gga40754185ca237fc44a95357afba34aeaab1da825755a2ac3593cca73721b77e22">CACA_EVENT_KEY_PRESS</a></div><div class="ttdeci">@ CACA_EVENT_KEY_PRESS</div><div class="ttdef"><b>Definition:</b> caca.h:111</div></div>
<div class="ttc" id="agroup__caca__attr_html_gga9db83488c6f07a5f7d773c380b3126a9a1bd1244f952d10b9599fb314e41862ad"><div class="ttname"><a href="group__caca__attr.html#gga9db83488c6f07a5f7d773c380b3126a9a1bd1244f952d10b9599fb314e41862ad">CACA_WHITE</a></div><div class="ttdeci">@ CACA_WHITE</div><div class="ttdef"><b>Definition:</b> caca.h:86</div></div>
<div class="ttc" id="acaca_8h_html_aae0f6938d08e6e0abbcd5a8c06504ab8"><div class="ttname"><a href="caca_8h.html#aae0f6938d08e6e0abbcd5a8c06504ab8">caca_canvas_t</a></div><div class="ttdeci">struct caca_canvas caca_canvas_t</div><div class="ttdef"><b>Definition:</b> caca.h:49</div></div>
<div class="ttc" id="agroup__caca__event_html_ga98e74dedbe1629c0fc9460761696e050"><div class="ttname"><a href="group__caca__event.html#ga98e74dedbe1629c0fc9460761696e050">caca_get_event</a></div><div class="ttdeci">__extern int caca_get_event(caca_display_t *, int, caca_event_t *, int)</div><div class="ttdoc">Get the next mouse or keyboard input event.</div><div class="ttdef"><b>Definition:</b> event.c:63</div></div>
<div class="ttc" id="agroup__caca__canvas_html_gac9370c0854f358b88d0cb8caf07fb6d3"><div class="ttname"><a href="group__caca__canvas.html#gac9370c0854f358b88d0cb8caf07fb6d3">caca_put_str</a></div><div class="ttdeci">__extern int caca_put_str(caca_canvas_t *, int, int, char const *)</div><div class="ttdoc">Print a string.</div><div class="ttdef"><b>Definition:</b> string.c:254</div></div>
<div class="ttc" id="acaca_8h_html_ada5af7a20f3e2f6c103078181b07393e"><div class="ttname"><a href="caca_8h.html#ada5af7a20f3e2f6c103078181b07393e">caca_display_t</a></div><div class="ttdeci">struct caca_display caca_display_t</div><div class="ttdef"><b>Definition:</b> caca.h:59</div></div>
<div class="ttc" id="agroup__caca__attr_html_gga9db83488c6f07a5f7d773c380b3126a9a9280adda765037612d94743bdc3f346d"><div class="ttname"><a href="group__caca__attr.html#gga9db83488c6f07a5f7d773c380b3126a9a9280adda765037612d94743bdc3f346d">CACA_BLACK</a></div><div class="ttdeci">@ CACA_BLACK</div><div class="ttdef"><b>Definition:</b> caca.h:71</div></div>
<div class="ttc" id="acaca_8h_html"><div class="ttname"><a href="caca_8h.html">caca.h</a></div><div class="ttdoc">The libcaca public header.</div></div>
<div class="ttc" id="agroup__caca__display_html_gadab2bf1e8d0bf5c3cfb3e29ab07d5641"><div class="ttname"><a href="group__caca__display.html#gadab2bf1e8d0bf5c3cfb3e29ab07d5641">caca_set_display_title</a></div><div class="ttdeci">__extern int caca_set_display_title(caca_display_t *, char const *)</div><div class="ttdoc">Set the display title.</div><div class="ttdef"><b>Definition:</b> graphics.c:40</div></div>
</body>
</html>