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

Last change on this file since 198 was 198, checked in by Sam Hocevar, 19 years ago
  • src/io.c src/caca.h: + Interpret escape sequences for F1, F2, left, right, etc.
  • src/Makefile.am examples/Makefile.am: + Install caca.h in /usr/include. + Do not install example programs.
  • src/blit.c: + Minor improvements to grayscale colors.
  • Property svn:keywords set to Id
File size: 3.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 *   $Id: caca.h 198 2003-11-17 16:11:34Z sam $
7 *
8 *   This library is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU Lesser General Public
10 *   License as published by the Free Software Foundation; either
11 *   version 2 of the License, or (at your option) any later version.
12 *
13 *   This library is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16 *   Lesser General Public License for more details.
17 *
18 *   You should have received a copy of the GNU Lesser General Public
19 *   License along with this library; if not, write to the Free Software
20 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 *   02111-1307  USA
22 */
23
24#ifndef __CACA_H__
25#define __CACA_H__
26
27#ifdef __cplusplus
28extern "C"
29{
30#endif
31
32/*
33 * Colors
34 */
35enum caca_color
36{
37    CACA_COLOR_BLACK = 0,
38    CACA_COLOR_BLUE = 1,
39    CACA_COLOR_GREEN = 2,
40    CACA_COLOR_CYAN = 3,
41    CACA_COLOR_RED = 4,
42    CACA_COLOR_MAGENTA = 5,
43    CACA_COLOR_BROWN = 6,
44    CACA_COLOR_LIGHTGRAY = 7,
45    CACA_COLOR_DARKGRAY = 8,
46    CACA_COLOR_LIGHTBLUE = 9,
47    CACA_COLOR_LIGHTGREEN = 10,
48    CACA_COLOR_LIGHTCYAN = 11,
49    CACA_COLOR_LIGHTRED = 12,
50    CACA_COLOR_LIGHTMAGENTA = 13,
51    CACA_COLOR_YELLOW = 14,
52    CACA_COLOR_WHITE = 15
53};
54
55/*
56 * Dithering modes
57 */
58enum caca_dithering
59{
60    CACA_DITHER_NONE,
61    CACA_DITHER_ORDERED,
62    CACA_DITHER_RANDOM
63};
64
65/*
66 * Keys
67 */
68enum caca_key
69{
70    CACA_KEY_UP = 273,
71    CACA_KEY_DOWN = 274,
72    CACA_KEY_LEFT = 275,
73    CACA_KEY_RIGHT = 276,
74
75    CACA_KEY_F1 = 282,
76    CACA_KEY_F2 = 283,
77    CACA_KEY_F3 = 284,
78    CACA_KEY_F4 = 285,
79    CACA_KEY_F5 = 286,
80    CACA_KEY_F6 = 287,
81    CACA_KEY_F7 = 288,
82    CACA_KEY_F8 = 289,
83    CACA_KEY_F9 = 290,
84    CACA_KEY_F10 = 291,
85    CACA_KEY_F11 = 292,
86    CACA_KEY_F12 = 293,
87    CACA_KEY_F13 = 294,
88    CACA_KEY_F14 = 295,
89    CACA_KEY_F15 = 296
90};
91
92/*
93 * Types
94 */
95struct caca_sprite;
96
97/*
98 * Prototypes
99 */
100int caca_init(void);
101void caca_set_delay(unsigned int);
102void caca_set_dithering(enum caca_dithering);
103unsigned int caca_get_rendertime(void);
104unsigned int caca_get_width(void);
105unsigned int caca_get_height(void);
106const char *caca_get_color_name(unsigned int);
107void caca_refresh(void);
108void caca_end(void);
109
110int caca_get_key(void);
111
112void caca_set_color(enum caca_color);
113enum caca_color caca_get_color(void);
114void caca_putchar(int, int, char);
115void caca_putstr(int, int, const char *);
116void caca_printf(int, int, const char *, ...);
117void caca_clear(void);
118
119void caca_draw_line(int, int, int, int, char);
120void caca_draw_polyline(const int[], const int[], int, char);
121void caca_draw_thin_line(int, int, int, int);
122void caca_draw_thin_polyline(const int[], const int[], int);
123
124void caca_draw_circle(int, int, int, char);
125void caca_draw_ellipse(int, int, int, int, char);
126void caca_draw_thin_ellipse(int, int, int, int);
127void caca_fill_ellipse(int, int, int, int, char);
128
129void caca_draw_box(int, int, int, int, char);
130void caca_draw_thin_box(int, int, int, int);
131void caca_fill_box(int, int, int, int, char);
132
133void caca_draw_triangle(int, int, int, int, int, int, char);
134void caca_draw_thin_triangle(int, int, int, int, int, int);
135void caca_fill_triangle(int, int, int, int, int, int, char);
136
137int caca_rand(int, int);
138unsigned int caca_sqrt(unsigned int);
139
140struct caca_sprite * caca_load_sprite(const char *);
141int caca_get_sprite_frames(struct caca_sprite *);
142int caca_get_sprite_width(struct caca_sprite *, int);
143int caca_get_sprite_height(struct caca_sprite *, int);
144int caca_get_sprite_dx(struct caca_sprite *, int);
145int caca_get_sprite_dy(struct caca_sprite *, int);
146void caca_draw_sprite(int, int, struct caca_sprite *, int);
147void caca_free_sprite(struct caca_sprite *);
148
149void caca_blit(int, int, int, int, void *, int, int);
150
151#ifdef __cplusplus
152}
153#endif
154
155#endif /* __CACA_H__ */
Note: See TracBrowser for help on using the repository browser.