source: libcaca/trunk/cucul/cucul.h @ 1809

Last change on this file since 1809 was 1809, checked in by Sam Hocevar, 16 years ago
  • Renamed cucul_rotate_*_wide to cucul_rotate_* and cucul_rotate_* to cucul_stretch_* to avoid long function names. And the pairwise rotations look so nice now that they should be the real rotation chars.
  • Property svn:keywords set to Id
File size: 13.2 KB
Line 
1/*
2 *  libcucul      Canvas for ultrafast compositing of Unicode letters
3 *  Copyright (c) 2002-2006 Sam Hocevar <sam@zoy.org>
4 *                All Rights Reserved
5 *
6 *  $Id: cucul.h 1809 2007-07-17 20:46:18Z sam $
7 *
8 *  This library is free software. It comes without any warranty, to
9 *  the extent permitted by applicable law. You can redistribute it
10 *  and/or modify it under the terms of the Do What The Fuck You Want
11 *  To Public License, Version 2, as published by Sam Hocevar. See
12 *  http://sam.zoy.org/wtfpl/COPYING for more details.
13 */
14
15/** \file cucul.h
16 *  \version \$Id: cucul.h 1809 2007-07-17 20:46:18Z sam $
17 *  \author Sam Hocevar <sam@zoy.org>
18 *  \brief The \e libcucul public header.
19 *
20 *  This header contains the public types and functions that applications
21 *  using \e libcucul may use.
22 */
23
24#ifndef __CUCUL_H__
25#define __CUCUL_H__
26
27/** libcucul API version */
28#define CUCUL_API_VERSION_1
29
30#ifdef __cplusplus
31extern "C"
32{
33#endif
34
35/** \e libcucul canvas */
36typedef struct cucul_canvas cucul_canvas_t;
37/** dither structure */
38typedef struct cucul_dither cucul_dither_t;
39/** font structure */
40typedef struct cucul_font cucul_font_t;
41
42/** \defgroup attr_defines libcucul attribute definitions
43 *
44 *  Colours and styles that can be used with cucul_set_attr().
45 *
46 *  @{ */
47#define CUCUL_BLACK 0x00 /**< The colour index for black. */
48#define CUCUL_BLUE 0x01 /**< The colour index for blue. */
49#define CUCUL_GREEN 0x02 /**< The colour index for green. */
50#define CUCUL_CYAN 0x03 /**< The colour index for cyan. */
51#define CUCUL_RED 0x04 /**< The colour index for red. */
52#define CUCUL_MAGENTA 0x05 /**< The colour index for magenta. */
53#define CUCUL_BROWN 0x06 /**< The colour index for brown. */
54#define CUCUL_LIGHTGRAY 0x07 /**< The colour index for light gray. */
55#define CUCUL_DARKGRAY 0x08 /**< The colour index for dark gray. */
56#define CUCUL_LIGHTBLUE 0x09 /**< The colour index for blue. */
57#define CUCUL_LIGHTGREEN 0x0a /**< The colour index for light green. */
58#define CUCUL_LIGHTCYAN 0x0b /**< The colour index for light cyan. */
59#define CUCUL_LIGHTRED 0x0c /**< The colour index for light red. */
60#define CUCUL_LIGHTMAGENTA 0x0d /**< The colour index for light magenta. */
61#define CUCUL_YELLOW 0x0e /**< The colour index for yellow. */
62#define CUCUL_WHITE 0x0f /**< The colour index for white. */
63#define CUCUL_DEFAULT 0x10 /**< The output driver's default colour. */
64#define CUCUL_TRANSPARENT 0x20 /**< The transparent colour. */
65
66#define CUCUL_BOLD 0x01 /**< The style mask for bold. */
67#define CUCUL_ITALICS 0x02 /**< The style mask for italics. */
68#define CUCUL_UNDERLINE 0x04 /**< The style mask for underline. */
69#define CUCUL_BLINK 0x08 /**< The style mask for blink. */
70/*  @} */
71
72/** \defgroup cucul libcucul basic functions
73 *
74 *  These functions provide the basic \e libcaca routines for library
75 *  initialisation, system information retrieval and configuration.
76 *
77 *  @{ */
78cucul_canvas_t * cucul_create_canvas(unsigned int, unsigned int);
79int cucul_set_canvas_size(cucul_canvas_t *, unsigned int, unsigned int);
80unsigned int cucul_get_canvas_width(cucul_canvas_t *);
81unsigned int cucul_get_canvas_height(cucul_canvas_t *);
82int cucul_free_canvas(cucul_canvas_t *);
83int cucul_rand(int, int);
84/*  @} */
85
86/** \defgroup canvas libcucul canvas drawing
87 *
88 *  These functions provide low-level character printing routines and
89 *  higher level graphics functions.
90 *
91 *  @{ */
92#define CUCUL_MAGIC_FULLWIDTH 0x000ffffe /**< Used to indicate that the previous character was a fullwidth glyph. */
93int cucul_gotoxy(cucul_canvas_t *, int, int);
94int cucul_get_cursor_x(cucul_canvas_t *);
95int cucul_get_cursor_y(cucul_canvas_t *);
96int cucul_put_char(cucul_canvas_t *, int, int, unsigned long int);
97unsigned long int cucul_get_char(cucul_canvas_t *, int, int);
98int cucul_put_str(cucul_canvas_t *, int, int, char const *);
99unsigned long int cucul_get_attr(cucul_canvas_t *, int, int);
100int cucul_set_attr(cucul_canvas_t *, unsigned long int);
101int cucul_put_attr(cucul_canvas_t *, int, int, unsigned long int);
102int cucul_set_color_ansi(cucul_canvas_t *, unsigned char, unsigned char);
103int cucul_set_color_argb(cucul_canvas_t *, unsigned int, unsigned int);
104int cucul_printf(cucul_canvas_t *, int, int, char const *, ...);
105int cucul_clear_canvas(cucul_canvas_t *);
106int cucul_set_canvas_handle(cucul_canvas_t *, int, int);
107int cucul_get_canvas_handle_x(cucul_canvas_t *);
108int cucul_get_canvas_handle_y(cucul_canvas_t *);
109int cucul_blit(cucul_canvas_t *, int, int, cucul_canvas_t const *,
110               cucul_canvas_t const *);
111int cucul_set_canvas_boundaries(cucul_canvas_t *, int, int,
112                                unsigned int, unsigned int);
113/*  @} */
114
115/** \defgroup transform libcucul canvas transformation
116 *
117 *  These functions perform horizontal and vertical canvas flipping.
118 *
119 *  @{ */
120int cucul_invert(cucul_canvas_t *);
121int cucul_flip(cucul_canvas_t *);
122int cucul_flop(cucul_canvas_t *);
123int cucul_rotate_180(cucul_canvas_t *);
124int cucul_rotate_left(cucul_canvas_t *);
125int cucul_rotate_right(cucul_canvas_t *);
126int cucul_stretch_left(cucul_canvas_t *);
127int cucul_stretch_right(cucul_canvas_t *);
128/*  @} */
129
130/** \defgroup attributes libcucul attribute conversions
131 *
132 *  These functions perform conversions between attribute values.
133 *
134 *  @{ */
135unsigned char cucul_attr_to_ansi(unsigned long int);
136unsigned char cucul_attr_to_ansi_fg(unsigned long int);
137unsigned char cucul_attr_to_ansi_bg(unsigned long int);
138/*  @} */
139
140/** \defgroup charset libcucul character set conversions
141 *
142 *  These functions perform conversions between usual character sets.
143 *
144 *  @{ */
145unsigned long int cucul_utf8_to_utf32(char const *, unsigned int *);
146unsigned int cucul_utf32_to_utf8(char *, unsigned long int);
147unsigned char cucul_utf32_to_cp437(unsigned long int);
148unsigned long int cucul_cp437_to_utf32(unsigned char);
149char cucul_utf32_to_ascii(unsigned long int);
150int cucul_utf32_is_fullwidth(unsigned long int);
151/*  @} */
152
153/** \defgroup prim libcucul primitives drawing
154 *
155 *  These functions provide routines for primitive drawing, such as lines,
156 *  boxes, triangles and ellipses.
157 *
158 *  @{ */
159int cucul_draw_line(cucul_canvas_t *, int, int, int, int, unsigned long int);
160int cucul_draw_polyline(cucul_canvas_t *, int const x[], int const y[], int,
161                        unsigned long int);
162int cucul_draw_thin_line(cucul_canvas_t *, int, int, int, int);
163int cucul_draw_thin_polyline(cucul_canvas_t *, int const x[], int const y[],
164                             int);
165
166int cucul_draw_circle(cucul_canvas_t *, int, int, int, unsigned long int);
167int cucul_draw_ellipse(cucul_canvas_t *, int, int, int, int, unsigned long int);
168int cucul_draw_thin_ellipse(cucul_canvas_t *, int, int, int, int);
169int cucul_fill_ellipse(cucul_canvas_t *, int, int, int, int, unsigned long int);
170
171int cucul_draw_box(cucul_canvas_t *, int, int, int, int, unsigned long int);
172int cucul_draw_thin_box(cucul_canvas_t *, int, int, int, int);
173int cucul_draw_cp437_box(cucul_canvas_t *, int, int, int, int);
174int cucul_fill_box(cucul_canvas_t *, int, int, int, int, unsigned long int);
175
176int cucul_draw_triangle(cucul_canvas_t *, int, int, int, int, int, int,
177                        unsigned long int);
178int cucul_draw_thin_triangle(cucul_canvas_t *, int, int, int, int, int, int);
179int cucul_fill_triangle(cucul_canvas_t *, int, int, int, int, int, int,
180                        unsigned long int);
181/*  @} */
182
183/** \defgroup frame libcucul canvas frame handling
184 *
185 *  These functions provide high level routines for canvas frame insertion,
186 *  removal, copying etc.
187 *
188 *  @{ */
189unsigned int cucul_get_frame_count(cucul_canvas_t *);
190int cucul_set_frame(cucul_canvas_t *, unsigned int);
191char const *cucul_get_frame_name(cucul_canvas_t *);
192int cucul_set_frame_name(cucul_canvas_t *, char const *);
193int cucul_create_frame(cucul_canvas_t *, unsigned int);
194int cucul_free_frame(cucul_canvas_t *, unsigned int);
195/*  @} */
196
197/** \defgroup dither libcucul bitmap dithering
198 *
199 *  These functions provide high level routines for dither allocation and
200 *  rendering.
201 *
202 *  @{ */
203cucul_dither_t *cucul_create_dither(unsigned int, unsigned int,
204                                    unsigned int, unsigned int,
205                                    unsigned long int, unsigned long int,
206                                    unsigned long int, unsigned long int);
207int cucul_set_dither_palette(cucul_dither_t *,
208                             unsigned int r[], unsigned int g[],
209                             unsigned int b[], unsigned int a[]);
210int cucul_set_dither_brightness(cucul_dither_t *, float);
211int cucul_set_dither_gamma(cucul_dither_t *, float);
212int cucul_set_dither_contrast(cucul_dither_t *, float);
213int cucul_set_dither_invert(cucul_dither_t *, int);
214int cucul_set_dither_antialias(cucul_dither_t *, char const *);
215char const * const * cucul_get_dither_antialias_list(cucul_dither_t const *);
216int cucul_set_dither_color(cucul_dither_t *, char const *);
217char const * const * cucul_get_dither_color_list(cucul_dither_t const *);
218int cucul_set_dither_charset(cucul_dither_t *, char const *);
219char const * const * cucul_get_dither_charset_list(cucul_dither_t const *);
220int cucul_set_dither_mode(cucul_dither_t *, char const *);
221char const * const * cucul_get_dither_mode_list(cucul_dither_t const *);
222int cucul_dither_bitmap(cucul_canvas_t *, int, int, int, int,
223                         cucul_dither_t const *, void *);
224int cucul_free_dither(cucul_dither_t *);
225/*  @} */
226
227/** \defgroup font libcucul font handling
228 *
229 *  These functions provide font handling routines and high quality
230 *  canvas to bitmap rendering.
231 *
232 *  @{ */
233cucul_font_t *cucul_load_font(void const *, unsigned int);
234char const * const * cucul_get_font_list(void);
235unsigned int cucul_get_font_width(cucul_font_t *);
236unsigned int cucul_get_font_height(cucul_font_t *);
237unsigned long int const *cucul_get_font_blocks(cucul_font_t *);
238int cucul_render_canvas(cucul_canvas_t *, cucul_font_t *, void *,
239                         unsigned int, unsigned int, unsigned int);
240int cucul_free_font(cucul_font_t *);
241/*  @} */
242
243/** \defgroup importexport libcucul importers/exporters from/to various formats
244 *
245 *  These functions import various file formats into a new canvas, or export
246 *  the current canvas to various text formats.
247 *
248 *  @{ */
249long int cucul_import_memory(cucul_canvas_t *, void const *,
250                             unsigned long int, char const *);
251long int cucul_import_file(cucul_canvas_t *, char const *, char const *);
252char const * const * cucul_get_import_list(void);
253void *cucul_export_memory(cucul_canvas_t *, char const *, unsigned long int *);
254char const * const * cucul_get_export_list(void);
255/*  @} */
256
257#if !defined(_DOXYGEN_SKIP_ME)
258    /* Legacy stuff from beta versions, will probably disappear in 1.0 */
259    typedef struct cucul_buffer cucul_buffer_t;
260#   ifdef __GNUC__
261#       define CUCUL_DEPRECATED __attribute__ ((deprecated))
262#   else
263#       define CUCUL_DEPRECATED
264#   endif
265    int cucul_putchar(cucul_canvas_t *, int, int,
266                      unsigned long int) CUCUL_DEPRECATED;
267    unsigned long int cucul_getchar(cucul_canvas_t *,
268                                    int, int) CUCUL_DEPRECATED;
269    int cucul_putstr(cucul_canvas_t *, int, int,
270                     char const *) CUCUL_DEPRECATED;
271    int cucul_set_color(cucul_canvas_t *, unsigned char,
272                        unsigned char) CUCUL_DEPRECATED;
273    int cucul_set_truecolor(cucul_canvas_t *, unsigned int,
274                            unsigned int) CUCUL_DEPRECATED;
275    unsigned int cucul_get_canvas_frame_count(cucul_canvas_t *)
276                                              CUCUL_DEPRECATED;
277    int cucul_set_canvas_frame(cucul_canvas_t *,
278                               unsigned int) CUCUL_DEPRECATED;
279    int cucul_create_canvas_frame(cucul_canvas_t *,
280                                  unsigned int) CUCUL_DEPRECATED;
281    int cucul_free_canvas_frame(cucul_canvas_t *,
282                                unsigned int) CUCUL_DEPRECATED;
283    cucul_buffer_t *cucul_load_memory(void *,
284                                      unsigned long int) CUCUL_DEPRECATED;
285    cucul_buffer_t *cucul_load_file(char const *) CUCUL_DEPRECATED;
286    unsigned long int cucul_get_buffer_size(cucul_buffer_t *) CUCUL_DEPRECATED;
287    void * cucul_get_buffer_data(cucul_buffer_t *) CUCUL_DEPRECATED;
288    int cucul_free_buffer(cucul_buffer_t *) CUCUL_DEPRECATED;
289    cucul_buffer_t * cucul_export_canvas(cucul_canvas_t *,
290                                         char const *) CUCUL_DEPRECATED;
291    cucul_canvas_t * cucul_import_canvas(cucul_buffer_t *,
292                                         char const *) CUCUL_DEPRECATED;
293    int cucul_rotate(cucul_canvas_t *) CUCUL_DEPRECATED;
294#   define CUCUL_COLOR_BLACK CUCUL_BLACK
295#   define CUCUL_COLOR_BLUE CUCUL_BLUE
296#   define CUCUL_COLOR_GREEN CUCUL_GREEN
297#   define CUCUL_COLOR_CYAN CUCUL_CYAN
298#   define CUCUL_COLOR_RED CUCUL_RED
299#   define CUCUL_COLOR_MAGENTA CUCUL_MAGENTA
300#   define CUCUL_COLOR_BROWN CUCUL_BROWN
301#   define CUCUL_COLOR_LIGHTGRAY CUCUL_LIGHTGRAY
302#   define CUCUL_COLOR_DARKGRAY CUCUL_DARKGRAY
303#   define CUCUL_COLOR_LIGHTBLUE CUCUL_LIGHTBLUE
304#   define CUCUL_COLOR_LIGHTGREEN CUCUL_LIGHTGREEN
305#   define CUCUL_COLOR_LIGHTCYAN CUCUL_LIGHTCYAN
306#   define CUCUL_COLOR_LIGHTRED CUCUL_LIGHTRED
307#   define CUCUL_COLOR_LIGHTMAGENTA CUCUL_LIGHTMAGENTA
308#   define CUCUL_COLOR_YELLOW CUCUL_YELLOW
309#   define CUCUL_COLOR_WHITE CUCUL_YELLOW
310#   define CUCUL_COLOR_DEFAULT CUCUL_DEFAULT
311#   define CUCUL_COLOR_TRANSPARENT CUCUL_TRANSPARENT
312#endif
313
314#ifdef __cplusplus
315}
316#endif
317
318#endif /* __CUCUL_H__ */
Note: See TracBrowser for help on using the repository browser.