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 1254 2006-10-28 23:53:46Z sam $ |
---|
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: cucul.h 1254 2006-10-28 23:53:46Z sam $ |
---|
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 |
---|
30 | extern "C" |
---|
31 | { |
---|
32 | #endif |
---|
33 | |
---|
34 | /** \e libcucul canvas */ |
---|
35 | typedef struct cucul_canvas cucul_canvas_t; |
---|
36 | /** dither structure */ |
---|
37 | typedef struct cucul_dither cucul_dither_t; |
---|
38 | /** data buffer structure */ |
---|
39 | typedef struct cucul_buffer cucul_buffer_t; |
---|
40 | /** font structure */ |
---|
41 | typedef struct cucul_font cucul_font_t; |
---|
42 | |
---|
43 | /** \defgroup attributes libcucul attribute definitions |
---|
44 | * |
---|
45 | * Colours and styles that can be used with cucul_set_attr_ansi() and |
---|
46 | * cucul_set_attr_argb(). |
---|
47 | * |
---|
48 | * @{ */ |
---|
49 | #define CUCUL_COLOR_BLACK 0x00 /**< The colour index for black. */ |
---|
50 | #define CUCUL_COLOR_BLUE 0x01 /**< The colour index for blue. */ |
---|
51 | #define CUCUL_COLOR_GREEN 0x02 /**< The colour index for green. */ |
---|
52 | #define CUCUL_COLOR_CYAN 0x03 /**< The colour index for cyan. */ |
---|
53 | #define CUCUL_COLOR_RED 0x04 /**< The colour index for red. */ |
---|
54 | #define CUCUL_COLOR_MAGENTA 0x05 /**< The colour index for magenta. */ |
---|
55 | #define CUCUL_COLOR_BROWN 0x06 /**< The colour index for brown. */ |
---|
56 | #define CUCUL_COLOR_LIGHTGRAY 0x07 /**< The colour index for light gray. */ |
---|
57 | #define CUCUL_COLOR_DARKGRAY 0x08 /**< The colour index for dark gray. */ |
---|
58 | #define CUCUL_COLOR_LIGHTBLUE 0x09 /**< The colour index for blue. */ |
---|
59 | #define CUCUL_COLOR_LIGHTGREEN 0x0a /**< The colour index for light green. */ |
---|
60 | #define CUCUL_COLOR_LIGHTCYAN 0x0b /**< The colour index for light cyan. */ |
---|
61 | #define CUCUL_COLOR_LIGHTRED 0x0c /**< The colour index for light red. */ |
---|
62 | #define CUCUL_COLOR_LIGHTMAGENTA 0x0d /**< The colour index for light magenta. */ |
---|
63 | #define CUCUL_COLOR_YELLOW 0x0e /**< The colour index for yellow. */ |
---|
64 | #define CUCUL_COLOR_WHITE 0x0f /**< The colour index for white. */ |
---|
65 | #define CUCUL_COLOR_DEFAULT 0x10 /**< The output driver's default colour. */ |
---|
66 | #define CUCUL_COLOR_TRANSPARENT 0x20 /**< The transparent colour. */ |
---|
67 | |
---|
68 | #define CUCUL_STYLE_BOLD 0x01 /**< The style mask for bold. */ |
---|
69 | #define CUCUL_STYLE_ITALICS 0x02 /**< The style mask for italics. */ |
---|
70 | #define CUCUL_STYLE_UNDERLINE 0x04 /**< The style mask for underline. */ |
---|
71 | #define CUCUL_STYLE_BLINK 0x08 /**< The style mask for blink. */ |
---|
72 | /* @} */ |
---|
73 | |
---|
74 | /** \defgroup cucul libcucul basic functions |
---|
75 | * |
---|
76 | * These functions provide the basic \e libcaca routines for library |
---|
77 | * initialisation, system information retrieval and configuration. |
---|
78 | * |
---|
79 | * @{ */ |
---|
80 | cucul_canvas_t * cucul_create_canvas(unsigned int, unsigned int); |
---|
81 | int cucul_set_canvas_size(cucul_canvas_t *, unsigned int, unsigned int); |
---|
82 | unsigned int cucul_get_canvas_width(cucul_canvas_t *); |
---|
83 | unsigned int cucul_get_canvas_height(cucul_canvas_t *); |
---|
84 | int cucul_free_canvas(cucul_canvas_t *); |
---|
85 | int cucul_rand(int, int); |
---|
86 | /* @} */ |
---|
87 | |
---|
88 | /** \defgroup buffer libcucul buffer handling |
---|
89 | * |
---|
90 | * These functions provide methods to handle libcucul buffers. |
---|
91 | * |
---|
92 | * @{ */ |
---|
93 | cucul_buffer_t *cucul_load_memory(void *, unsigned long int); |
---|
94 | cucul_buffer_t *cucul_load_file(char const *); |
---|
95 | unsigned long int cucul_get_buffer_size(cucul_buffer_t *); |
---|
96 | void * cucul_get_buffer_data(cucul_buffer_t *); |
---|
97 | int cucul_free_buffer(cucul_buffer_t *); |
---|
98 | /* @} */ |
---|
99 | |
---|
100 | /** \defgroup canvas libcucul canvas drawing |
---|
101 | * |
---|
102 | * These functions provide low-level character printing routines and |
---|
103 | * higher level graphics functions. |
---|
104 | * |
---|
105 | * @{ */ |
---|
106 | #define CUCUL_MAGIC_FULLWIDTH 0x000ffffe /**< Used to indicate that the previous character was a fullwidth glyph. */ |
---|
107 | int cucul_set_attr(cucul_canvas_t *, unsigned long int); |
---|
108 | int cucul_set_attr_ansi(cucul_canvas_t *, unsigned char, unsigned char, |
---|
109 | unsigned char); |
---|
110 | int cucul_set_attr_argb(cucul_canvas_t *, unsigned int, unsigned int, |
---|
111 | unsigned char); |
---|
112 | unsigned long int cucul_get_attr(cucul_canvas_t *, int, int); |
---|
113 | char const *cucul_get_color_name(unsigned int); |
---|
114 | int cucul_putchar(cucul_canvas_t *, int, int, unsigned long int); |
---|
115 | unsigned long int cucul_getchar(cucul_canvas_t *, int, int); |
---|
116 | int cucul_putstr(cucul_canvas_t *, int, int, char const *); |
---|
117 | int cucul_printf(cucul_canvas_t *, int, int, char const *, ...); |
---|
118 | int cucul_clear_canvas(cucul_canvas_t *); |
---|
119 | int cucul_blit(cucul_canvas_t *, int, int, cucul_canvas_t const *, |
---|
120 | cucul_canvas_t const *); |
---|
121 | int cucul_set_canvas_boundaries(cucul_canvas_t *, int, int, |
---|
122 | unsigned int, unsigned int); |
---|
123 | /* Legacy stuff */ |
---|
124 | int cucul_set_color(cucul_canvas_t *, unsigned char, unsigned char); |
---|
125 | int cucul_set_truecolor(cucul_canvas_t *, unsigned int, unsigned int); |
---|
126 | /* @} */ |
---|
127 | |
---|
128 | /** \defgroup transform libcucul canvas transformation |
---|
129 | * |
---|
130 | * These functions perform horizontal and vertical canvas flipping. |
---|
131 | * |
---|
132 | * @{ */ |
---|
133 | int cucul_invert(cucul_canvas_t *); |
---|
134 | int cucul_flip(cucul_canvas_t *); |
---|
135 | int cucul_flop(cucul_canvas_t *); |
---|
136 | int cucul_rotate(cucul_canvas_t *); |
---|
137 | /* @} */ |
---|
138 | |
---|
139 | /** \defgroup charset libcucul character set conversions |
---|
140 | * |
---|
141 | * These functions perform conversions between usual character sets. |
---|
142 | * |
---|
143 | * @{ */ |
---|
144 | extern unsigned long int cucul_utf8_to_utf32(char const *, unsigned int *); |
---|
145 | extern unsigned int cucul_utf32_to_utf8(char *, unsigned long int); |
---|
146 | extern unsigned char cucul_utf32_to_cp437(unsigned long int); |
---|
147 | extern unsigned long int cucul_cp437_to_utf32(unsigned char); |
---|
148 | extern int cucul_utf32_is_fullwidth(unsigned long int); |
---|
149 | /* @} */ |
---|
150 | |
---|
151 | /** \defgroup prim libcucul primitives drawing |
---|
152 | * |
---|
153 | * These functions provide routines for primitive drawing, such as lines, |
---|
154 | * boxes, triangles and ellipses. |
---|
155 | * |
---|
156 | * @{ */ |
---|
157 | int cucul_draw_line(cucul_canvas_t *, int, int, int, int, char const *); |
---|
158 | int cucul_draw_polyline(cucul_canvas_t *, int const x[], int const y[], int, char const *); |
---|
159 | int cucul_draw_thin_line(cucul_canvas_t *, int, int, int, int); |
---|
160 | int cucul_draw_thin_polyline(cucul_canvas_t *, int const x[], int const y[], int); |
---|
161 | |
---|
162 | int cucul_draw_circle(cucul_canvas_t *, int, int, int, char const *); |
---|
163 | int cucul_draw_ellipse(cucul_canvas_t *, int, int, int, int, char const *); |
---|
164 | int cucul_draw_thin_ellipse(cucul_canvas_t *, int, int, int, int); |
---|
165 | int cucul_fill_ellipse(cucul_canvas_t *, int, int, int, int, char const *); |
---|
166 | |
---|
167 | int cucul_draw_box(cucul_canvas_t *, int, int, int, int, char const *); |
---|
168 | int cucul_draw_thin_box(cucul_canvas_t *, int, int, int, int); |
---|
169 | int cucul_fill_box(cucul_canvas_t *, int, int, int, int, char const *); |
---|
170 | |
---|
171 | int cucul_draw_triangle(cucul_canvas_t *, int, int, int, int, int, int, char const *); |
---|
172 | int cucul_draw_thin_triangle(cucul_canvas_t *, int, int, int, int, int, int); |
---|
173 | int cucul_fill_triangle(cucul_canvas_t *, int, int, int, int, int, int, char const *); |
---|
174 | /* @} */ |
---|
175 | |
---|
176 | /** \defgroup frame libcucul canvas frame handling |
---|
177 | * |
---|
178 | * These functions provide high level routines for canvas frame insertion, |
---|
179 | * removal, copying etc. |
---|
180 | * |
---|
181 | * @{ */ |
---|
182 | unsigned int cucul_get_canvas_frame_count(cucul_canvas_t *); |
---|
183 | int cucul_set_canvas_frame(cucul_canvas_t *, unsigned int); |
---|
184 | int cucul_create_canvas_frame(cucul_canvas_t *, unsigned int); |
---|
185 | int cucul_free_canvas_frame(cucul_canvas_t *, unsigned int); |
---|
186 | /* @} */ |
---|
187 | |
---|
188 | /** \defgroup dither libcucul bitmap dithering |
---|
189 | * |
---|
190 | * These functions provide high level routines for dither allocation and |
---|
191 | * rendering. |
---|
192 | * |
---|
193 | * @{ */ |
---|
194 | cucul_dither_t *cucul_create_dither(unsigned int, unsigned int, |
---|
195 | unsigned int, unsigned int, |
---|
196 | unsigned long int, unsigned long int, |
---|
197 | unsigned long int, unsigned long int); |
---|
198 | int cucul_set_dither_palette(cucul_dither_t *, |
---|
199 | unsigned int r[], unsigned int g[], |
---|
200 | unsigned int b[], unsigned int a[]); |
---|
201 | int cucul_set_dither_brightness(cucul_dither_t *, float); |
---|
202 | int cucul_set_dither_gamma(cucul_dither_t *, float); |
---|
203 | int cucul_set_dither_contrast(cucul_dither_t *, float); |
---|
204 | int cucul_set_dither_invert(cucul_dither_t *, int); |
---|
205 | int cucul_set_dither_antialias(cucul_dither_t *, char const *); |
---|
206 | char const * const * cucul_get_dither_antialias_list(cucul_dither_t const *); |
---|
207 | int cucul_set_dither_color(cucul_dither_t *, char const *); |
---|
208 | char const * const * cucul_get_dither_color_list(cucul_dither_t const *); |
---|
209 | int cucul_set_dither_charset(cucul_dither_t *, char const *); |
---|
210 | char const * const * cucul_get_dither_charset_list(cucul_dither_t const *); |
---|
211 | int cucul_set_dither_mode(cucul_dither_t *, char const *); |
---|
212 | char const * const * cucul_get_dither_mode_list(cucul_dither_t const *); |
---|
213 | int cucul_dither_bitmap(cucul_canvas_t *, int, int, int, int, |
---|
214 | cucul_dither_t const *, void *); |
---|
215 | int cucul_free_dither(cucul_dither_t *); |
---|
216 | /* @} */ |
---|
217 | |
---|
218 | /** \defgroup font libcucul font handling |
---|
219 | * |
---|
220 | * These functions provide font handling routines and high quality |
---|
221 | * canvas to bitmap rendering. |
---|
222 | * |
---|
223 | * @{ */ |
---|
224 | cucul_font_t *cucul_load_font(void const *, unsigned int); |
---|
225 | char const * const * cucul_get_font_list(void); |
---|
226 | unsigned int cucul_get_font_width(cucul_font_t *); |
---|
227 | unsigned int cucul_get_font_height(cucul_font_t *); |
---|
228 | unsigned long int const *cucul_get_font_blocks(cucul_font_t *); |
---|
229 | int cucul_render_canvas(cucul_canvas_t *, cucul_font_t *, void *, |
---|
230 | unsigned int, unsigned int, unsigned int); |
---|
231 | int cucul_free_font(cucul_font_t *); |
---|
232 | /* @} */ |
---|
233 | |
---|
234 | /** \defgroup importexport libcucul importers/exporters from/to various formats |
---|
235 | * |
---|
236 | * These functions import various file formats into a new canvas, or export |
---|
237 | * the current canvas to various text formats. |
---|
238 | * |
---|
239 | * @{ */ |
---|
240 | cucul_buffer_t * cucul_export_canvas(cucul_canvas_t *, char const *); |
---|
241 | char const * const * cucul_get_export_list(void); |
---|
242 | cucul_canvas_t * cucul_import_canvas(cucul_buffer_t *, char const *); |
---|
243 | char const * const * cucul_get_import_list(void); |
---|
244 | /* @} */ |
---|
245 | |
---|
246 | #ifdef __cplusplus |
---|
247 | } |
---|
248 | #endif |
---|
249 | |
---|
250 | #endif /* __CUCUL_H__ */ |
---|