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

Last change on this file since 2056 was 2056, checked in by Sam Hocevar, 12 years ago
  • Introduce cucul_get_canvas_chars() and cucul_get_canvas_attrs() to avoid direct cv->chars and cv->attrs access by display drivers.
  • Property svn:keywords set to Id
File size: 16.6 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 2056 2007-11-25 14:12:01Z 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 2056 2007-11-25 14:12:01Z 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#if !defined(_DOXYGEN_SKIP_ME)
28#   if defined(__WIN32__) && defined(__LIBCUCUL__)
29#       define __extern extern __declspec(dllexport)
30#   else
31#       define __extern extern
32#   endif
33#endif
34
35/** libcucul API version */
36#define CUCUL_API_VERSION_1
37
38#ifdef __cplusplus
39extern "C"
40{
41#endif
42
43/** \e libcucul canvas */
44typedef struct cucul_canvas cucul_canvas_t;
45/** dither structure */
46typedef struct cucul_dither cucul_dither_t;
47/** font structure */
48typedef struct cucul_font cucul_font_t;
49
50/** \defgroup cucul_attr libcucul attribute definitions
51 *
52 *  Colours and styles that can be used with cucul_set_attr().
53 *
54 *  @{ */
55#define CUCUL_BLACK 0x00 /**< The colour index for black. */
56#define CUCUL_BLUE 0x01 /**< The colour index for blue. */
57#define CUCUL_GREEN 0x02 /**< The colour index for green. */
58#define CUCUL_CYAN 0x03 /**< The colour index for cyan. */
59#define CUCUL_RED 0x04 /**< The colour index for red. */
60#define CUCUL_MAGENTA 0x05 /**< The colour index for magenta. */
61#define CUCUL_BROWN 0x06 /**< The colour index for brown. */
62#define CUCUL_LIGHTGRAY 0x07 /**< The colour index for light gray. */
63#define CUCUL_DARKGRAY 0x08 /**< The colour index for dark gray. */
64#define CUCUL_LIGHTBLUE 0x09 /**< The colour index for blue. */
65#define CUCUL_LIGHTGREEN 0x0a /**< The colour index for light green. */
66#define CUCUL_LIGHTCYAN 0x0b /**< The colour index for light cyan. */
67#define CUCUL_LIGHTRED 0x0c /**< The colour index for light red. */
68#define CUCUL_LIGHTMAGENTA 0x0d /**< The colour index for light magenta. */
69#define CUCUL_YELLOW 0x0e /**< The colour index for yellow. */
70#define CUCUL_WHITE 0x0f /**< The colour index for white. */
71#define CUCUL_DEFAULT 0x10 /**< The output driver's default colour. */
72#define CUCUL_TRANSPARENT 0x20 /**< The transparent colour. */
73
74#define CUCUL_BOLD 0x01 /**< The style mask for bold. */
75#define CUCUL_ITALICS 0x02 /**< The style mask for italics. */
76#define CUCUL_UNDERLINE 0x04 /**< The style mask for underline. */
77#define CUCUL_BLINK 0x08 /**< The style mask for blink. */
78/*  @} */
79
80/** \defgroup libcucul libcucul basic functions
81 *
82 *  These functions provide the basic \e libcaca routines for library
83 *  initialisation, system information retrieval and configuration.
84 *
85 *  @{ */
86__extern cucul_canvas_t * cucul_create_canvas(unsigned int, unsigned int);
87__extern int cucul_manage_canvas(cucul_canvas_t *, int (*)(void *), void *);
88__extern int cucul_unmanage_canvas(cucul_canvas_t *, int (*)(void *), void *);
89__extern int cucul_set_canvas_size(cucul_canvas_t *, unsigned int,
90                                   unsigned int);
91__extern unsigned int cucul_get_canvas_width(cucul_canvas_t const *);
92__extern unsigned int cucul_get_canvas_height(cucul_canvas_t const *);
93__extern unsigned char const * cucul_get_canvas_chars(cucul_canvas_t const *);
94__extern unsigned char const * cucul_get_canvas_attrs(cucul_canvas_t const *);
95__extern int cucul_free_canvas(cucul_canvas_t *);
96__extern int cucul_rand(int, int);
97/*  @} */
98
99/** \defgroup cucul_canvas libcucul canvas drawing
100 *
101 *  These functions provide low-level character printing routines and
102 *  higher level graphics functions.
103 *
104 *  @{ */
105#define CUCUL_MAGIC_FULLWIDTH 0x000ffffe /**< Used to indicate that the previous character was a fullwidth glyph. */
106__extern int cucul_gotoxy(cucul_canvas_t *, int, int);
107__extern int cucul_get_cursor_x(cucul_canvas_t const *);
108__extern int cucul_get_cursor_y(cucul_canvas_t const *);
109__extern int cucul_put_char(cucul_canvas_t *, int, int, unsigned long int);
110__extern unsigned long int cucul_get_char(cucul_canvas_t const *, int, int);
111__extern int cucul_put_str(cucul_canvas_t *, int, int, char const *);
112__extern unsigned long int cucul_get_attr(cucul_canvas_t const *, int, int);
113__extern int cucul_set_attr(cucul_canvas_t *, unsigned long int);
114__extern int cucul_put_attr(cucul_canvas_t *, int, int, unsigned long int);
115__extern int cucul_set_color_ansi(cucul_canvas_t *, unsigned char,
116                                  unsigned char);
117__extern int cucul_set_color_argb(cucul_canvas_t *, unsigned int,
118                                  unsigned int);
119__extern int cucul_printf(cucul_canvas_t *, int, int, char const *, ...);
120__extern int cucul_clear_canvas(cucul_canvas_t *);
121__extern int cucul_set_canvas_handle(cucul_canvas_t *, int, int);
122__extern int cucul_get_canvas_handle_x(cucul_canvas_t const *);
123__extern int cucul_get_canvas_handle_y(cucul_canvas_t const *);
124__extern int cucul_blit(cucul_canvas_t *, int, int, cucul_canvas_t const *,
125                        cucul_canvas_t const *);
126__extern int cucul_set_canvas_boundaries(cucul_canvas_t *, int, int,
127                                         unsigned int, unsigned int);
128/*  @} */
129
130/** \defgroup cucul_transform libcucul canvas transformation
131 *
132 *  These functions perform horizontal and vertical canvas flipping.
133 *
134 *  @{ */
135__extern int cucul_invert(cucul_canvas_t *);
136__extern int cucul_flip(cucul_canvas_t *);
137__extern int cucul_flop(cucul_canvas_t *);
138__extern int cucul_rotate_180(cucul_canvas_t *);
139__extern int cucul_rotate_left(cucul_canvas_t *);
140__extern int cucul_rotate_right(cucul_canvas_t *);
141__extern int cucul_stretch_left(cucul_canvas_t *);
142__extern int cucul_stretch_right(cucul_canvas_t *);
143/*  @} */
144
145/** \defgroup cucul_attributes libcucul attribute conversions
146 *
147 *  These functions perform conversions between attribute values.
148 *
149 *  @{ */
150__extern unsigned char cucul_attr_to_ansi(unsigned long int);
151__extern unsigned char cucul_attr_to_ansi_fg(unsigned long int);
152__extern unsigned char cucul_attr_to_ansi_bg(unsigned long int);
153/*  @} */
154
155/** \defgroup cucul_charset libcucul character set conversions
156 *
157 *  These functions perform conversions between usual character sets.
158 *
159 *  @{ */
160__extern unsigned long int cucul_utf8_to_utf32(char const *, unsigned int *);
161__extern unsigned int cucul_utf32_to_utf8(char *, unsigned long int);
162__extern unsigned char cucul_utf32_to_cp437(unsigned long int);
163__extern unsigned long int cucul_cp437_to_utf32(unsigned char);
164__extern char cucul_utf32_to_ascii(unsigned long int);
165__extern int cucul_utf32_is_fullwidth(unsigned long int);
166/*  @} */
167
168/** \defgroup cucul_primitives libcucul primitives drawing
169 *
170 *  These functions provide routines for primitive drawing, such as lines,
171 *  boxes, triangles and ellipses.
172 *
173 *  @{ */
174__extern int cucul_draw_line(cucul_canvas_t *, int, int, int, int,
175                             unsigned long int);
176__extern int cucul_draw_polyline(cucul_canvas_t *, int const x[],
177                                 int const y[], int, unsigned long int);
178__extern int cucul_draw_thin_line(cucul_canvas_t *, int, int, int, int);
179__extern int cucul_draw_thin_polyline(cucul_canvas_t *, int const x[],
180                                      int const y[], int);
181
182__extern int cucul_draw_circle(cucul_canvas_t *, int, int, int,
183                               unsigned long int);
184__extern int cucul_draw_ellipse(cucul_canvas_t *, int, int, int, int,
185                                unsigned long int);
186__extern int cucul_draw_thin_ellipse(cucul_canvas_t *, int, int, int, int);
187__extern int cucul_fill_ellipse(cucul_canvas_t *, int, int, int, int,
188                                unsigned long int);
189
190__extern int cucul_draw_box(cucul_canvas_t *, int, int, int, int,
191                            unsigned long int);
192__extern int cucul_draw_thin_box(cucul_canvas_t *, int, int, int, int);
193__extern int cucul_draw_cp437_box(cucul_canvas_t *, int, int, int, int);
194__extern int cucul_fill_box(cucul_canvas_t *, int, int, int, int,
195                            unsigned long int);
196
197__extern int cucul_draw_triangle(cucul_canvas_t *, int, int, int, int, int,
198                                 int, unsigned long int);
199__extern int cucul_draw_thin_triangle(cucul_canvas_t *, int, int, int, int,
200                                      int, int);
201__extern int cucul_fill_triangle(cucul_canvas_t *, int, int, int, int, int,
202                                 int, unsigned long int);
203/*  @} */
204
205/** \defgroup cucul_frame libcucul canvas frame handling
206 *
207 *  These functions provide high level routines for canvas frame insertion,
208 *  removal, copying etc.
209 *
210 *  @{ */
211__extern unsigned int cucul_get_frame_count(cucul_canvas_t const *);
212__extern int cucul_set_frame(cucul_canvas_t *, unsigned int);
213__extern char const *cucul_get_frame_name(cucul_canvas_t const *);
214__extern int cucul_set_frame_name(cucul_canvas_t *, char const *);
215__extern int cucul_create_frame(cucul_canvas_t *, unsigned int);
216__extern int cucul_free_frame(cucul_canvas_t *, unsigned int);
217/*  @} */
218
219/** \defgroup cucul_dither libcucul bitmap dithering
220 *
221 *  These functions provide high level routines for dither allocation and
222 *  rendering.
223 *
224 *  @{ */
225__extern cucul_dither_t *cucul_create_dither(unsigned int, unsigned int,
226                                             unsigned int, unsigned int,
227                                             unsigned long int,
228                                             unsigned long int,
229                                             unsigned long int,
230                                             unsigned long int);
231__extern int cucul_set_dither_palette(cucul_dither_t *,
232                                      unsigned int r[], unsigned int g[],
233                                      unsigned int b[], unsigned int a[]);
234__extern int cucul_set_dither_brightness(cucul_dither_t *, float);
235__extern float cucul_get_dither_brightness(cucul_dither_t const *);
236__extern int cucul_set_dither_gamma(cucul_dither_t *, float);
237__extern float cucul_get_dither_gamma(cucul_dither_t const *);
238__extern int cucul_set_dither_contrast(cucul_dither_t *, float);
239__extern float cucul_get_dither_contrast(cucul_dither_t const *);
240__extern int cucul_set_dither_antialias(cucul_dither_t *, char const *);
241__extern char const * const * cucul_get_dither_antialias_list(cucul_dither_t
242                                                              const *);
243__extern char const * cucul_get_dither_antialias(cucul_dither_t const *);
244__extern int cucul_set_dither_color(cucul_dither_t *, char const *);
245__extern char const * const * cucul_get_dither_color_list(cucul_dither_t
246                                                          const *);
247__extern char const * cucul_get_dither_color(cucul_dither_t const *);
248__extern int cucul_set_dither_charset(cucul_dither_t *, char const *);
249__extern char const * const * cucul_get_dither_charset_list(cucul_dither_t
250                                                            const *);
251__extern char const * cucul_get_dither_charset(cucul_dither_t const *);
252__extern int cucul_set_dither_algorithm(cucul_dither_t *, char const *);
253__extern char const * const * cucul_get_dither_algorithm_list(cucul_dither_t
254                                                              const *);
255__extern char const * cucul_get_dither_algorithm(cucul_dither_t const *);
256__extern int cucul_dither_bitmap(cucul_canvas_t *, int, int, int, int,
257                         cucul_dither_t const *, void *);
258__extern int cucul_free_dither(cucul_dither_t *);
259/*  @} */
260
261/** \defgroup cucul_font libcucul font handling
262 *
263 *  These functions provide font handling routines and high quality
264 *  canvas to bitmap rendering.
265 *
266 *  @{ */
267__extern cucul_font_t *cucul_load_font(void const *, unsigned int);
268__extern char const * const * cucul_get_font_list(void);
269__extern unsigned int cucul_get_font_width(cucul_font_t const *);
270__extern unsigned int cucul_get_font_height(cucul_font_t const *);
271__extern unsigned long int const *cucul_get_font_blocks(cucul_font_t const *);
272__extern int cucul_render_canvas(cucul_canvas_t const *, cucul_font_t const *,
273                                 void *, unsigned int, unsigned int,
274                                 unsigned int);
275__extern int cucul_free_font(cucul_font_t *);
276/*  @} */
277
278/** \defgroup cucul_importexport libcucul importers/exporters from/to various
279 *  formats
280 *
281 *  These functions import various file formats into a new canvas, or export
282 *  the current canvas to various text formats.
283 *
284 *  @{ */
285__extern long int cucul_import_memory(cucul_canvas_t *, void const *,
286                                      unsigned long int, char const *);
287__extern long int cucul_import_file(cucul_canvas_t *, char const *,
288                                    char const *);
289__extern char const * const * cucul_get_import_list(void);
290__extern void *cucul_export_memory(cucul_canvas_t const *, char const *,
291                                   unsigned long int *);
292__extern char const * const * cucul_get_export_list(void);
293/*  @} */
294
295#if !defined(_DOXYGEN_SKIP_ME)
296    /* Legacy stuff from beta versions, will probably disappear in 1.0 */
297typedef struct cucul_buffer cucul_buffer_t;
298#   if defined __GNUC__ && __GNUC__ >= 3
299#       define CUCUL_DEPRECATED __attribute__ ((__deprecated__))
300#   else
301#       define CUCUL_DEPRECATED
302#   endif
303__extern int cucul_putchar(cucul_canvas_t *, int, int,
304                           unsigned long int) CUCUL_DEPRECATED;
305__extern unsigned long int cucul_getchar(cucul_canvas_t *,
306                                         int, int) CUCUL_DEPRECATED;
307__extern int cucul_putstr(cucul_canvas_t *, int, int,
308                          char const *) CUCUL_DEPRECATED;
309__extern int cucul_set_color(cucul_canvas_t *, unsigned char,
310                             unsigned char) CUCUL_DEPRECATED;
311__extern int cucul_set_truecolor(cucul_canvas_t *, unsigned int,
312                                 unsigned int) CUCUL_DEPRECATED;
313__extern unsigned int cucul_get_canvas_frame_count(cucul_canvas_t *)
314                                                   CUCUL_DEPRECATED;
315__extern int cucul_set_canvas_frame(cucul_canvas_t *,
316                                    unsigned int) CUCUL_DEPRECATED;
317__extern int cucul_create_canvas_frame(cucul_canvas_t *,
318                                       unsigned int) CUCUL_DEPRECATED;
319__extern int cucul_free_canvas_frame(cucul_canvas_t *,
320                                     unsigned int) CUCUL_DEPRECATED;
321__extern cucul_buffer_t *cucul_load_memory(void *,
322                                           unsigned long int) CUCUL_DEPRECATED;
323__extern cucul_buffer_t *cucul_load_file(char const *) CUCUL_DEPRECATED;
324__extern unsigned long int cucul_get_buffer_size(cucul_buffer_t *)
325                                                 CUCUL_DEPRECATED;
326__extern void * cucul_get_buffer_data(cucul_buffer_t *) CUCUL_DEPRECATED;
327__extern int cucul_free_buffer(cucul_buffer_t *) CUCUL_DEPRECATED;
328__extern cucul_buffer_t * cucul_export_canvas(cucul_canvas_t *,
329                                              char const *) CUCUL_DEPRECATED;
330__extern cucul_canvas_t * cucul_import_canvas(cucul_buffer_t *,
331                                              char const *) CUCUL_DEPRECATED;
332__extern int cucul_rotate(cucul_canvas_t *) CUCUL_DEPRECATED;
333__extern int cucul_set_dither_invert(cucul_dither_t *, int) CUCUL_DEPRECATED;
334__extern int cucul_set_dither_mode(cucul_dither_t *,
335                                   char const *) CUCUL_DEPRECATED;
336__extern char const * const * cucul_get_dither_mode_list(cucul_dither_t
337                                                         const *)
338                                                         CUCUL_DEPRECATED;
339#   define CUCUL_COLOR_BLACK CUCUL_BLACK
340#   define CUCUL_COLOR_BLUE CUCUL_BLUE
341#   define CUCUL_COLOR_GREEN CUCUL_GREEN
342#   define CUCUL_COLOR_CYAN CUCUL_CYAN
343#   define CUCUL_COLOR_RED CUCUL_RED
344#   define CUCUL_COLOR_MAGENTA CUCUL_MAGENTA
345#   define CUCUL_COLOR_BROWN CUCUL_BROWN
346#   define CUCUL_COLOR_LIGHTGRAY CUCUL_LIGHTGRAY
347#   define CUCUL_COLOR_DARKGRAY CUCUL_DARKGRAY
348#   define CUCUL_COLOR_LIGHTBLUE CUCUL_LIGHTBLUE
349#   define CUCUL_COLOR_LIGHTGREEN CUCUL_LIGHTGREEN
350#   define CUCUL_COLOR_LIGHTCYAN CUCUL_LIGHTCYAN
351#   define CUCUL_COLOR_LIGHTRED CUCUL_LIGHTRED
352#   define CUCUL_COLOR_LIGHTMAGENTA CUCUL_LIGHTMAGENTA
353#   define CUCUL_COLOR_YELLOW CUCUL_YELLOW
354#   define CUCUL_COLOR_WHITE CUCUL_YELLOW
355#   define CUCUL_COLOR_DEFAULT CUCUL_DEFAULT
356#   define CUCUL_COLOR_TRANSPARENT CUCUL_TRANSPARENT
357#endif
358
359#ifdef __cplusplus
360}
361#endif
362
363#if !defined(_DOXYGEN_SKIP_ME)
364#   undef __extern
365#endif
366
367#endif /* __CUCUL_H__ */
Note: See TracBrowser for help on using the repository browser.