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

Last change on this file since 700 was 689, checked in by Sam Hocevar, 14 years ago
  • Merged caca_show_cursor() and caca_hide_cursor() into caca_set_mouse() so that we have one function less.
  • Fixed coding style.
  • Removed FUCKING TABS. .------._

_.----' -.

_.--' `.

_.-' ' ' `. _

.- H A H A H A ' M A I S \/.)

. . .-' / `

|-.(-. ' ` |\
. '\\ V I E U X ' ' - -|

/'') - - ` ' '.' |\_)

|'_._ '' P O R C . . /
@) \ ''' . '/

/ | \)..'-. _ _ . ` '/

.'- -'. . )-- '/'' ,._`' ' /

.' - ` ' .' / ' /,;;;, ,_.---' \ / \
(. .'
',`'.--'/ ' /'-----' | ' / ))

'-'/ _.---' \;;'/ , | |`- |

'--'---' |;| / ,,,,;;;;;;;;;;,,,,, |-' / |

|;'| ,;;;;;;;;;;;;;;;; ;;;/ /|`

,,' /

'

  • Property svn:keywords set to Id
File size: 9.6 KB
Line 
1/*
2 *  libcaca       Colour 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 689 2006-03-24 16:51:59Z 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. For machines without a screen, and with a valid tcp stack,
34 *  the network driver (BSD sockets) should perfectly fit your needs.
35 *
36 *  \e libcaca is free software, released under the Do What The Fuck You
37 *  Want To Public License. This ensures that no one, not even the \e libcaca
38 *  developers, will ever have anything to say about what you do with the
39 *  software. It used to be licensed under the GNU Lesser General Public
40 *  License, but that was not free enough.
41 *
42 *  \section api The libcaca API
43 *
44 *  \e libcaca relies on a low-level, device independent library, called
45 *  \e libcucul. \e libcucul can be used alone as a simple ASCII and/or
46 *  Unicode compositing canvas.
47 *
48 *  The complete \e libcucul and \e libcaca programming interface is
49 *  available from the cucul.h and caca.h headers.
50 *
51 *  \section env Environment variables
52 *
53 *  Some environment variables can be used to change the behaviour of
54 *  \e libcaca or \e libcucul without having to modify the program which
55 *  uses them. These variables are:
56 *
57 *  \li \b CACA_DRIVER: set the backend video driver. In order of preference:
58 *      - \c conio uses the DOS conio.h interface.
59 *      - \c ncurses uses the ncurses library.
60 *      - \c slang uses the S-Lang library.
61 *      - \c x11 uses the native X11 driver.
62 *      - \c gl uses freeglut and opengl libraries.
63 *      - \c network uses BSD sockets calls.
64 *
65 *  \li \b CUCUL_BACKGROUND: set the background type.
66 *      - \c solid uses solid coloured backgrounds for all characters. This
67 *        feature does not work with all terminal emulators. This is the
68 *        default choice.
69 *      - \c black uses only black backgrounds to render characters.
70 *
71 *  \li \b CUCUL_ANTIALIASING: set the antialiasing mode. Antialiasing
72 *      smoothens the rendered image and avoids the commonly seen staircase
73 *      effect.
74 *      - \c none disables antialiasing.
75 *      - \c prefilter uses a simple prefilter antialiasing method. This is
76 *        the default choice.
77 *
78 *  \li \b CUCUL_DITHERING: set the dithering mode. Dithering is necessary
79 *      when rendering a picture that has more colours than the usually
80 *      available palette.
81 *      - \c none disables dithering.
82 *      - \c ordered2 uses a 2x2 Bayer matrix for dithering.
83 *      - \c ordered4 uses a 4x4 Bayer matrix for dithering. This is the
84 *        default choice.
85 *      - \c ordered8 uses a 8x8 Bayer matrix for dithering.
86 *      - \c random uses random dithering.
87 *
88 *  \li \b CACA_GEOMETRY: set the video display size. The format of this
89 *      variable must be XxY, with X and Y being integer values. This option
90 *      currently works with the network, X11 and GL drivers.
91 *
92 *  \li \b CACA_FONT: set the rendered font. The format of this variable is
93 *      implementation dependent, but since it currently only works with the
94 *      X11 driver, an X11 font name such as "fixed" or "5x7" is expected.
95 *
96 *  \li \b CACA_PORT: set the port the network driver will listen on, when
97 *      the output driver is "network". Default port is 51914 (0xCACA).
98 */
99
100#ifndef __CACA_H__
101#define __CACA_H__
102
103#define CACA_API_VERSION_1
104
105#include <cucul.h>
106
107#ifdef __cplusplus
108extern "C"
109{
110#endif
111
112/** \brief User event types.
113 *
114 *  Event types returned by caca_get_event().
115 */
116enum caca_event_type
117{
118    CACA_EVENT_NONE =          0x0000, /**< No event. */
119
120    CACA_EVENT_KEY_PRESS =     0x0001, /**< A key was pressed. */
121    CACA_EVENT_KEY_RELEASE =   0x0002, /**< A key was released. */
122    CACA_EVENT_MOUSE_PRESS =   0x0004, /**< A mouse button was pressed. */
123    CACA_EVENT_MOUSE_RELEASE = 0x0008, /**< A mouse button was released. */
124    CACA_EVENT_MOUSE_MOTION =  0x0010, /**< The mouse was moved. */
125    CACA_EVENT_RESIZE =        0x0020, /**< The window was resized. */
126
127    CACA_EVENT_ANY =           0xffff  /**< Bitmask for any event. */
128};
129
130/** \brief User events.
131 *
132 *  This structure is filled by caca_get_event() when an event is received.
133 *  The \e type field is always valid. The validity of the \e data union
134 *  depends on the value of the \e type field:
135 *
136 *  \li \b CACA_EVENT_NONE: no other field is valid.
137 *
138 *  \li \b CACA_EVENT_KEY_PRESS, \b CACA_EVENT_KEY_RELEASE: the \e data.key.c
139 *      field is valid and contains either the ASCII value for the key, or
140 *      an \e enum \e caca_key value. If the value is a printable ASCII
141 *      character, the \e data.key.ucs4 and \e data.key.utf8 fields are
142 *      also filled and contain respectively the UCS-4/UTF-32 and the UTF-8
143 *      representations of the character. Otherwise, their content is
144 *      undefined.
145 *
146 *  \li \b CACA_EVENT_MOUSE_PRESS, \b CACA_EVENT_MOUSE_RELEASE: the
147 *      \e data.mouse.button field is valid and contains the index of the
148 *      mouse button that was pressed.
149 *
150 *  \li \b CACA_EVENT_MOUSE_MOTION: the \e data.mouse.x and \e data.mouse.y
151 *      fields are valid and contain the mouse coordinates in character
152 *      cells.
153 *
154 *  \li \b CACA_EVENT_RESIZE: the \e data.resize.w and \e data.resize.h
155 *      fields are valid and contain the new width and height values of
156 *      the \e libcucul canvas attached to \e libcaca.
157 *
158 *  The result of accessing data members outside the above conditions is
159 *  undefined.
160 */
161struct caca_event
162{
163    enum caca_event_type type;
164    union
165    {
166        struct { unsigned int x, y, button; } mouse;
167        struct { unsigned int w, h; } resize;
168        struct { unsigned int c; unsigned long int ucs4; char utf8[8]; } key;
169    } data;
170};
171
172/** \brief Special key values.
173 *
174 *  Special key values returned by caca_get_event() for which there is no
175 *  ASCII equivalent.
176 */
177enum caca_key
178{
179    CACA_KEY_UNKNOWN = 0x00, /**< Unknown key. */
180
181    /* The following keys have ASCII equivalents */
182    CACA_KEY_BACKSPACE = 0x08, /**< The backspace key. */
183    CACA_KEY_TAB =       0x09, /**< The tabulation key. */
184    CACA_KEY_RETURN =    0x0d, /**< The return key. */
185    CACA_KEY_PAUSE =     0x13, /**< The pause key. */
186    CACA_KEY_ESCAPE =    0x1b, /**< The escape key. */
187    CACA_KEY_DELETE =    0x7f, /**< The delete key. */
188
189    /* The following keys do not have ASCII equivalents but have been
190     * chosen to match the SDL equivalents */
191    CACA_KEY_UP =    0x111, /**< The up arrow key. */
192    CACA_KEY_DOWN =  0x112, /**< The down arrow key. */
193    CACA_KEY_LEFT =  0x113, /**< The left arrow key. */
194    CACA_KEY_RIGHT = 0x114, /**< The right arrow key. */
195
196    CACA_KEY_INSERT =   0x115, /**< The insert key. */
197    CACA_KEY_HOME =     0x116, /**< The home key. */
198    CACA_KEY_END =      0x117, /**< The end key. */
199    CACA_KEY_PAGEUP =   0x118, /**< The page up key. */
200    CACA_KEY_PAGEDOWN = 0x119, /**< The page down key. */
201
202    CACA_KEY_F1 =  0x11a, /**< The F1 key. */
203    CACA_KEY_F2 =  0x11b, /**< The F2 key. */
204    CACA_KEY_F3 =  0x11c, /**< The F3 key. */
205    CACA_KEY_F4 =  0x11d, /**< The F4 key. */
206    CACA_KEY_F5 =  0x11e, /**< The F5 key. */
207    CACA_KEY_F6 =  0x11f, /**< The F6 key. */
208    CACA_KEY_F7 =  0x120, /**< The F7 key. */
209    CACA_KEY_F8 =  0x121, /**< The F8 key. */
210    CACA_KEY_F9 =  0x122, /**< The F9 key. */
211    CACA_KEY_F10 = 0x123, /**< The F10 key. */
212    CACA_KEY_F11 = 0x124, /**< The F11 key. */
213    CACA_KEY_F12 = 0x125, /**< The F12 key. */
214    CACA_KEY_F13 = 0x126, /**< The F13 key. */
215    CACA_KEY_F14 = 0x127, /**< The F14 key. */
216    CACA_KEY_F15 = 0x128  /**< The F15 key. */
217};
218
219typedef struct caca_context caca_t;
220
221/** \defgroup basic Basic functions
222 *
223 *  These functions provide the basic \e libcaca routines for driver
224 *  initialisation, system information retrieval and configuration.
225 *
226 *  @{ */
227caca_t * caca_attach(cucul_t *qq);
228void caca_detach(caca_t *kk);
229void caca_set_delay(caca_t *kk, unsigned int);
230void caca_display(caca_t *kk);
231unsigned int caca_get_rendertime(caca_t *kk);
232unsigned int caca_get_window_width(caca_t *kk);
233unsigned int caca_get_window_height(caca_t *kk);
234int caca_set_window_title(caca_t *kk, char const *);
235/*  @} */
236
237/** \defgroup event Event handling
238 *
239 *  These functions handle user events such as keyboard input and mouse
240 *  clicks.
241 *
242 *  @{ */
243int caca_get_event(caca_t *kk, unsigned int, struct caca_event *);
244int caca_wait_event(caca_t *kk, unsigned int, struct caca_event *);
245unsigned int caca_get_mouse_x(caca_t *kk);
246unsigned int caca_get_mouse_y(caca_t *kk);
247void caca_set_mouse(caca_t *kk, int);
248/*  @} */
249
250#ifdef __cplusplus
251}
252#endif
253
254#endif /* __CACA_H__ */
Note: See TracBrowser for help on using the repository browser.