source: libcaca/trunk/caca/caca.h @ 557

Last change on this file since 557 was 536, checked in by Sam Hocevar, 14 years ago
  • Moved stuff around to differenciate between libcucul and libcaca.
  • Property svn:keywords set to Id
File size: 7.5 KB
Line 
1/*
2 *  libcaca       ASCII-Art library
3 *  Copyright (c) 2002-2006 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 Do What The Fuck You Want To
8 *  Public License, Version 2, as published by Sam Hocevar. See
9 *  http://sam.zoy.org/wtfpl/COPYING for more details.
10 */
11
12/** \file caca.h
13 *  \version \$Id: caca.h 536 2006-03-06 20:57:14Z sam $
14 *  \author Sam Hocevar <sam@zoy.org>
15 *  \brief The \e libcaca public header.
16 *
17 *  This header contains the public types and functions that applications
18 *  using \e libcaca may use.
19 */
20
21/** \mainpage libcaca developer documentation
22 *
23 *  \section intro Introduction
24 *
25 *  \e libcaca is a graphics library that outputs text instead of pixels,
26 *  so that it can work on older video cards or text terminals. It is not
27 *  unlike the famous AAlib library. \e libcaca can use almost any virtual
28 *  terminal to work, thus it should work on all Unix systems (including
29 *  Mac OS X) using either the slang library or the ncurses library, on DOS
30 *  using the conio library, and on Windows systems using either slang or
31 *  ncurses (through Cygwin emulation) or conio. There is also a native X11
32 *  driver, and an OpenGL driver (through freeglut) that does not require a
33 *  text terminal.
34 *
35 *  \e libcaca is free software, released under the Do What The Fuck You
36 *  Want To Public License. This ensures that no one, not even the \e libcaca
37 *  developers, will ever have anything to say about what you do with the
38 *  software. It used to be licensed under the GNU Lesser General Public
39 *  License, but that was not free enough.
40 *
41 *  \section api The libcaca API
42 *
43 *  \e libcaca relies on a low-level, device independent library, called
44 *  \e libcucul. \e libcucul can be used alone as a simple ASCII and/or
45 *  Unicode compositing canvas.
46 *
47 *  The complete \e libcucul and \e libcaca programming interface is
48 *  available from the cucul.h and caca.h headers.
49 *
50 *  \section env Environment variables
51 *
52 *  Some environment variables can be used to change the behaviour of
53 *  \e libcaca or \e libcucul without having to modify the program which
54 *  uses them. These variables are:
55 *
56 *  \li \b CACA_DRIVER: set the backend video driver. In order of preference:
57 *      - \c conio uses the DOS conio.h interface.
58 *      - \c ncurses uses the ncurses library.
59 *      - \c slang uses the S-Lang library.
60 *      - \c x11 uses the native X11 driver.
61 *      - \c gl uses freeglut and opengl libraries.
62 *      - \c null uses nothing at all, and will display nothing as well.
63 *
64 *  \li \b CUCUL_BACKGROUND: set the background type.
65 *      - \c solid uses solid coloured backgrounds for all characters. This
66 *        feature does not work with all terminal emulators. This is the
67 *        default choice.
68 *      - \c black uses only black backgrounds to render characters.
69 *
70 *  \li \b CUCUL_ANTIALIASING: set the antialiasing mode. Antialiasing
71 *      smoothens the rendered image and avoids the commonly seen staircase
72 *      effect.
73 *      - \c none disables antialiasing.
74 *      - \c prefilter uses a simple prefilter antialiasing method. This is
75 *        the default choice.
76 *
77 *  \li \b CUCUL_DITHERING: set the dithering mode. Dithering is necessary
78 *      when rendering a picture that has more colours than the usually
79 *      available palette.
80 *      - \c none disables dithering.
81 *      - \c ordered2 uses a 2x2 Bayer matrix for dithering.
82 *      - \c ordered4 uses a 4x4 Bayer matrix for dithering. This is the
83 *        default choice.
84 *      - \c ordered8 uses a 8x8 Bayer matrix for dithering.
85 *      - \c random uses random dithering.
86 *
87 *  \li \b CACA_GEOMETRY: set the video display size. The format of this
88 *      variable must be XxY, with X and Y being integer values. This option
89 *      currently only works with the X11 and the GL driver.
90 *
91 *  \li \b CACA_FONT: set the rendered font. The format of this variable is
92 *      implementation dependent, but since it currently only works with the
93 *      X11 driver, an X11 font name such as "fixed" or "5x7" is expected.
94 */
95
96#ifndef __CACA_H__
97#define __CACA_H__
98
99#include <cucul.h>
100
101#ifdef __cplusplus
102extern "C"
103{
104#endif
105
106/** \brief User events.
107 *
108 *  Event types returned by caca_get_event().
109 */
110enum caca_event
111{
112    CACA_EVENT_NONE =          0x00000000, /**< No event. */
113    CACA_EVENT_KEY_PRESS =     0x01000000, /**< A key was pressed. */
114    CACA_EVENT_KEY_RELEASE =   0x02000000, /**< A key was released. */
115    CACA_EVENT_MOUSE_PRESS =   0x04000000, /**< A mouse button was pressed. */
116    CACA_EVENT_MOUSE_RELEASE = 0x08000000, /**< A mouse button was released. */
117    CACA_EVENT_MOUSE_MOTION =  0x10000000, /**< The mouse was moved. */
118    CACA_EVENT_RESIZE =        0x20000000, /**< The window was resized. */
119    CACA_EVENT_ANY =           0xff000000  /**< Bitmask for any event. */
120};
121
122/** \brief Special key values.
123 *
124 *  Special key values returned by caca_get_event() for which there is no
125 *  ASCII equivalent.
126 */
127enum caca_key
128{
129    CACA_KEY_UNKNOWN = 0, /**< Unknown key. */
130
131    /* The following keys have ASCII equivalents */
132    CACA_KEY_BACKSPACE = 8, /**< The backspace key. */
133    CACA_KEY_TAB = 9, /**< The tabulation key. */
134    CACA_KEY_RETURN = 13, /**< The return key. */
135    CACA_KEY_PAUSE = 19, /**< The pause key. */
136    CACA_KEY_ESCAPE = 27, /**< The escape key. */
137    CACA_KEY_DELETE = 127, /**< The delete key. */
138
139    /* The following keys do not have ASCII equivalents but have been
140     * chosen to match the SDL equivalents */
141    CACA_KEY_UP = 273, /**< The up arrow key. */
142    CACA_KEY_DOWN = 274, /**< The down arrow key. */
143    CACA_KEY_LEFT = 275, /**< The left arrow key. */
144    CACA_KEY_RIGHT = 276, /**< The right arrow key. */
145
146    CACA_KEY_INSERT = 277, /**< The insert key. */
147    CACA_KEY_HOME = 278, /**< The home key. */
148    CACA_KEY_END = 279, /**< The end key. */
149    CACA_KEY_PAGEUP = 280, /**< The page up key. */
150    CACA_KEY_PAGEDOWN = 281, /**< The page down key. */
151
152    CACA_KEY_F1 = 282, /**< The F1 key. */
153    CACA_KEY_F2 = 283, /**< The F2 key. */
154    CACA_KEY_F3 = 284, /**< The F3 key. */
155    CACA_KEY_F4 = 285, /**< The F4 key. */
156    CACA_KEY_F5 = 286, /**< The F5 key. */
157    CACA_KEY_F6 = 287, /**< The F6 key. */
158    CACA_KEY_F7 = 288, /**< The F7 key. */
159    CACA_KEY_F8 = 289, /**< The F8 key. */
160    CACA_KEY_F9 = 290, /**< The F9 key. */
161    CACA_KEY_F10 = 291, /**< The F10 key. */
162    CACA_KEY_F11 = 292, /**< The F11 key. */
163    CACA_KEY_F12 = 293, /**< The F12 key. */
164    CACA_KEY_F13 = 294, /**< The F13 key. */
165    CACA_KEY_F14 = 295, /**< The F14 key. */
166    CACA_KEY_F15 = 296 /**< The F15 key. */
167};
168
169typedef struct caca_context caca_t;
170
171/** \defgroup basic Basic functions
172 *
173 *  These functions provide the basic \e libcaca routines for library
174 *  initialisation, system information retrieval and configuration.
175 *
176 *  @{ */
177caca_t * caca_attach(cucul_t *qq);
178void caca_detach(caca_t *kk);
179void caca_set_delay(caca_t *kk, unsigned int);
180void caca_display(caca_t *kk);
181unsigned int caca_get_rendertime(caca_t *kk);
182unsigned int caca_get_window_width(caca_t *kk);
183unsigned int caca_get_window_height(caca_t *kk);
184int caca_set_window_title(caca_t *kk, char const *);
185/*  @} */
186
187/** \defgroup event Event handling
188 *
189 *  These functions handle user events such as keyboard input and mouse
190 *  clicks.
191 *
192 *  @{ */
193unsigned int caca_get_event(caca_t *kk, unsigned int);
194unsigned int caca_wait_event(caca_t *kk, unsigned int);
195unsigned int caca_get_mouse_x(caca_t *kk);
196unsigned int caca_get_mouse_y(caca_t *kk);
197/*  @} */
198
199#ifdef __cplusplus
200}
201#endif
202
203#endif /* __CACA_H__ */
Note: See TracBrowser for help on using the repository browser.