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

Last change on this file since 1256 was 1256, checked in by Sam Hocevar, 14 years ago
  • Remove cucul_set_color() from the exported API and replaced all calls with cucul_set_attr_ansi(). Old application will still compile (but issue a warning) and run, though.
  • Property svn:keywords set to Id
File size: 9.8 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 1256 2006-10-29 08:35: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 1256 2006-10-29 08:35: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
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_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 *  @{ */
80cucul_canvas_t * cucul_create_canvas(unsigned int, unsigned int);
81int cucul_set_canvas_size(cucul_canvas_t *, unsigned int, unsigned int);
82unsigned int cucul_get_canvas_width(cucul_canvas_t *);
83unsigned int cucul_get_canvas_height(cucul_canvas_t *);
84int cucul_free_canvas(cucul_canvas_t *);
85int cucul_rand(int, int);
86/*  @} */
87
88/** \defgroup buffer libcucul buffer handling
89 *
90 *  These functions provide methods to handle libcucul buffers.
91 *
92 *  @{ */
93cucul_buffer_t *cucul_load_memory(void *, unsigned long int);
94cucul_buffer_t *cucul_load_file(char const *);
95unsigned long int cucul_get_buffer_size(cucul_buffer_t *);
96void * cucul_get_buffer_data(cucul_buffer_t *);
97int 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. */
107int cucul_set_attr(cucul_canvas_t *, unsigned long int);
108int cucul_set_attr_ansi(cucul_canvas_t *, unsigned char, unsigned char,
109                        unsigned char);
110int cucul_set_attr_argb(cucul_canvas_t *, unsigned int, unsigned int,
111                        unsigned char);
112unsigned long int cucul_get_attr(cucul_canvas_t *, int, int);
113char const *cucul_get_color_name(unsigned int);
114int cucul_putchar(cucul_canvas_t *, int, int, unsigned long int);
115unsigned long int cucul_getchar(cucul_canvas_t *, int, int);
116int cucul_putstr(cucul_canvas_t *, int, int, char const *);
117int cucul_printf(cucul_canvas_t *, int, int, char const *, ...);
118int cucul_clear_canvas(cucul_canvas_t *);
119int cucul_blit(cucul_canvas_t *, int, int, cucul_canvas_t const *,
120               cucul_canvas_t const *);
121int cucul_set_canvas_boundaries(cucul_canvas_t *, int, int,
122                                unsigned int, unsigned int);
123/*  @} */
124
125/** \defgroup transform libcucul canvas transformation
126 *
127 *  These functions perform horizontal and vertical canvas flipping.
128 *
129 *  @{ */
130int cucul_invert(cucul_canvas_t *);
131int cucul_flip(cucul_canvas_t *);
132int cucul_flop(cucul_canvas_t *);
133int cucul_rotate(cucul_canvas_t *);
134/*  @} */
135
136/** \defgroup charset libcucul character set conversions
137 *
138 *  These functions perform conversions between usual character sets.
139 *
140 *  @{ */
141extern unsigned long int cucul_utf8_to_utf32(char const *, unsigned int *);
142extern unsigned int cucul_utf32_to_utf8(char *, unsigned long int);
143extern unsigned char cucul_utf32_to_cp437(unsigned long int);
144extern unsigned long int cucul_cp437_to_utf32(unsigned char);
145extern int cucul_utf32_is_fullwidth(unsigned long int);
146/*  @} */
147
148/** \defgroup prim libcucul primitives drawing
149 *
150 *  These functions provide routines for primitive drawing, such as lines,
151 *  boxes, triangles and ellipses.
152 *
153 *  @{ */
154int cucul_draw_line(cucul_canvas_t *, int, int, int, int, char const *);
155int cucul_draw_polyline(cucul_canvas_t *, int const x[], int const y[], int, char const *);
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[], int);
158
159int cucul_draw_circle(cucul_canvas_t *, int, int, int, char const *);
160int cucul_draw_ellipse(cucul_canvas_t *, int, int, int, int, char const *);
161int cucul_draw_thin_ellipse(cucul_canvas_t *, int, int, int, int);
162int cucul_fill_ellipse(cucul_canvas_t *, int, int, int, int, char const *);
163
164int cucul_draw_box(cucul_canvas_t *, int, int, int, int, char const *);
165int cucul_draw_thin_box(cucul_canvas_t *, int, int, int, int);
166int cucul_fill_box(cucul_canvas_t *, int, int, int, int, char const *);
167
168int cucul_draw_triangle(cucul_canvas_t *, int, int, int, int, int, int, char const *);
169int cucul_draw_thin_triangle(cucul_canvas_t *, int, int, int, int, int, int);
170int cucul_fill_triangle(cucul_canvas_t *, int, int, int, int, int, int, char const *);
171/*  @} */
172
173/** \defgroup frame libcucul canvas frame handling
174 *
175 *  These functions provide high level routines for canvas frame insertion,
176 *  removal, copying etc.
177 *
178 *  @{ */
179unsigned int cucul_get_canvas_frame_count(cucul_canvas_t *);
180int cucul_set_canvas_frame(cucul_canvas_t *, unsigned int);
181int cucul_create_canvas_frame(cucul_canvas_t *, unsigned int);
182int cucul_free_canvas_frame(cucul_canvas_t *, unsigned int);
183/*  @} */
184
185/** \defgroup dither libcucul bitmap dithering
186 *
187 *  These functions provide high level routines for dither allocation and
188 *  rendering.
189 *
190 *  @{ */
191cucul_dither_t *cucul_create_dither(unsigned int, unsigned int,
192                                    unsigned int, unsigned int,
193                                    unsigned long int, unsigned long int,
194                                    unsigned long int, unsigned long int);
195int cucul_set_dither_palette(cucul_dither_t *,
196                             unsigned int r[], unsigned int g[],
197                             unsigned int b[], unsigned int a[]);
198int cucul_set_dither_brightness(cucul_dither_t *, float);
199int cucul_set_dither_gamma(cucul_dither_t *, float);
200int cucul_set_dither_contrast(cucul_dither_t *, float);
201int cucul_set_dither_invert(cucul_dither_t *, int);
202int cucul_set_dither_antialias(cucul_dither_t *, char const *);
203char const * const * cucul_get_dither_antialias_list(cucul_dither_t const *);
204int cucul_set_dither_color(cucul_dither_t *, char const *);
205char const * const * cucul_get_dither_color_list(cucul_dither_t const *);
206int cucul_set_dither_charset(cucul_dither_t *, char const *);
207char const * const * cucul_get_dither_charset_list(cucul_dither_t const *);
208int cucul_set_dither_mode(cucul_dither_t *, char const *);
209char const * const * cucul_get_dither_mode_list(cucul_dither_t const *);
210int cucul_dither_bitmap(cucul_canvas_t *, int, int, int, int,
211                         cucul_dither_t const *, void *);
212int cucul_free_dither(cucul_dither_t *);
213/*  @} */
214
215/** \defgroup font libcucul font handling
216 *
217 *  These functions provide font handling routines and high quality
218 *  canvas to bitmap rendering.
219 *
220 *  @{ */
221cucul_font_t *cucul_load_font(void const *, unsigned int);
222char const * const * cucul_get_font_list(void);
223unsigned int cucul_get_font_width(cucul_font_t *);
224unsigned int cucul_get_font_height(cucul_font_t *);
225unsigned long int const *cucul_get_font_blocks(cucul_font_t *);
226int cucul_render_canvas(cucul_canvas_t *, cucul_font_t *, void *,
227                         unsigned int, unsigned int, unsigned int);
228int cucul_free_font(cucul_font_t *);
229/*  @} */
230
231/** \defgroup importexport libcucul importers/exporters from/to various formats
232 *
233 *  These functions import various file formats into a new canvas, or export
234 *  the current canvas to various text formats.
235 *
236 *  @{ */
237cucul_buffer_t * cucul_export_canvas(cucul_canvas_t *, char const *);
238char const * const * cucul_get_export_list(void);
239cucul_canvas_t * cucul_import_canvas(cucul_buffer_t *, char const *);
240char const * const * cucul_get_import_list(void);
241/*  @} */
242
243#ifdef __cplusplus
244}
245#endif
246
247#endif /* __CUCUL_H__ */
Note: See TracBrowser for help on using the repository browser.