source: libcaca/trunk/src/caca.h @ 495

Last change on this file since 495 was 495, checked in by Jean-Yves Lamoureux, 17 years ago
  • src/math.c src/bitmap.c src/caca.h Removed powf call, added caca_powf, to remove libm depencies and problems on old compilers/linkers.
  • Property svn:keywords set to Id
File size: 13.9 KB
Line 
1/*
2 *  libcaca       ASCII-Art library
3 *  Copyright (c) 2002, 2003 Sam Hocevar <sam@zoy.org>
4 *                All Rights Reserved
5 *
6 *  This library is free software; you can redistribute it and/or
7 *  modify it under the terms of the GNU Lesser General Public
8 *  License as published by the Free Software Foundation; either
9 *  version 2 of the License, or (at your option) any later version.
10 *
11 *  This library is distributed in the hope that it will be useful,
12 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 *  Lesser General Public License for more details.
15 *
16 *  You should have received a copy of the GNU Lesser General Public
17 *  License along with this library; if not, write to the Free Software
18 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19 *  02111-1307  USA
20 */
21
22/** \file caca.h
23 *  \version \$Id: caca.h 495 2005-07-13 17:45:47Z jylam $
24 *  \author Sam Hocevar <sam@zoy.org>
25 *  \brief The \e libcaca public header.
26 *
27 *  This header contains the public types and functions that applications
28 *  using \e libcaca may use.
29 */
30
31/** \mainpage libcaca developer documentation
32 *
33 *  \section intro Introduction
34 *
35 *  \e libcaca is a graphics library that outputs text instead of pixels,
36 *  so that it can work on older video cards or text terminals. It is not
37 *  unlike the famous AAlib library. \e libcaca can use almost any virtual
38 *  terminal to work, thus it should work on all Unix systems (including
39 *  Mac OS X) using either the slang library or the ncurses library, on DOS
40 *  using the conio library, and on Windows systems using either slang or
41 *  ncurses (through Cygwin emulation) or conio. There is also a native X11
42 *  driver, and an OpenGL driver (through freeglut) that does not require a
43 *  text terminal.
44 *
45 *  \e libcaca is free software, released under the GNU Lesser General
46 *  Public License. This ensures that \e libcaca will always remain free
47 *  software.
48 *
49 *  \section api The libcaca API
50 *
51 *  The complete \e libcaca programming interface is available from the
52 *  caca.h header.
53 *
54 *  \section env Environment variables
55 *
56 *  Some environment variables can be used to change the behaviour of
57 *  \e libcaca without having to modify the program which uses it. These
58 *  variables are:
59 *
60 *  \li \b CACA_DRIVER: set the backend video driver. In order of preference:
61 *      - \c conio uses the DOS conio.h interface.
62 *      - \c ncurses uses the ncurses library.
63 *      - \c slang uses the S-Lang library.
64 *      - \c x11 uses the native X11 driver.
65 *      - \c gl uses freeglut and opengl libraries.
66 *      - \c null uses nothing at all, and will display nothing as well.
67 *
68 *  \li \b CACA_GEOMETRY: set the video display size. The format of this
69 *      variable must be XxY, with X and Y being integer values. This option
70 *      currently only works with the X11 and the GL driver.
71 *
72 *  \li \b CACA_FONT: set the rendered font. The format of this variable is
73 *      implementation dependent, but since it currently only works with the
74 *      X11 driver, an X11 font name such as "fixed" or "5x7" is expected.
75 *
76 *  \li \b CACA_BACKGROUND: set the background type.
77 *      - \c solid uses solid coloured backgrounds for all characters. This
78 *        feature does not work with all terminal emulators. This is the
79 *        default choice.
80 *      - \c black uses only black backgrounds to render characters.
81 *
82 *  \li \b CACA_ANTIALIASING: set the antialiasing mode. Antialiasing
83 *      smoothens the rendered image and avoids the commonly seen staircase
84 *      effect.
85 *      - \c none disables antialiasing.
86 *      - \c prefilter uses a simple prefilter antialiasing method. This is
87 *        the default choice.
88 *
89 *  \li \b CACA_DITHERING: set the dithering mode. Dithering is necessary
90 *      when rendering a picture that has more colours than the usually
91 *      available palette.
92 *      - \c none disables dithering.
93 *      - \c ordered2 uses a 2x2 Bayer matrix for dithering.
94 *      - \c ordered4 uses a 4x4 Bayer matrix for dithering. This is the
95 *        default choice.
96 *      - \c ordered8 uses a 8x8 Bayer matrix for dithering.
97 *      - \c random uses random dithering.
98 */
99
100#ifndef __CACA_H__
101#define __CACA_H__
102
103#ifdef __cplusplus
104extern "C"
105{
106#endif
107
108/** \brief Colour definitions.
109 *
110 *  Colours that can be used with caca_set_color().
111 */
112enum caca_color
113{
114    CACA_COLOR_BLACK = 0, /**< The colour index for black. */
115    CACA_COLOR_BLUE = 1, /**< The colour index for blue. */
116    CACA_COLOR_GREEN = 2, /**< The colour index for green. */
117    CACA_COLOR_CYAN = 3, /**< The colour index for cyan. */
118    CACA_COLOR_RED = 4, /**< The colour index for red. */
119    CACA_COLOR_MAGENTA = 5, /**< The colour index for magenta. */
120    CACA_COLOR_BROWN = 6, /**< The colour index for brown. */
121    CACA_COLOR_LIGHTGRAY = 7, /**< The colour index for light gray. */
122    CACA_COLOR_DARKGRAY = 8, /**< The colour index for dark gray. */
123    CACA_COLOR_LIGHTBLUE = 9, /**< The colour index for blue. */
124    CACA_COLOR_LIGHTGREEN = 10, /**< The colour index for light green. */
125    CACA_COLOR_LIGHTCYAN = 11, /**< The colour index for light cyan. */
126    CACA_COLOR_LIGHTRED = 12, /**< The colour index for light red. */
127    CACA_COLOR_LIGHTMAGENTA = 13, /**< The colour index for light magenta. */
128    CACA_COLOR_YELLOW = 14, /**< The colour index for yellow. */
129    CACA_COLOR_WHITE = 15 /**< The colour index for white. */
130};
131
132/** \brief Internal features.
133 *
134 *  Internal libcaca features such as the rendering method or the dithering
135 *  mode.
136 */
137enum caca_feature
138{
139    CACA_BACKGROUND       = 0x10, /**< Properties of background characters. */
140    CACA_BACKGROUND_BLACK = 0x11, /**< Draw only black backgrounds. */
141    CACA_BACKGROUND_SOLID = 0x12, /**< Draw coloured solid backgorunds. */
142#define CACA_BACKGROUND_MIN 0x11 /**< First background property */
143#define CACA_BACKGROUND_MAX 0x12 /**< Last background property */
144
145    CACA_ANTIALIASING           = 0x20, /**< Antialiasing features. */
146    CACA_ANTIALIASING_NONE      = 0x21, /**< No antialiasing. */
147    CACA_ANTIALIASING_PREFILTER = 0x22, /**< Prefilter antialiasing. */
148#define CACA_ANTIALIASING_MIN     0x21 /**< First antialiasing feature. */
149#define CACA_ANTIALIASING_MAX     0x22 /**< Last antialiasing feature. */
150
151    CACA_DITHERING          = 0x30, /**< Dithering methods */
152    CACA_DITHERING_NONE     = 0x31, /**< No dithering. */
153    CACA_DITHERING_ORDERED2 = 0x32, /**< Ordered 2x2 Bayer dithering. */
154    CACA_DITHERING_ORDERED4 = 0x33, /**< Ordered 4x4 Bayer dithering. */
155    CACA_DITHERING_ORDERED8 = 0x34, /**< Ordered 8x8 Bayer dithering. */
156    CACA_DITHERING_RANDOM   = 0x35, /**< Random dithering. */
157    CACA_DITHERING_FSTEIN   = 0x36, /**< Floyd-Steinberg dithering. */
158#define CACA_DITHERING_MIN    0x31 /**< First dithering feature. */
159#define CACA_DITHERING_MAX    0x36 /**< Last dithering feature. */
160
161    CACA_FEATURE_UNKNOWN = 0xffff /**< Unknown feature. */
162};
163
164/*
165 * Backwards compatibility macros
166 */
167#if !defined(_DOXYGEN_SKIP_ME)
168#define caca_dithering caca_feature
169#define caca_set_dithering caca_set_feature
170#define caca_get_dithering_name caca_get_feature_name
171#define CACA_DITHER_NONE    CACA_DITHERING_NONE
172#define CACA_DITHER_ORDERED CACA_DITHERING_ORDERED8
173#define CACA_DITHER_RANDOM  CACA_DITHERING_RANDOM
174#endif
175
176/** \brief User events.
177 *
178 *  Event types returned by caca_get_event().
179 */
180enum caca_event
181{
182    CACA_EVENT_NONE =          0x00000000, /**< No event. */
183    CACA_EVENT_KEY_PRESS =     0x01000000, /**< A key was pressed. */
184    CACA_EVENT_KEY_RELEASE =   0x02000000, /**< A key was released. */
185    CACA_EVENT_MOUSE_PRESS =   0x04000000, /**< A mouse button was pressed. */
186    CACA_EVENT_MOUSE_RELEASE = 0x08000000, /**< A mouse button was released. */
187    CACA_EVENT_MOUSE_MOTION =  0x10000000, /**< The mouse was moved. */
188    CACA_EVENT_RESIZE =        0x20000000, /**< The window was resized. */
189    CACA_EVENT_ANY =           0xff000000  /**< Bitmask for any event. */
190};
191
192/** \brief Special key values.
193 *
194 *  Special key values returned by caca_get_event() for which there is no
195 *  ASCII equivalent.
196 */
197enum caca_key
198{
199    CACA_KEY_UNKNOWN = 0, /**< Unknown key. */
200
201    /* The following keys have ASCII equivalents */
202    CACA_KEY_BACKSPACE = 8, /**< The backspace key. */
203    CACA_KEY_TAB = 9, /**< The tabulation key. */
204    CACA_KEY_RETURN = 13, /**< The return key. */
205    CACA_KEY_PAUSE = 19, /**< The pause key. */
206    CACA_KEY_ESCAPE = 27, /**< The escape key. */
207    CACA_KEY_DELETE = 127, /**< The delete key. */
208
209    /* The following keys do not have ASCII equivalents but have been
210     * chosen to match the SDL equivalents */
211    CACA_KEY_UP = 273, /**< The up arrow key. */
212    CACA_KEY_DOWN = 274, /**< The down arrow key. */
213    CACA_KEY_LEFT = 275, /**< The left arrow key. */
214    CACA_KEY_RIGHT = 276, /**< The right arrow key. */
215
216    CACA_KEY_INSERT = 277, /**< The insert key. */
217    CACA_KEY_HOME = 278, /**< The home key. */
218    CACA_KEY_END = 279, /**< The end key. */
219    CACA_KEY_PAGEUP = 280, /**< The page up key. */
220    CACA_KEY_PAGEDOWN = 281, /**< The page down key. */
221
222    CACA_KEY_F1 = 282, /**< The F1 key. */
223    CACA_KEY_F2 = 283, /**< The F2 key. */
224    CACA_KEY_F3 = 284, /**< The F3 key. */
225    CACA_KEY_F4 = 285, /**< The F4 key. */
226    CACA_KEY_F5 = 286, /**< The F5 key. */
227    CACA_KEY_F6 = 287, /**< The F6 key. */
228    CACA_KEY_F7 = 288, /**< The F7 key. */
229    CACA_KEY_F8 = 289, /**< The F8 key. */
230    CACA_KEY_F9 = 290, /**< The F9 key. */
231    CACA_KEY_F10 = 291, /**< The F10 key. */
232    CACA_KEY_F11 = 292, /**< The F11 key. */
233    CACA_KEY_F12 = 293, /**< The F12 key. */
234    CACA_KEY_F13 = 294, /**< The F13 key. */
235    CACA_KEY_F14 = 295, /**< The F14 key. */
236    CACA_KEY_F15 = 296 /**< The F15 key. */
237};
238
239/** \defgroup basic Basic functions
240 *
241 *  These functions provide the basic \e libcaca routines for library
242 *  initialisation, system information retrieval and configuration.
243 *
244 *  @{ */
245int caca_init(void);
246void caca_set_delay(unsigned int);
247enum caca_feature caca_get_feature(enum caca_feature);
248void caca_set_feature(enum caca_feature);
249char const *caca_get_feature_name(enum caca_feature);
250unsigned int caca_get_rendertime(void);
251unsigned int caca_get_width(void);
252unsigned int caca_get_height(void);
253int caca_set_window_title(char const *);
254unsigned int caca_get_window_width(void);
255unsigned int caca_get_window_height(void);
256void caca_refresh(void);
257void caca_end(void);
258/*  @} */
259
260/** \defgroup event Event handling
261 *
262 *  These functions handle user events such as keyboard input and mouse
263 *  clicks.
264 *
265 *  @{ */
266unsigned int caca_get_event(unsigned int);
267unsigned int caca_wait_event(unsigned int);
268unsigned int caca_get_mouse_x(void);
269unsigned int caca_get_mouse_y(void);
270/*  @} */
271
272/** \defgroup char Character printing
273 *
274 *  These functions provide low-level character printing routines.
275 *
276 *  @{ */
277void caca_set_color(enum caca_color, enum caca_color);
278enum caca_color caca_get_fg_color(void);
279enum caca_color caca_get_bg_color(void);
280char const *caca_get_color_name(enum caca_color);
281void caca_putchar(int, int, char);
282void caca_putstr(int, int, char const *);
283void caca_printf(int, int, char const *, ...);
284void caca_get_screen(char *);
285void caca_clear(void);
286/*  @} */
287
288/** \defgroup prim Primitives drawing
289 *
290 *  These functions provide routines for primitive drawing, such as lines,
291 *  boxes, triangles and ellipses.
292 *
293 *  @{ */
294void caca_draw_line(int, int, int, int, char);
295void caca_draw_polyline(int const x[], int const y[], int, char);
296void caca_draw_thin_line(int, int, int, int);
297void caca_draw_thin_polyline(int const x[], int const y[], int);
298
299void caca_draw_circle(int, int, int, char);
300void caca_draw_ellipse(int, int, int, int, char);
301void caca_draw_thin_ellipse(int, int, int, int);
302void caca_fill_ellipse(int, int, int, int, char);
303
304void caca_draw_box(int, int, int, int, char);
305void caca_draw_thin_box(int, int, int, int);
306void caca_fill_box(int, int, int, int, char);
307
308void caca_draw_triangle(int, int, int, int, int, int, char);
309void caca_draw_thin_triangle(int, int, int, int, int, int);
310void caca_fill_triangle(int, int, int, int, int, int, char);
311/*  @} */
312
313/** \defgroup math Mathematical functions
314 *
315 *  These functions provide a few useful math-related routines.
316 *
317 *  @{ */
318int caca_rand(int, int);
319unsigned int caca_sqrt(unsigned int);
320float caca_powf(float x, float y);
321/*  @} */
322
323/** \defgroup sprite Sprite handling
324 *
325 *  These functions provide high level routines for sprite loading, animation
326 *  and rendering.
327 *
328 *  @{ */
329struct caca_sprite;
330struct caca_sprite * caca_load_sprite(char const *);
331int caca_get_sprite_frames(struct caca_sprite const *);
332int caca_get_sprite_width(struct caca_sprite const *, int);
333int caca_get_sprite_height(struct caca_sprite const *, int);
334int caca_get_sprite_dx(struct caca_sprite const *, int);
335int caca_get_sprite_dy(struct caca_sprite const *, int);
336void caca_draw_sprite(int, int, struct caca_sprite const *, int);
337void caca_free_sprite(struct caca_sprite *);
338/*  @} */
339
340/** \defgroup bitmap Bitmap handling
341 *
342 *  These functions provide high level routines for bitmap allocation and
343 *  rendering.
344 *
345 *  @{ */
346struct caca_bitmap;
347struct caca_bitmap *caca_create_bitmap(unsigned int, unsigned int,
348                                       unsigned int, unsigned int,
349                                       unsigned int, unsigned int,
350                                       unsigned int, unsigned int);
351void caca_set_bitmap_palette(struct caca_bitmap *,
352                             unsigned int r[], unsigned int g[],
353                             unsigned int b[], unsigned int a[]);
354void caca_set_bitmap_gamma(struct caca_bitmap *, float);
355void caca_draw_bitmap(int, int, int, int, struct caca_bitmap const *, void *);
356void caca_free_bitmap(struct caca_bitmap *);
357/*  @} */
358
359/** \defgroup exporter Exporters to various formats
360 *
361 *  These functions exports current image to various text formats
362 *
363 *  @{ */
364char* caca_get_html(void);
365char* caca_get_html3(void);
366char* caca_get_irc(void);
367/*  @} */
368
369#ifdef __cplusplus
370}
371#endif
372
373#endif /* __CACA_H__ */
Note: See TracBrowser for help on using the repository browser.