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

Last change on this file since 298 was 298, checked in by Sam Hocevar, 17 years ago
  • doc/doxygen.cfg.in: + Removed caca_internal.h from the list of documented files.
  • src/: + Minor documentation updates.
  • Property svn:keywords set to Id
File size: 12.2 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 298 2003-12-31 14:21:08Z sam $
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 that does not require a text terminal.
43 *
44 *  \e libcaca is free software, released under the GNU Lesser General
45 *  Public License. This ensures that \e libcaca will always remain free
46 *  software.
47 *
48 *  \section api The libcaca API
49 *
50 *  The complete \e libcaca programming interface is available from the
51 *  caca.h header.
52 *
53 *  \section env Environment variables
54 *
55 *  Some environment variables can be used to change the behaviour of
56 *  \e libcaca without having to modify the program which uses it. These
57 *  variables are:
58 *
59 *  \li \b CACA_DRIVER: set the backend video driver. In order of preference:
60 *      - \c conio uses the DOS conio.h interface.
61 *      - \c ncurses uses the ncurses library.
62 *      - \c slang uses the S-Lang library.
63 *      - \c x11 uses the native X11 driver.
64 *
65 *  \li \b CACA_GEOMETRY: set the video display size. The format of this
66 *      variable must be XxY, with X and Y being integer values. This option
67 *      currently only works with the X11 driver.
68 *
69 *  \li \b CACA_FONT: set the rendered font. The format of this variable is
70 *      implementation dependent, but since it currently only works with the
71 *      X11 driver, an X11 font name such as "fixed" or "5x7" is expected.
72 *
73 *  \li \b CACA_BACKGROUND: set the background type.
74 *      - \c solid uses solid coloured backgrounds for all characters. This
75 *        feature does not work with all terminal emulators. This is the
76 *        default choice.
77 *      - \c black uses only black backgrounds to render characters.
78 *
79 *  \li \b CACA_ANTIALIASING: set the antialiasing mode. Antialiasing
80 *      smoothens the rendered image and avoids the commonly seen staircase
81 *      effect.
82 *      - \c none disables antialiasing.
83 *      - \c prefilter uses a simple prefilter antialiasing method. This is
84 *        the default choice.
85 *
86 *  \li \b CACA_DITHERING: set the dithering mode. Dithering is necessary
87 *      when rendering a picture that has more colours than the usually
88 *      available palette.
89 *      - \c none disables dithering.
90 *      - \c ordered2 uses a 2x2 Bayer matrix for dithering.
91 *      - \c ordered4 uses a 4x4 Bayer matrix for dithering. This is the
92 *        default choice.
93 *      - \c ordered8 uses a 8x8 Bayer matrix for dithering.
94 *      - \c random uses random dithering.
95 */
96
97#ifndef __CACA_H__
98#define __CACA_H__
99
100#ifdef __cplusplus
101extern "C"
102{
103#endif
104
105/** \brief Colour definitions.
106 *
107 *  Colours that can be used with caca_set_color().
108 */
109enum caca_color
110{
111    CACA_COLOR_BLACK = 0, /**< The colour index for black. */
112    CACA_COLOR_BLUE = 1, /**< The colour index for blue. */
113    CACA_COLOR_GREEN = 2, /**< The colour index for green. */
114    CACA_COLOR_CYAN = 3, /**< The colour index for cyan. */
115    CACA_COLOR_RED = 4, /**< The colour index for red. */
116    CACA_COLOR_MAGENTA = 5, /**< The colour index for magenta. */
117    CACA_COLOR_BROWN = 6, /**< The colour index for brown. */
118    CACA_COLOR_LIGHTGRAY = 7, /**< The colour index for light gray. */
119    CACA_COLOR_DARKGRAY = 8, /**< The colour index for dark gray. */
120    CACA_COLOR_LIGHTBLUE = 9, /**< The colour index for blue. */
121    CACA_COLOR_LIGHTGREEN = 10, /**< The colour index for light green. */
122    CACA_COLOR_LIGHTCYAN = 11, /**< The colour index for light cyan. */
123    CACA_COLOR_LIGHTRED = 12, /**< The colour index for light red. */
124    CACA_COLOR_LIGHTMAGENTA = 13, /**< The colour index for light magenta. */
125    CACA_COLOR_YELLOW = 14, /**< The colour index for yellow. */
126    CACA_COLOR_WHITE = 15 /**< The colour index for white. */
127};
128
129/** \brief Internal features.
130 *
131 *  Internal libcaca features such as the rendering method or the dithering
132 *  mode.
133 */
134enum caca_feature
135{
136    CACA_BACKGROUND       = 0x10, /**< Properties of background characters. */
137    CACA_BACKGROUND_BLACK = 0x11, /**< Draw only black backgrounds. */
138    CACA_BACKGROUND_SOLID = 0x12, /**< Draw coloured solid backgorunds. */
139#define CACA_BACKGROUND_MIN 0x11 /**< First background property */
140#define CACA_BACKGROUND_MAX 0x12 /**< Last background property */
141
142    CACA_ANTIALIASING           = 0x20, /**< Antialiasing features. */
143    CACA_ANTIALIASING_NONE      = 0x21, /**< No antialiasing. */
144    CACA_ANTIALIASING_PREFILTER = 0x22, /**< Prefilter antialiasing. */
145#define CACA_ANTIALIASING_MIN     0x21 /**< First antialiasing feature. */
146#define CACA_ANTIALIASING_MAX     0x22 /**< Last antialiasing feature. */
147
148    CACA_DITHERING          = 0x30, /**< Dithering methods */
149    CACA_DITHERING_NONE     = 0x31, /**< No dithering. */
150    CACA_DITHERING_ORDERED2 = 0x32, /**< Ordered 2x2 Bayer dithering. */
151    CACA_DITHERING_ORDERED4 = 0x33, /**< Ordered 4x4 Bayer dithering. */
152    CACA_DITHERING_ORDERED8 = 0x34, /**< Ordered 8x8 Bayer dithering. */
153    CACA_DITHERING_RANDOM   = 0x35, /**< Random dithering. */
154#define CACA_DITHERING_MIN    0x31 /**< First dithering feature. */
155#define CACA_DITHERING_MAX    0x35 /**< Last dithering feature. */
156
157    CACA_UNKNOWN_FEATURE = 0xffff /**< Unknown feature. */
158};
159
160/*
161 * Backwards compatibility macros
162 */
163#ifndef _DOXYGEN_SKIP_ME
164#define caca_dithering caca_feature
165#define caca_set_dithering caca_set_feature
166#define caca_get_dithering_name caca_get_feature_name
167#define CACA_DITHER_NONE    CACA_DITHERING_NONE
168#define CACA_DITHER_ORDERED CACA_DITHERING_ORDERED8
169#define CACA_DITHER_RANDOM  CACA_DITHERING_RANDOM
170#endif
171
172/** \brief User events.
173 *
174 *  Event types returned by caca_get_event().
175 */
176enum caca_event
177{
178    CACA_EVENT_NONE =          0x00000000, /**< No event. */
179    CACA_EVENT_KEY_PRESS =     0x01000000, /**< A key was pressed. */
180    CACA_EVENT_KEY_RELEASE =   0x02000000, /**< A key was released. */
181    CACA_EVENT_MOUSE_PRESS =   0x04000000, /**< A mouse button was pressed. */
182    CACA_EVENT_MOUSE_RELEASE = 0x08000000, /**< A mouse button was released. */
183    CACA_EVENT_MOUSE_MOTION =  0x10000000  /**< The mouse was moved. */
184};
185
186/** \brief Special key values.
187 *
188 *  Special key values returned by caca_get_event() for which there is no
189 *  ASCII equivalent.
190 */
191enum caca_key
192{
193    CACA_KEY_UP = 273, /**< The up arrow key. */
194    CACA_KEY_DOWN = 274, /**< The down arrow key. */
195    CACA_KEY_LEFT = 275, /**< The left arrow key. */
196    CACA_KEY_RIGHT = 276, /**< The right arrow key. */
197
198    CACA_KEY_F1 = 282, /**< The F1 key. */
199    CACA_KEY_F2 = 283, /**< The F2 key. */
200    CACA_KEY_F3 = 284, /**< The F3 key. */
201    CACA_KEY_F4 = 285, /**< The F4 key. */
202    CACA_KEY_F5 = 286, /**< The F5 key. */
203    CACA_KEY_F6 = 287, /**< The F6 key. */
204    CACA_KEY_F7 = 288, /**< The F7 key. */
205    CACA_KEY_F8 = 289, /**< The F8 key. */
206    CACA_KEY_F9 = 290, /**< The F9 key. */
207    CACA_KEY_F10 = 291, /**< The F10 key. */
208    CACA_KEY_F11 = 292, /**< The F11 key. */
209    CACA_KEY_F12 = 293, /**< The F12 key. */
210    CACA_KEY_F13 = 294, /**< The F13 key. */
211    CACA_KEY_F14 = 295, /**< The F14 key. */
212    CACA_KEY_F15 = 296 /**< The F15 key. */
213};
214
215/** \defgroup basic Basic functions
216 *
217 *  These functions provide the basic \e libcaca routines for library
218 *  initialisation, system information retrieval and configuration.
219 *
220 *  @{ */
221int caca_init(void);
222void caca_set_delay(unsigned int);
223enum caca_feature caca_get_feature(enum caca_feature);
224void caca_set_feature(enum caca_feature);
225const char *caca_get_feature_name(enum caca_feature);
226unsigned int caca_get_rendertime(void);
227unsigned int caca_get_width(void);
228unsigned int caca_get_height(void);
229void caca_refresh(void);
230void caca_end(void);
231/*  @} */
232
233/** \defgroup event Event handling
234 *
235 *  These functions handle user events such as keyboard input and mouse
236 *  clicks.
237 *
238 *  @{ */
239unsigned int caca_get_event(void);
240unsigned int caca_wait_event(void);
241/*  @} */
242
243/** \defgroup char Character printing
244 *
245 *  These functions provide low-level character printing routines.
246 *
247 *  @{ */
248void caca_set_color(enum caca_color, enum caca_color);
249enum caca_color caca_get_fg_color(void);
250enum caca_color caca_get_bg_color(void);
251const char *caca_get_color_name(enum caca_color);
252void caca_putchar(int, int, char);
253void caca_putstr(int, int, const char *);
254void caca_printf(int, int, const char *, ...);
255void caca_clear(void);
256/*  @} */
257
258/** \defgroup prim Primitives drawing
259 *
260 *  These functions provide routines for primitive drawing, such as lines,
261 *  boxes, triangles and ellipses.
262 *
263 *  @{ */
264void caca_draw_line(int, int, int, int, char);
265void caca_draw_polyline(const int x[], const int y[], int, char);
266void caca_draw_thin_line(int, int, int, int);
267void caca_draw_thin_polyline(const int x[], const int y[], int);
268
269void caca_draw_circle(int, int, int, char);
270void caca_draw_ellipse(int, int, int, int, char);
271void caca_draw_thin_ellipse(int, int, int, int);
272void caca_fill_ellipse(int, int, int, int, char);
273
274void caca_draw_box(int, int, int, int, char);
275void caca_draw_thin_box(int, int, int, int);
276void caca_fill_box(int, int, int, int, char);
277
278void caca_draw_triangle(int, int, int, int, int, int, char);
279void caca_draw_thin_triangle(int, int, int, int, int, int);
280void caca_fill_triangle(int, int, int, int, int, int, char);
281/*  @} */
282
283/** \defgroup math Mathematical functions
284 *
285 *  These functions provide a few useful math-related routines.
286 *
287 *  @{ */
288int caca_rand(int, int);
289unsigned int caca_sqrt(unsigned int);
290/*  @} */
291
292/** \defgroup sprite Sprite handling
293 *
294 *  These functions provide high level routines for sprite loading, animation
295 *  and rendering.
296 *
297 *  @{ */
298struct caca_sprite;
299struct caca_sprite * caca_load_sprite(const char *);
300int caca_get_sprite_frames(const struct caca_sprite *);
301int caca_get_sprite_width(const struct caca_sprite *, int);
302int caca_get_sprite_height(const struct caca_sprite *, int);
303int caca_get_sprite_dx(const struct caca_sprite *, int);
304int caca_get_sprite_dy(const struct caca_sprite *, int);
305void caca_draw_sprite(int, int, const struct caca_sprite *, int);
306void caca_free_sprite(struct caca_sprite *);
307/*  @} */
308
309/** \defgroup bitmap Bitmap handling
310 *
311 *  These functions provide high level routines for bitmap allocation and
312 *  rendering.
313 *
314 *  @{ */
315struct caca_bitmap;
316struct caca_bitmap *caca_create_bitmap(unsigned int, unsigned int,
317                                       unsigned int, unsigned int,
318                                       unsigned int, unsigned int,
319                                       unsigned int, unsigned int);
320void caca_set_bitmap_palette(struct caca_bitmap *,
321                             unsigned int r[], unsigned int g[],
322                             unsigned int b[], unsigned int a[]);
323void caca_draw_bitmap(int, int, int, int, const struct caca_bitmap *, void *);
324void caca_free_bitmap(struct caca_bitmap *);
325/*  @} */
326
327#ifdef __cplusplus
328}
329#endif
330
331#endif /* __CACA_H__ */
Note: See TracBrowser for help on using the repository browser.