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

Last change on this file since 2111 was 2111, checked in by Sam Hocevar, 12 years ago

=?utf-8?q?=20=20*=20Implement=20cucul=5Fput=5Ffigchar()=20to=20paste=20FIGlet/TOIlet=20characters=20in

=20=20=20=20=20=20=20=20=20=20=E2=96=8C=20=E2=96=8C=20=20=20=E2=96=9C=E2=96=9C=20=20=20=20=C2=A0=E2=96=8C=20=E2=96=8C=20=20=20=20=20=20=E2=96=9C=20=20=20=E2=96=8C=E2=96=90
=20=20=20=20=20=20=20=20=20=20=E2=96=99=E2=96=84=E2=96=8C=E2=96=9E=E2=96=80=E2=96=96=E2=96=90=E2=96=90=20=E2=96=9E=E2=96=80=E2=96=96=C2=A0=E2=96=8C=E2=96=96=E2=96=8C=E2=96=9E=E2=96=80=E2=96=96=E2=96=99=E2=96=80=E2=96=96=E2=96=90=20=E2=96=9E=E2=96=80=E2=96=8C=E2=96=90
=20=20=20=20=20=20=20=20=20=20=E2=96=8C=20=E2=96=8C=E2=96=9B=E2=96=80=20=E2=96=90=E2=96=90=20=E2=96=8C=20=E2=96=8C=C2=A0=E2=96=99=E2=96=9A=E2=96=8C=E2=96=8C=20=E2=96=8C=E2=96=8C=20=C2=A0=E2=96=90=20=E2=96=8C=20=E2=96=8C=E2=96=9D
=20=20=20=20=20=20=20=20=20=20=E2=96=98=20=E2=96=98=E2=96=9D=E2=96=80=E2=96=98=20=E2=96=98=E2=96=98=E2=96=9D=E2=96=80=20=C2=A0=E2=96=98=20=E2=96=98=E2=96=9D=E2=96=80=20=E2=96=98=20=20=20=E2=96=98=E2=96=9D=E2=96=80=E2=96=98=E2=96=9D?=
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit

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