source: libcaca/trunk/doc/migrating.dox @ 848

Last change on this file since 848 was 848, checked in by Sam Hocevar, 14 years ago
  • Minor updates to the migration documentation.
  • Property svn:keywords set to Id
File size: 6.3 KB
Line 
1/* $Id: migrating.dox 848 2006-04-22 19:35:43Z sam $ */
2
3/** \page migrating Migrating from libcaca 0.x to the 1.0 API
4
5 This section will guide you through the migration of a \e libcaca 0.x
6 application to the latest API version.
7
8 \section foo1 Overview
9
10 The most important changes in the 1.0 API of \e libcaca are the
11 \e libcaca / \e libcucul split and the object-oriented design. See these
12 two examples for a rough idea of what changed:
13
14<table border="0"><tr><td valign="top">
15\code
16#include <caca.h>
17
18/* libcaca program - 0.x API */
19int main(void)
20{
21    /* Initialise libcaca */
22    caca_init();
23    /* Set window title */
24    caca_set_window_title("Window");
25    /* Choose drawing colours */
26    caca_set_color(CACA_COLOR_BLACK,
27                   CACA_COLOR_WHITE);
28    /* Draw a string at (0, 0) */
29    caca_putstr(0, 0, "Hello world!");
30    /* Refresh display */
31    caca_refresh();
32    /* Wait for a key press event */
33    caca_wait_event(CACA_EVENT_KEY_PRESS);
34    /* Clean up library */
35    caca_end();
36
37    return 0;
38}
39\endcode
40</td><td>
41\code
42#include <cucul.h>
43#include <caca.h>
44
45/* libcaca program - 1.0 API */
46int main(void)
47{
48    /* Initialise libcaca */
49    cucul_canvas_t *cv;
50    caca_display_t *dp; caca_event_t ev;
51    cv = cucul_create_canvas(0, 0);
52    dp = caca_create_display(cv);
53    /* Set window title */
54    caca_set_display_title(dp, "Window");
55    /* Choose drawing colours */
56    cucul_set_color(cv, CUCUL_COLOR_BLACK,
57                        CUCUL_COLOR_WHITE);
58    /* Draw a string at (0, 0) */
59    cucul_putstr(cv, 0, 0, "Hello world!");
60    /* Refresh display */
61    caca_refresh_display();
62    /* Wait for a key press event */
63    caca_get_event(dp, CACA_EVENT_KEY_PRESS,
64                   &ev, -1);
65    /* Clean up library */
66    caca_free_display(dp);
67    cucul_free_canvas(cv);
68
69    return 0;
70}
71\endcode
72</td></tr></table>
73
74 Note the following important things:
75
76 - Functions now take an object handle as their first argument.
77 - All input/output functions start with \b caca_ and all
78   drawing and text handling functions start with \b cucul_ .
79
80 \section foo2 Function equivalence list
81
82 \subsection bar1 Basic functions
83
84 - \b caca_init(): use cucul_create_canvas() to create a \e libcucul canvas,
85   followed by caca_create_display() to attach a \e libcaca display to it.
86 - \b caca_set_delay(): unchanged.
87 - \b caca_get_feature(): deprecated.
88 - \b caca_set_feature(): deprecated, see cucul_set_dither_antialias(),
89   cucul_set_dither_color() and cucul_set_dither_mode() instead.
90 - \b caca_get_feature_name(): deprecated, see cucul_get_dither_mode_list(),
91   cucul_get_dither_antialias_list() and cucul_get_dither_color_list()
92   instead.
93 - \b caca_get_rendertime(): unchanged.
94 - \b caca_get_width(): use cucul_get_canvas_width().
95 - \b caca_get_height(): use cucul_get_canvas_height().
96 - \b caca_set_window_title(): use caca_set_display_title().
97 - \b caca_get_window_width(): use caca_get_display_width().
98 - \b caca_get_window_height(): use caca_get_display_height().
99 - \b caca_refresh(): use caca_refresh_display().
100 - \b caca_end(): use caca_free_display() to detach the \e libcaca display,
101   followed by cucul_free_canvas() to free the underlying \e libcucul canvas.
102
103 \subsection bar2 Event handling
104
105 - \b caca_get_event(): unchanged, but the event information retrieval
106   changed a lot.
107 - \b caca_wait_event(): use caca_get_event() with a \c timeout argument
108   of \b -1.
109 - \b caca_get_mouse_x(): unchanged.
110 - \b caca_get_mouse_y(): unchanged.
111
112 \subsection bar3 Character printing
113
114 - \b caca_set_color(): use cucul_set_color() or cucul_set_truecolor().
115 - \b caca_get_fg_color(): deprecated.
116 - \b caca_get_bg_color(): deprecated.
117 - \b caca_get_color_name(): use cucul_get_color_name().
118 - \b caca_putchar(): use cucul_putchar().
119 - \b caca_putstr(): use cucul_putstr().
120 - \b caca_printf(): use cucul_printf().
121 - \b caca_clear(): use cucul_clear_canvas().
122
123 \subsection bar4 Primitives drawing
124
125 These functions are almost unchanged, except for Unicode support and the
126 fact that they now act on a given canvas.
127
128 - \b caca_draw_line(): use cucul_draw_line().
129 - \b caca_draw_polyline(): use cucul_draw_polyline().
130 - \b caca_draw_thin_line(): use cucul_draw_thin_line().
131 - \b caca_draw_thin_polyline(): use cucul_draw_thin_polyline().
132
133 - \b caca_draw_circle(): use cucul_draw_circle().
134 - \b caca_draw_ellipse(): use cucul_draw_ellipse().
135 - \b caca_draw_thin_ellipse(): use cucul_draw_thin_ellipse().
136 - \b caca_fill_ellipse(): use cucul_fill_ellipse().
137
138 - \b caca_draw_box(): use cucul_draw_box().
139 - \b caca_draw_thin_box(): use cucul_draw_thin_box().
140 - \b caca_fill_box(): use cucul_fill_box().
141
142 - \b caca_draw_triangle(): use cucul_draw_triangle().
143 - \b caca_draw_thin_triangle(): use cucul_draw_thin_triangle().
144 - \b caca_fill_triangle(): use cucul_fill_triangle().
145
146 \subsection bar5 Mathematical functions
147
148 - \b caca_rand(): use cucul_rand(). The second argument is different, make
149   sure you take that into account.
150 - \b caca_sqrt(): this function is now deprecated, use your system's
151   \b sqrt() call instead.
152
153 \subsection bar6 Sprite handling
154
155 The newly introduced canvases can have several frames. Sprites are hence
156 completely deprecated.
157
158 - \b caca_load_sprite(): use cucul_import_canvas().
159 - \b caca_get_sprite_frames(): use cucul_get_canvas_frame_count().
160 - \b caca_get_sprite_width(): use cucul_get_canvas_width().
161 - \b caca_get_sprite_height(): use cucul_get_canvas_height().
162 - \b caca_get_sprite_dx(): this function is now deprecated.
163 - \b caca_get_sprite_dy(): this function is now deprecated.
164 - \b caca_draw_sprite(): use cucul_set_canvas_frame() and cucul_blit().
165 - \b caca_free_sprite(): use cucul_free_canvas().
166
167 \subsection bar7 Bitmap handling
168
169 Bitmaps have been renamed to dithers, because these objects do not in fact
170 store any pixels, they just have information on how bitmaps will be dithered.
171
172 - \b caca_create_bitmap(): use cucul_create_dither().
173 - \b caca_set_bitmap_palette(): use cucul_set_dither_palette().
174 - \b caca_draw_bitmap(): use cucul_dither_bitmap().
175 - \b caca_free_bitmap(): use cucul_free_dither().
176
177 \section foo3 Compilation
178
179 The \c caca-config utility is deprecated in favour of the standard
180 \c pkg-config interface:
181
182\code
183gcc -c foobar.c -o foobar.o `pkg-config --cflags caca`
184gcc foobar.o -o foobar `pkg-config --libs caca`
185\endcode
186
187 \c caca-config is still provided as a convenience tool but will be removed
188 in the future.
189
190*/
Note: See TracBrowser for help on using the repository browser.