Changeset 1279


Ignore:
Timestamp:
Nov 5, 2006, 7:14:26 PM (13 years ago)
Author:
Jean-Yves Lamoureux
Message:
  • Started a real and complete tutorial
File:
1 edited

Legend:

Unmodified
Added
Removed
  • libcaca/trunk/doc/tutorial.dox

    r1269 r1279  
    33/** \page tutorial A libcucul and libcaca tutorial
    44
    5  Super short example:
     5 Before writing your first libcaca application, you need to know the difference between libcucul and libcaca :
     6- libcucul is the text rendering library. It will do all the work you actually need. From imports (text, ANSI, caca internal format, all of this supporting n-bytes unicode), to exports (sames formats, adding SVG, PostScript, TGA, HTML (both 3 and 4), IRC), it'll cover all your needs.
     7- libcaca handle everything that can be hardware related. It includes display (RAW, X11, OpenGL, Windows (GDI), conio (DOS), ncurses, slang, text VGA (IMB-Compatible)), keyboard (same drivers but RAW), mouse (same drivers but RAW and VGA), time and resize events (on windowed drivers).
     8
     9So, you can write a libcucul only program, but you <b>can't</b> write a libcaca only program, it'll be nonsense. Period.
     10
     11
     12First, a working program, very simple, to check you can compile and run it :
    613
    714\code
     15
    816#include <cucul.h>
    917#include <caca.h>
     
    1826    caca_set_display_title(dp, "Hello!");
    1927    /* Choose drawing colours */
    20     cucul_set_color_ansi(cv, CUCUL_BLACK, CUCUL_WHITE);
     28    cucul_set_color(cv, CUCUL_COLOR_BLACK, CUCUL_COLOR_WHITE);
    2129    /* Draw a string at coordinates (0, 0) */
    2230    cucul_putstr(cv, 0, 0, "This is a message");
     
    3139    return 0;
    3240}
     41
    3342\endcode
    3443
     44
     45What does it do ? (we skip variable definitions, guessing you have a brain) :
     46- Create a cucul canvas. A canvas is where everything happens. Writing characters, sprites, strings, images, everything. It is mandatory and is the reason for libcuculs' beeing. Size is there a width of 0 pixels, and a height of 0 pixels. It'll be resized according to contents you put in it.
     47
     48- Create a caca display. This is basically the window. Physically it can be a window (most of the displays), a console (ncurses, slang) or a real display (VGA).
     49
     50- Set the window name of our display (only available in windowed displays, does nothing otherwise). (so this is libcaca related)
     51 
     52- Set current colors to black background, and white foreground of our canvas (so this is libcucul related)
     53
     54- Put a string "This is a message" with current colors in our libcucul canvas.
     55
     56- Refresh our caca display, whish was firstly attached to our canvas
     57
     58- Wait for an event of type "CACA_EVENT_KEY_PRESS", which seems obvious.
     59
     60- Free display (release memory)
     61
     62- Free canvas (release memory and close window if any)
     63
     64
    3565*/
Note: See TracChangeset for help on using the changeset viewer.