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

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