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

Last change on this file since 2039 was 2039, checked in by Sam Hocevar, 13 years ago
  • Add proper declspec(dllexport) tags for Win32 compilation.
  • Manually export private libcaca symbols.
  • Property svn:keywords set to Id
File size: 16.1 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 2039 2007-11-23 22:27:21Z 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 2039 2007-11-23 22:27:21Z 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_set_canvas_size(cucul_canvas_t *, unsigned int,
88                                   unsigned int);
89__extern unsigned int cucul_get_canvas_width(cucul_canvas_t *);
90__extern unsigned int cucul_get_canvas_height(cucul_canvas_t *);
91__extern int cucul_free_canvas(cucul_canvas_t *);
92__extern int cucul_rand(int, int);
93/*  @} */
94
95/** \defgroup cucul_canvas libcucul canvas drawing
96 *
97 *  These functions provide low-level character printing routines and
98 *  higher level graphics functions.
99 *
100 *  @{ */
101#define CUCUL_MAGIC_FULLWIDTH 0x000ffffe /**< Used to indicate that the previous character was a fullwidth glyph. */
102__extern int cucul_gotoxy(cucul_canvas_t *, int, int);
103__extern int cucul_get_cursor_x(cucul_canvas_t *);
104__extern int cucul_get_cursor_y(cucul_canvas_t *);
105__extern int cucul_put_char(cucul_canvas_t *, int, int, unsigned long int);
106__extern unsigned long int cucul_get_char(cucul_canvas_t *, int, int);
107__extern int cucul_put_str(cucul_canvas_t *, int, int, char const *);
108__extern unsigned long int cucul_get_attr(cucul_canvas_t *, int, int);
109__extern int cucul_set_attr(cucul_canvas_t *, unsigned long int);
110__extern int cucul_put_attr(cucul_canvas_t *, int, int, unsigned long int);
111__extern int cucul_set_color_ansi(cucul_canvas_t *, unsigned char,
112                                  unsigned char);
113__extern int cucul_set_color_argb(cucul_canvas_t *, unsigned int,
114                                  unsigned int);
115__extern int cucul_printf(cucul_canvas_t *, int, int, char const *, ...);
116__extern int cucul_clear_canvas(cucul_canvas_t *);
117__extern int cucul_set_canvas_handle(cucul_canvas_t *, int, int);
118__extern int cucul_get_canvas_handle_x(cucul_canvas_t *);
119__extern int cucul_get_canvas_handle_y(cucul_canvas_t *);
120__extern int cucul_blit(cucul_canvas_t *, int, int, cucul_canvas_t const *,
121                        cucul_canvas_t const *);
122__extern int cucul_set_canvas_boundaries(cucul_canvas_t *, int, int,
123                                         unsigned int, unsigned int);
124/*  @} */
125
126/** \defgroup cucul_transform libcucul canvas transformation
127 *
128 *  These functions perform horizontal and vertical canvas flipping.
129 *
130 *  @{ */
131__extern int cucul_invert(cucul_canvas_t *);
132__extern int cucul_flip(cucul_canvas_t *);
133__extern int cucul_flop(cucul_canvas_t *);
134__extern int cucul_rotate_180(cucul_canvas_t *);
135__extern int cucul_rotate_left(cucul_canvas_t *);
136__extern int cucul_rotate_right(cucul_canvas_t *);
137__extern int cucul_stretch_left(cucul_canvas_t *);
138__extern int cucul_stretch_right(cucul_canvas_t *);
139/*  @} */
140
141/** \defgroup cucul_attributes libcucul attribute conversions
142 *
143 *  These functions perform conversions between attribute values.
144 *
145 *  @{ */
146__extern unsigned char cucul_attr_to_ansi(unsigned long int);
147__extern unsigned char cucul_attr_to_ansi_fg(unsigned long int);
148__extern unsigned char cucul_attr_to_ansi_bg(unsigned long int);
149/*  @} */
150
151/** \defgroup cucul_charset libcucul character set conversions
152 *
153 *  These functions perform conversions between usual character sets.
154 *
155 *  @{ */
156__extern unsigned long int cucul_utf8_to_utf32(char const *, unsigned int *);
157__extern unsigned int cucul_utf32_to_utf8(char *, unsigned long int);
158__extern unsigned char cucul_utf32_to_cp437(unsigned long int);
159__extern unsigned long int cucul_cp437_to_utf32(unsigned char);
160__extern char cucul_utf32_to_ascii(unsigned long int);
161__extern int cucul_utf32_is_fullwidth(unsigned long int);
162/*  @} */
163
164/** \defgroup cucul_primitives libcucul primitives drawing
165 *
166 *  These functions provide routines for primitive drawing, such as lines,
167 *  boxes, triangles and ellipses.
168 *
169 *  @{ */
170__extern int cucul_draw_line(cucul_canvas_t *, int, int, int, int,
171                             unsigned long int);
172__extern int cucul_draw_polyline(cucul_canvas_t *, int const x[],
173                                 int const y[], int, unsigned long int);
174__extern int cucul_draw_thin_line(cucul_canvas_t *, int, int, int, int);
175__extern int cucul_draw_thin_polyline(cucul_canvas_t *, int const x[],
176                                      int const y[], int);
177
178__extern int cucul_draw_circle(cucul_canvas_t *, int, int, int,
179                               unsigned long int);
180__extern int cucul_draw_ellipse(cucul_canvas_t *, int, int, int, int,
181                                unsigned long int);
182__extern int cucul_draw_thin_ellipse(cucul_canvas_t *, int, int, int, int);
183__extern int cucul_fill_ellipse(cucul_canvas_t *, int, int, int, int,
184                                unsigned long int);
185
186__extern int cucul_draw_box(cucul_canvas_t *, int, int, int, int,
187                            unsigned long int);
188__extern int cucul_draw_thin_box(cucul_canvas_t *, int, int, int, int);
189__extern int cucul_draw_cp437_box(cucul_canvas_t *, int, int, int, int);
190__extern int cucul_fill_box(cucul_canvas_t *, int, int, int, int,
191                            unsigned long int);
192
193__extern int cucul_draw_triangle(cucul_canvas_t *, int, int, int, int, int,
194                                 int, unsigned long int);
195__extern int cucul_draw_thin_triangle(cucul_canvas_t *, int, int, int, int,
196                                      int, int);
197__extern int cucul_fill_triangle(cucul_canvas_t *, int, int, int, int, int,
198                                 int, unsigned long int);
199/*  @} */
200
201/** \defgroup cucul_frame libcucul canvas frame handling
202 *
203 *  These functions provide high level routines for canvas frame insertion,
204 *  removal, copying etc.
205 *
206 *  @{ */
207__extern unsigned int cucul_get_frame_count(cucul_canvas_t *);
208__extern int cucul_set_frame(cucul_canvas_t *, unsigned int);
209__extern char const *cucul_get_frame_name(cucul_canvas_t *);
210__extern int cucul_set_frame_name(cucul_canvas_t *, char const *);
211__extern int cucul_create_frame(cucul_canvas_t *, unsigned int);
212__extern int cucul_free_frame(cucul_canvas_t *, unsigned int);
213/*  @} */
214
215/** \defgroup cucul_dither libcucul bitmap dithering
216 *
217 *  These functions provide high level routines for dither allocation and
218 *  rendering.
219 *
220 *  @{ */
221__extern cucul_dither_t *cucul_create_dither(unsigned int, unsigned int,
222                                             unsigned int, unsigned int,
223                                             unsigned long int,
224                                             unsigned long int,
225                                             unsigned long int,
226                                             unsigned long int);
227__extern int cucul_set_dither_palette(cucul_dither_t *,
228                                      unsigned int r[], unsigned int g[],
229                                      unsigned int b[], unsigned int a[]);
230__extern int cucul_set_dither_brightness(cucul_dither_t *, float);
231__extern float cucul_get_dither_brightness(cucul_dither_t *);
232__extern int cucul_set_dither_gamma(cucul_dither_t *, float);
233__extern float cucul_get_dither_gamma(cucul_dither_t *);
234__extern int cucul_set_dither_contrast(cucul_dither_t *, float);
235__extern float cucul_get_dither_contrast(cucul_dither_t *);
236__extern int cucul_set_dither_antialias(cucul_dither_t *, char const *);
237__extern char const * const * cucul_get_dither_antialias_list(cucul_dither_t
238                                                              const *);
239__extern char const * cucul_get_dither_antialias(cucul_dither_t const *);
240__extern int cucul_set_dither_color(cucul_dither_t *, char const *);
241__extern char const * const * cucul_get_dither_color_list(cucul_dither_t
242                                                          const *);
243__extern char const * cucul_get_dither_color(cucul_dither_t const *);
244__extern int cucul_set_dither_charset(cucul_dither_t *, char const *);
245__extern char const * const * cucul_get_dither_charset_list(cucul_dither_t
246                                                            const *);
247__extern char const * cucul_get_dither_charset(cucul_dither_t const *);
248__extern int cucul_set_dither_algorithm(cucul_dither_t *, char const *);
249__extern char const * const * cucul_get_dither_algorithm_list(cucul_dither_t
250                                                              const *);
251__extern char const * cucul_get_dither_algorithm(cucul_dither_t const *);
252__extern int cucul_dither_bitmap(cucul_canvas_t *, int, int, int, int,
253                         cucul_dither_t const *, void *);
254__extern int cucul_free_dither(cucul_dither_t *);
255/*  @} */
256
257/** \defgroup cucul_font libcucul font handling
258 *
259 *  These functions provide font handling routines and high quality
260 *  canvas to bitmap rendering.
261 *
262 *  @{ */
263__extern cucul_font_t *cucul_load_font(void const *, unsigned int);
264__extern char const * const * cucul_get_font_list(void);
265__extern unsigned int cucul_get_font_width(cucul_font_t *);
266__extern unsigned int cucul_get_font_height(cucul_font_t *);
267__extern unsigned long int const *cucul_get_font_blocks(cucul_font_t *);
268__extern int cucul_render_canvas(cucul_canvas_t *, cucul_font_t *, void *,
269                                 unsigned int, unsigned int, unsigned int);
270__extern int cucul_free_font(cucul_font_t *);
271/*  @} */
272
273/** \defgroup cucul_importexport libcucul importers/exporters from/to various
274 *  formats
275 *
276 *  These functions import various file formats into a new canvas, or export
277 *  the current canvas to various text formats.
278 *
279 *  @{ */
280__extern long int cucul_import_memory(cucul_canvas_t *, void const *,
281                                      unsigned long int, char const *);
282__extern long int cucul_import_file(cucul_canvas_t *, char const *,
283                                    char const *);
284__extern char const * const * cucul_get_import_list(void);
285__extern void *cucul_export_memory(cucul_canvas_t *, char const *,
286                                   unsigned long int *);
287__extern char const * const * cucul_get_export_list(void);
288/*  @} */
289
290#if !defined(_DOXYGEN_SKIP_ME)
291    /* Legacy stuff from beta versions, will probably disappear in 1.0 */
292typedef struct cucul_buffer cucul_buffer_t;
293#   if defined __GNUC__ && __GNUC__ >= 3
294#       define CUCUL_DEPRECATED __attribute__ ((__deprecated__))
295#   else
296#       define CUCUL_DEPRECATED
297#   endif
298__extern int cucul_putchar(cucul_canvas_t *, int, int,
299                           unsigned long int) CUCUL_DEPRECATED;
300__extern unsigned long int cucul_getchar(cucul_canvas_t *,
301                                         int, int) CUCUL_DEPRECATED;
302__extern int cucul_putstr(cucul_canvas_t *, int, int,
303                          char const *) CUCUL_DEPRECATED;
304__extern int cucul_set_color(cucul_canvas_t *, unsigned char,
305                             unsigned char) CUCUL_DEPRECATED;
306__extern int cucul_set_truecolor(cucul_canvas_t *, unsigned int,
307                                 unsigned int) CUCUL_DEPRECATED;
308__extern unsigned int cucul_get_canvas_frame_count(cucul_canvas_t *)
309                                                   CUCUL_DEPRECATED;
310__extern int cucul_set_canvas_frame(cucul_canvas_t *,
311                                    unsigned int) CUCUL_DEPRECATED;
312__extern int cucul_create_canvas_frame(cucul_canvas_t *,
313                                       unsigned int) CUCUL_DEPRECATED;
314__extern int cucul_free_canvas_frame(cucul_canvas_t *,
315                                     unsigned int) CUCUL_DEPRECATED;
316__extern cucul_buffer_t *cucul_load_memory(void *,
317                                           unsigned long int) CUCUL_DEPRECATED;
318__extern cucul_buffer_t *cucul_load_file(char const *) CUCUL_DEPRECATED;
319__extern unsigned long int cucul_get_buffer_size(cucul_buffer_t *)
320                                                 CUCUL_DEPRECATED;
321__extern void * cucul_get_buffer_data(cucul_buffer_t *) CUCUL_DEPRECATED;
322__extern int cucul_free_buffer(cucul_buffer_t *) CUCUL_DEPRECATED;
323__extern cucul_buffer_t * cucul_export_canvas(cucul_canvas_t *,
324                                              char const *) CUCUL_DEPRECATED;
325__extern cucul_canvas_t * cucul_import_canvas(cucul_buffer_t *,
326                                              char const *) CUCUL_DEPRECATED;
327__extern int cucul_rotate(cucul_canvas_t *) CUCUL_DEPRECATED;
328__extern int cucul_set_dither_invert(cucul_dither_t *, int) CUCUL_DEPRECATED;
329__extern int cucul_set_dither_mode(cucul_dither_t *,
330                                   char const *) CUCUL_DEPRECATED;
331__extern char const * const * cucul_get_dither_mode_list(cucul_dither_t
332                                                         const *)
333                                                         CUCUL_DEPRECATED;
334#   define CUCUL_COLOR_BLACK CUCUL_BLACK
335#   define CUCUL_COLOR_BLUE CUCUL_BLUE
336#   define CUCUL_COLOR_GREEN CUCUL_GREEN
337#   define CUCUL_COLOR_CYAN CUCUL_CYAN
338#   define CUCUL_COLOR_RED CUCUL_RED
339#   define CUCUL_COLOR_MAGENTA CUCUL_MAGENTA
340#   define CUCUL_COLOR_BROWN CUCUL_BROWN
341#   define CUCUL_COLOR_LIGHTGRAY CUCUL_LIGHTGRAY
342#   define CUCUL_COLOR_DARKGRAY CUCUL_DARKGRAY
343#   define CUCUL_COLOR_LIGHTBLUE CUCUL_LIGHTBLUE
344#   define CUCUL_COLOR_LIGHTGREEN CUCUL_LIGHTGREEN
345#   define CUCUL_COLOR_LIGHTCYAN CUCUL_LIGHTCYAN
346#   define CUCUL_COLOR_LIGHTRED CUCUL_LIGHTRED
347#   define CUCUL_COLOR_LIGHTMAGENTA CUCUL_LIGHTMAGENTA
348#   define CUCUL_COLOR_YELLOW CUCUL_YELLOW
349#   define CUCUL_COLOR_WHITE CUCUL_YELLOW
350#   define CUCUL_COLOR_DEFAULT CUCUL_DEFAULT
351#   define CUCUL_COLOR_TRANSPARENT CUCUL_TRANSPARENT
352#endif
353
354#ifdef __cplusplus
355}
356#endif
357
358#if !defined(_DOXYGEN_SKIP_ME)
359#   undef __extern
360#endif
361
362#endif /* __CUCUL_H__ */
Note: See TracBrowser for help on using the repository browser.