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

Last change on this file since 2057 was 2057, checked in by Sam Hocevar, 12 years ago
  • Export cucul_attr_to_rgb12_bg(), cucul_attr_to_rgb12_fg() and cucul_attr_to_argb64() (previously _cucul_attr_to_rgb12bg, _cucul_attr_to_rgb12fg and _cucul_attr_to_argb4) in the official libcucul API.
  • Cleanup complete: libcaca no longer depends on "cucul_internals.h".
  • Property svn:keywords set to Id
File size: 16.8 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 2057 2007-11-25 14:12:20Z 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 2057 2007-11-25 14:12:20Z 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__extern unsigned int cucul_attr_to_rgb12_fg(unsigned long int);
154__extern unsigned int cucul_attr_to_rgb12_bg(unsigned long int);
155__extern void cucul_attr_to_argb64(unsigned long int, unsigned char[8]);
156/*  @} */
157
158/** \defgroup cucul_charset libcucul character set conversions
159 *
160 *  These functions perform conversions between usual character sets.
161 *
162 *  @{ */
163__extern unsigned long int cucul_utf8_to_utf32(char const *, unsigned int *);
164__extern unsigned int cucul_utf32_to_utf8(char *, unsigned long int);
165__extern unsigned char cucul_utf32_to_cp437(unsigned long int);
166__extern unsigned long int cucul_cp437_to_utf32(unsigned char);
167__extern char cucul_utf32_to_ascii(unsigned long int);
168__extern int cucul_utf32_is_fullwidth(unsigned long int);
169/*  @} */
170
171/** \defgroup cucul_primitives libcucul primitives drawing
172 *
173 *  These functions provide routines for primitive drawing, such as lines,
174 *  boxes, triangles and ellipses.
175 *
176 *  @{ */
177__extern int cucul_draw_line(cucul_canvas_t *, int, int, int, int,
178                             unsigned long int);
179__extern int cucul_draw_polyline(cucul_canvas_t *, int const x[],
180                                 int const y[], int, unsigned long int);
181__extern int cucul_draw_thin_line(cucul_canvas_t *, int, int, int, int);
182__extern int cucul_draw_thin_polyline(cucul_canvas_t *, int const x[],
183                                      int const y[], int);
184
185__extern int cucul_draw_circle(cucul_canvas_t *, int, int, int,
186                               unsigned long int);
187__extern int cucul_draw_ellipse(cucul_canvas_t *, int, int, int, int,
188                                unsigned long int);
189__extern int cucul_draw_thin_ellipse(cucul_canvas_t *, int, int, int, int);
190__extern int cucul_fill_ellipse(cucul_canvas_t *, int, int, int, int,
191                                unsigned long int);
192
193__extern int cucul_draw_box(cucul_canvas_t *, int, int, int, int,
194                            unsigned long int);
195__extern int cucul_draw_thin_box(cucul_canvas_t *, int, int, int, int);
196__extern int cucul_draw_cp437_box(cucul_canvas_t *, int, int, int, int);
197__extern int cucul_fill_box(cucul_canvas_t *, int, int, int, int,
198                            unsigned long int);
199
200__extern int cucul_draw_triangle(cucul_canvas_t *, int, int, int, int, int,
201                                 int, unsigned long int);
202__extern int cucul_draw_thin_triangle(cucul_canvas_t *, int, int, int, int,
203                                      int, int);
204__extern int cucul_fill_triangle(cucul_canvas_t *, int, int, int, int, int,
205                                 int, unsigned long int);
206/*  @} */
207
208/** \defgroup cucul_frame libcucul canvas frame handling
209 *
210 *  These functions provide high level routines for canvas frame insertion,
211 *  removal, copying etc.
212 *
213 *  @{ */
214__extern unsigned int cucul_get_frame_count(cucul_canvas_t const *);
215__extern int cucul_set_frame(cucul_canvas_t *, unsigned int);
216__extern char const *cucul_get_frame_name(cucul_canvas_t const *);
217__extern int cucul_set_frame_name(cucul_canvas_t *, char const *);
218__extern int cucul_create_frame(cucul_canvas_t *, unsigned int);
219__extern int cucul_free_frame(cucul_canvas_t *, unsigned int);
220/*  @} */
221
222/** \defgroup cucul_dither libcucul bitmap dithering
223 *
224 *  These functions provide high level routines for dither allocation and
225 *  rendering.
226 *
227 *  @{ */
228__extern cucul_dither_t *cucul_create_dither(unsigned int, unsigned int,
229                                             unsigned int, unsigned int,
230                                             unsigned long int,
231                                             unsigned long int,
232                                             unsigned long int,
233                                             unsigned long int);
234__extern int cucul_set_dither_palette(cucul_dither_t *,
235                                      unsigned int r[], unsigned int g[],
236                                      unsigned int b[], unsigned int a[]);
237__extern int cucul_set_dither_brightness(cucul_dither_t *, float);
238__extern float cucul_get_dither_brightness(cucul_dither_t const *);
239__extern int cucul_set_dither_gamma(cucul_dither_t *, float);
240__extern float cucul_get_dither_gamma(cucul_dither_t const *);
241__extern int cucul_set_dither_contrast(cucul_dither_t *, float);
242__extern float cucul_get_dither_contrast(cucul_dither_t const *);
243__extern int cucul_set_dither_antialias(cucul_dither_t *, char const *);
244__extern char const * const * cucul_get_dither_antialias_list(cucul_dither_t
245                                                              const *);
246__extern char const * cucul_get_dither_antialias(cucul_dither_t const *);
247__extern int cucul_set_dither_color(cucul_dither_t *, char const *);
248__extern char const * const * cucul_get_dither_color_list(cucul_dither_t
249                                                          const *);
250__extern char const * cucul_get_dither_color(cucul_dither_t const *);
251__extern int cucul_set_dither_charset(cucul_dither_t *, char const *);
252__extern char const * const * cucul_get_dither_charset_list(cucul_dither_t
253                                                            const *);
254__extern char const * cucul_get_dither_charset(cucul_dither_t const *);
255__extern int cucul_set_dither_algorithm(cucul_dither_t *, char const *);
256__extern char const * const * cucul_get_dither_algorithm_list(cucul_dither_t
257                                                              const *);
258__extern char const * cucul_get_dither_algorithm(cucul_dither_t const *);
259__extern int cucul_dither_bitmap(cucul_canvas_t *, int, int, int, int,
260                         cucul_dither_t const *, void *);
261__extern int cucul_free_dither(cucul_dither_t *);
262/*  @} */
263
264/** \defgroup cucul_font libcucul font handling
265 *
266 *  These functions provide font handling routines and high quality
267 *  canvas to bitmap rendering.
268 *
269 *  @{ */
270__extern cucul_font_t *cucul_load_font(void const *, unsigned int);
271__extern char const * const * cucul_get_font_list(void);
272__extern unsigned int cucul_get_font_width(cucul_font_t const *);
273__extern unsigned int cucul_get_font_height(cucul_font_t const *);
274__extern unsigned long int const *cucul_get_font_blocks(cucul_font_t const *);
275__extern int cucul_render_canvas(cucul_canvas_t const *, cucul_font_t const *,
276                                 void *, unsigned int, unsigned int,
277                                 unsigned int);
278__extern int cucul_free_font(cucul_font_t *);
279/*  @} */
280
281/** \defgroup cucul_importexport libcucul importers/exporters from/to various
282 *  formats
283 *
284 *  These functions import various file formats into a new canvas, or export
285 *  the current canvas to various text formats.
286 *
287 *  @{ */
288__extern long int cucul_import_memory(cucul_canvas_t *, void const *,
289                                      unsigned long int, char const *);
290__extern long int cucul_import_file(cucul_canvas_t *, char const *,
291                                    char const *);
292__extern char const * const * cucul_get_import_list(void);
293__extern void *cucul_export_memory(cucul_canvas_t const *, char const *,
294                                   unsigned long int *);
295__extern char const * const * cucul_get_export_list(void);
296/*  @} */
297
298#if !defined(_DOXYGEN_SKIP_ME)
299    /* Legacy stuff from beta versions, will probably disappear in 1.0 */
300typedef struct cucul_buffer cucul_buffer_t;
301#   if defined __GNUC__ && __GNUC__ >= 3
302#       define CUCUL_DEPRECATED __attribute__ ((__deprecated__))
303#   else
304#       define CUCUL_DEPRECATED
305#   endif
306__extern int cucul_putchar(cucul_canvas_t *, int, int,
307                           unsigned long int) CUCUL_DEPRECATED;
308__extern unsigned long int cucul_getchar(cucul_canvas_t *,
309                                         int, int) CUCUL_DEPRECATED;
310__extern int cucul_putstr(cucul_canvas_t *, int, int,
311                          char const *) CUCUL_DEPRECATED;
312__extern int cucul_set_color(cucul_canvas_t *, unsigned char,
313                             unsigned char) CUCUL_DEPRECATED;
314__extern int cucul_set_truecolor(cucul_canvas_t *, unsigned int,
315                                 unsigned int) CUCUL_DEPRECATED;
316__extern unsigned int cucul_get_canvas_frame_count(cucul_canvas_t *)
317                                                   CUCUL_DEPRECATED;
318__extern int cucul_set_canvas_frame(cucul_canvas_t *,
319                                    unsigned int) CUCUL_DEPRECATED;
320__extern int cucul_create_canvas_frame(cucul_canvas_t *,
321                                       unsigned int) CUCUL_DEPRECATED;
322__extern int cucul_free_canvas_frame(cucul_canvas_t *,
323                                     unsigned int) CUCUL_DEPRECATED;
324__extern cucul_buffer_t *cucul_load_memory(void *,
325                                           unsigned long int) CUCUL_DEPRECATED;
326__extern cucul_buffer_t *cucul_load_file(char const *) CUCUL_DEPRECATED;
327__extern unsigned long int cucul_get_buffer_size(cucul_buffer_t *)
328                                                 CUCUL_DEPRECATED;
329__extern void * cucul_get_buffer_data(cucul_buffer_t *) CUCUL_DEPRECATED;
330__extern int cucul_free_buffer(cucul_buffer_t *) CUCUL_DEPRECATED;
331__extern cucul_buffer_t * cucul_export_canvas(cucul_canvas_t *,
332                                              char const *) CUCUL_DEPRECATED;
333__extern cucul_canvas_t * cucul_import_canvas(cucul_buffer_t *,
334                                              char const *) CUCUL_DEPRECATED;
335__extern int cucul_rotate(cucul_canvas_t *) CUCUL_DEPRECATED;
336__extern int cucul_set_dither_invert(cucul_dither_t *, int) CUCUL_DEPRECATED;
337__extern int cucul_set_dither_mode(cucul_dither_t *,
338                                   char const *) CUCUL_DEPRECATED;
339__extern char const * const * cucul_get_dither_mode_list(cucul_dither_t
340                                                         const *)
341                                                         CUCUL_DEPRECATED;
342#   define CUCUL_COLOR_BLACK CUCUL_BLACK
343#   define CUCUL_COLOR_BLUE CUCUL_BLUE
344#   define CUCUL_COLOR_GREEN CUCUL_GREEN
345#   define CUCUL_COLOR_CYAN CUCUL_CYAN
346#   define CUCUL_COLOR_RED CUCUL_RED
347#   define CUCUL_COLOR_MAGENTA CUCUL_MAGENTA
348#   define CUCUL_COLOR_BROWN CUCUL_BROWN
349#   define CUCUL_COLOR_LIGHTGRAY CUCUL_LIGHTGRAY
350#   define CUCUL_COLOR_DARKGRAY CUCUL_DARKGRAY
351#   define CUCUL_COLOR_LIGHTBLUE CUCUL_LIGHTBLUE
352#   define CUCUL_COLOR_LIGHTGREEN CUCUL_LIGHTGREEN
353#   define CUCUL_COLOR_LIGHTCYAN CUCUL_LIGHTCYAN
354#   define CUCUL_COLOR_LIGHTRED CUCUL_LIGHTRED
355#   define CUCUL_COLOR_LIGHTMAGENTA CUCUL_LIGHTMAGENTA
356#   define CUCUL_COLOR_YELLOW CUCUL_YELLOW
357#   define CUCUL_COLOR_WHITE CUCUL_YELLOW
358#   define CUCUL_COLOR_DEFAULT CUCUL_DEFAULT
359#   define CUCUL_COLOR_TRANSPARENT CUCUL_TRANSPARENT
360#endif
361
362#ifdef __cplusplus
363}
364#endif
365
366#if !defined(_DOXYGEN_SKIP_ME)
367#   undef __extern
368#endif
369
370#endif /* __CUCUL_H__ */
Note: See TracBrowser for help on using the repository browser.