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

Last change on this file since 1267 was 1267, checked in by Sam Hocevar, 15 years ago
  • Got rid of cucul_ansi_to_attr() and cucul_argb_to_attr() and restored cucul_set_color() and cucul_set_truecolor() under the new names cucul_set_color_ansi() and cucul_set_color_argb().
  • Renamed cucul_get_color_name() into cucul_ansi_to_str().
  • Property svn:keywords set to Id
File size: 10.9 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 1267 2006-10-31 13:29:48Z 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 1267 2006-10-31 13:29:48Z 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
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/** data buffer structure */
39typedef struct cucul_buffer cucul_buffer_t;
40/** font structure */
41typedef 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().
46 *
47 *  @{ */
48#define CUCUL_BLACK 0x00 /**< The colour index for black. */
49#define CUCUL_BLUE 0x01 /**< The colour index for blue. */
50#define CUCUL_GREEN 0x02 /**< The colour index for green. */
51#define CUCUL_CYAN 0x03 /**< The colour index for cyan. */
52#define CUCUL_RED 0x04 /**< The colour index for red. */
53#define CUCUL_MAGENTA 0x05 /**< The colour index for magenta. */
54#define CUCUL_BROWN 0x06 /**< The colour index for brown. */
55#define CUCUL_LIGHTGRAY 0x07 /**< The colour index for light gray. */
56#define CUCUL_DARKGRAY 0x08 /**< The colour index for dark gray. */
57#define CUCUL_LIGHTBLUE 0x09 /**< The colour index for blue. */
58#define CUCUL_LIGHTGREEN 0x0a /**< The colour index for light green. */
59#define CUCUL_LIGHTCYAN 0x0b /**< The colour index for light cyan. */
60#define CUCUL_LIGHTRED 0x0c /**< The colour index for light red. */
61#define CUCUL_LIGHTMAGENTA 0x0d /**< The colour index for light magenta. */
62#define CUCUL_YELLOW 0x0e /**< The colour index for yellow. */
63#define CUCUL_WHITE 0x0f /**< The colour index for white. */
64#define CUCUL_DEFAULT 0x10 /**< The output driver's default colour. */
65#define CUCUL_TRANSPARENT 0x20 /**< The transparent colour. */
66
67#define CUCUL_BOLD 0x01 /**< The style mask for bold. */
68#define CUCUL_ITALICS 0x02 /**< The style mask for italics. */
69#define CUCUL_UNDERLINE 0x04 /**< The style mask for underline. */
70#define CUCUL_BLINK 0x08 /**< The style mask for blink. */
71/*  @} */
72
73/** \defgroup cucul libcucul basic functions
74 *
75 *  These functions provide the basic \e libcaca routines for library
76 *  initialisation, system information retrieval and configuration.
77 *
78 *  @{ */
79cucul_canvas_t * cucul_create_canvas(unsigned int, unsigned int);
80int cucul_set_canvas_size(cucul_canvas_t *, unsigned int, unsigned int);
81unsigned int cucul_get_canvas_width(cucul_canvas_t *);
82unsigned int cucul_get_canvas_height(cucul_canvas_t *);
83int cucul_free_canvas(cucul_canvas_t *);
84int cucul_rand(int, int);
85/*  @} */
86
87/** \defgroup buffer libcucul buffer handling
88 *
89 *  These functions provide methods to handle libcucul buffers.
90 *
91 *  @{ */
92cucul_buffer_t *cucul_load_memory(void *, unsigned long int);
93cucul_buffer_t *cucul_load_file(char const *);
94unsigned long int cucul_get_buffer_size(cucul_buffer_t *);
95void * cucul_get_buffer_data(cucul_buffer_t *);
96int cucul_free_buffer(cucul_buffer_t *);
97/*  @} */
98
99/** \defgroup 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. */
106unsigned long int cucul_get_attr(cucul_canvas_t *, int, int);
107int cucul_set_attr(cucul_canvas_t *, unsigned long int);
108int cucul_set_color_ansi(cucul_canvas_t *, unsigned char, unsigned char);
109int cucul_set_color_argb(cucul_canvas_t *, unsigned int, unsigned int);
110char const *cucul_ansi_to_str(unsigned char);
111int cucul_putchar(cucul_canvas_t *, int, int, unsigned long int);
112unsigned long int cucul_getchar(cucul_canvas_t *, int, int);
113int cucul_putstr(cucul_canvas_t *, int, int, char const *);
114int cucul_printf(cucul_canvas_t *, int, int, char const *, ...);
115int cucul_clear_canvas(cucul_canvas_t *);
116int cucul_blit(cucul_canvas_t *, int, int, cucul_canvas_t const *,
117               cucul_canvas_t const *);
118int cucul_set_canvas_boundaries(cucul_canvas_t *, int, int,
119                                unsigned int, unsigned int);
120/*  @} */
121
122/** \defgroup transform libcucul canvas transformation
123 *
124 *  These functions perform horizontal and vertical canvas flipping.
125 *
126 *  @{ */
127int cucul_invert(cucul_canvas_t *);
128int cucul_flip(cucul_canvas_t *);
129int cucul_flop(cucul_canvas_t *);
130int cucul_rotate(cucul_canvas_t *);
131/*  @} */
132
133/** \defgroup charset libcucul character set conversions
134 *
135 *  These functions perform conversions between usual character sets.
136 *
137 *  @{ */
138extern unsigned long int cucul_utf8_to_utf32(char const *, unsigned int *);
139extern unsigned int cucul_utf32_to_utf8(char *, unsigned long int);
140extern unsigned char cucul_utf32_to_cp437(unsigned long int);
141extern unsigned long int cucul_cp437_to_utf32(unsigned char);
142extern int cucul_utf32_is_fullwidth(unsigned long int);
143/*  @} */
144
145/** \defgroup prim libcucul primitives drawing
146 *
147 *  These functions provide routines for primitive drawing, such as lines,
148 *  boxes, triangles and ellipses.
149 *
150 *  @{ */
151int cucul_draw_line(cucul_canvas_t *, int, int, int, int, char const *);
152int cucul_draw_polyline(cucul_canvas_t *, int const x[], int const y[], int, char const *);
153int cucul_draw_thin_line(cucul_canvas_t *, int, int, int, int);
154int cucul_draw_thin_polyline(cucul_canvas_t *, int const x[], int const y[], int);
155
156int cucul_draw_circle(cucul_canvas_t *, int, int, int, char const *);
157int cucul_draw_ellipse(cucul_canvas_t *, int, int, int, int, char const *);
158int cucul_draw_thin_ellipse(cucul_canvas_t *, int, int, int, int);
159int cucul_fill_ellipse(cucul_canvas_t *, int, int, int, int, char const *);
160
161int cucul_draw_box(cucul_canvas_t *, int, int, int, int, char const *);
162int cucul_draw_thin_box(cucul_canvas_t *, int, int, int, int);
163int cucul_fill_box(cucul_canvas_t *, int, int, int, int, char const *);
164
165int cucul_draw_triangle(cucul_canvas_t *, int, int, int, int, int, int, char const *);
166int cucul_draw_thin_triangle(cucul_canvas_t *, int, int, int, int, int, int);
167int cucul_fill_triangle(cucul_canvas_t *, int, int, int, int, int, int, char const *);
168/*  @} */
169
170/** \defgroup frame libcucul canvas frame handling
171 *
172 *  These functions provide high level routines for canvas frame insertion,
173 *  removal, copying etc.
174 *
175 *  @{ */
176unsigned int cucul_get_canvas_frame_count(cucul_canvas_t *);
177int cucul_set_canvas_frame(cucul_canvas_t *, unsigned int);
178int cucul_create_canvas_frame(cucul_canvas_t *, unsigned int);
179int cucul_free_canvas_frame(cucul_canvas_t *, unsigned int);
180/*  @} */
181
182/** \defgroup dither libcucul bitmap dithering
183 *
184 *  These functions provide high level routines for dither allocation and
185 *  rendering.
186 *
187 *  @{ */
188cucul_dither_t *cucul_create_dither(unsigned int, unsigned int,
189                                    unsigned int, unsigned int,
190                                    unsigned long int, unsigned long int,
191                                    unsigned long int, unsigned long int);
192int cucul_set_dither_palette(cucul_dither_t *,
193                             unsigned int r[], unsigned int g[],
194                             unsigned int b[], unsigned int a[]);
195int cucul_set_dither_brightness(cucul_dither_t *, float);
196int cucul_set_dither_gamma(cucul_dither_t *, float);
197int cucul_set_dither_contrast(cucul_dither_t *, float);
198int cucul_set_dither_invert(cucul_dither_t *, int);
199int cucul_set_dither_antialias(cucul_dither_t *, char const *);
200char const * const * cucul_get_dither_antialias_list(cucul_dither_t const *);
201int cucul_set_dither_color(cucul_dither_t *, char const *);
202char const * const * cucul_get_dither_color_list(cucul_dither_t const *);
203int cucul_set_dither_charset(cucul_dither_t *, char const *);
204char const * const * cucul_get_dither_charset_list(cucul_dither_t const *);
205int cucul_set_dither_mode(cucul_dither_t *, char const *);
206char const * const * cucul_get_dither_mode_list(cucul_dither_t const *);
207int cucul_dither_bitmap(cucul_canvas_t *, int, int, int, int,
208                         cucul_dither_t const *, void *);
209int cucul_free_dither(cucul_dither_t *);
210/*  @} */
211
212/** \defgroup font libcucul font handling
213 *
214 *  These functions provide font handling routines and high quality
215 *  canvas to bitmap rendering.
216 *
217 *  @{ */
218cucul_font_t *cucul_load_font(void const *, unsigned int);
219char const * const * cucul_get_font_list(void);
220unsigned int cucul_get_font_width(cucul_font_t *);
221unsigned int cucul_get_font_height(cucul_font_t *);
222unsigned long int const *cucul_get_font_blocks(cucul_font_t *);
223int cucul_render_canvas(cucul_canvas_t *, cucul_font_t *, void *,
224                         unsigned int, unsigned int, unsigned int);
225int cucul_free_font(cucul_font_t *);
226/*  @} */
227
228/** \defgroup importexport libcucul importers/exporters from/to various formats
229 *
230 *  These functions import various file formats into a new canvas, or export
231 *  the current canvas to various text formats.
232 *
233 *  @{ */
234cucul_buffer_t * cucul_export_canvas(cucul_canvas_t *, char const *);
235char const * const * cucul_get_export_list(void);
236cucul_canvas_t * cucul_import_canvas(cucul_buffer_t *, char const *);
237char const * const * cucul_get_import_list(void);
238/*  @} */
239
240#if !defined(_DOXYGEN_SKIP_ME)
241/* Legacy stuff from beta versions */
242#   ifdef __GNUC__
243#       define CUCUL_DEPRECATED __attribute__ ((deprecated))
244#   else
245#       define CUCUL_DEPRECATED
246#   endif
247int cucul_set_color(cucul_canvas_t *, unsigned char,
248                                      unsigned char) CUCUL_DEPRECATED;
249int cucul_set_truecolor(cucul_canvas_t *, unsigned int,
250                                          unsigned int) CUCUL_DEPRECATED;
251char const *cucul_get_color_name(unsigned int) CUCUL_DEPRECATED;
252#   define CUCUL_COLOR_BLACK CUCUL_BLACK
253#   define CUCUL_COLOR_BLUE CUCUL_BLUE
254#   define CUCUL_COLOR_GREEN CUCUL_GREEN
255#   define CUCUL_COLOR_CYAN CUCUL_CYAN
256#   define CUCUL_COLOR_RED CUCUL_RED
257#   define CUCUL_COLOR_MAGENTA CUCUL_MAGENTA
258#   define CUCUL_COLOR_BROWN CUCUL_BROWN
259#   define CUCUL_COLOR_LIGHTGRAY CUCUL_LIGHTGRAY
260#   define CUCUL_COLOR_DARKGRAY CUCUL_DARKGRAY
261#   define CUCUL_COLOR_LIGHTBLUE CUCUL_LIGHTBLUE
262#   define CUCUL_COLOR_LIGHTGREEN CUCUL_LIGHTGREEN
263#   define CUCUL_COLOR_LIGHTCYAN CUCUL_LIGHTCYAN
264#   define CUCUL_COLOR_LIGHTRED CUCUL_LIGHTRED
265#   define CUCUL_COLOR_LIGHTMAGENTA CUCUL_LIGHTMAGENTA
266#   define CUCUL_COLOR_YELLOW CUCUL_YELLOW
267#   define CUCUL_COLOR_WHITE CUCUL_YELLOW
268#   define CUCUL_COLOR_DEFAULT CUCUL_DEFAULT
269#   define CUCUL_COLOR_TRANSPARENT CUCUL_TRANSPARENT
270#endif
271
272#ifdef __cplusplus
273}
274#endif
275
276#endif /* __CUCUL_H__ */
Note: See TracBrowser for help on using the repository browser.