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

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