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

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