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

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