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

Last change on this file since 874 was 874, checked in by Sam Hocevar, 15 years ago
  • More error checking in libcucul.
  • Property svn:keywords set to Id
File size: 8.4 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 874 2006-04-25 11:05:25Z 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 874 2006-04-25 11:05:25Z 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 *  @{ */
87unsigned long int cucul_get_buffer_size(cucul_buffer_t *);
88void * cucul_get_buffer_data(cucul_buffer_t *);
89int cucul_free_buffer(cucul_buffer_t *);
90/*  @} */
91
92/** \defgroup canvas libcucul canvas drawing
93 *
94 *  These functions provide low-level character printing routines and
95 *  higher level graphics functions.
96 *
97 *  @{ */
98int cucul_set_color(cucul_canvas_t *, unsigned char, unsigned char);
99int cucul_set_truecolor(cucul_canvas_t *, unsigned int, unsigned int);
100char const *cucul_get_color_name(unsigned int);
101int cucul_putchar(cucul_canvas_t *, int, int, char);
102int cucul_putstr(cucul_canvas_t *, int, int, char const *);
103int cucul_printf(cucul_canvas_t *, int, int, char const *, ...);
104int cucul_clear_canvas(cucul_canvas_t *);
105int cucul_blit(cucul_canvas_t *, int, int, cucul_canvas_t const *, cucul_canvas_t const *);
106/*  @} */
107
108/** \defgroup transform libcucul canvas transformation
109 *
110 *  These functions perform horizontal and vertical canvas flipping.
111 *
112 *  @{ */
113void cucul_invert(cucul_canvas_t *);
114void cucul_flip(cucul_canvas_t *);
115void cucul_flop(cucul_canvas_t *);
116void cucul_rotate(cucul_canvas_t *);
117/*  @} */
118
119/** \defgroup prim libcucul primitives drawing
120 *
121 *  These functions provide routines for primitive drawing, such as lines,
122 *  boxes, triangles and ellipses.
123 *
124 *  @{ */
125int cucul_draw_line(cucul_canvas_t *, int, int, int, int, char const *);
126int cucul_draw_polyline(cucul_canvas_t *, int const x[], int const y[], int, char const *);
127int cucul_draw_thin_line(cucul_canvas_t *, int, int, int, int);
128int cucul_draw_thin_polyline(cucul_canvas_t *, int const x[], int const y[], int);
129
130int cucul_draw_circle(cucul_canvas_t *, int, int, int, char const *);
131int cucul_draw_ellipse(cucul_canvas_t *, int, int, int, int, char const *);
132int cucul_draw_thin_ellipse(cucul_canvas_t *, int, int, int, int);
133int cucul_fill_ellipse(cucul_canvas_t *, int, int, int, int, char const *);
134
135int cucul_draw_box(cucul_canvas_t *, int, int, int, int, char const *);
136int cucul_draw_thin_box(cucul_canvas_t *, int, int, int, int);
137int cucul_fill_box(cucul_canvas_t *, int, int, int, int, char const *);
138
139int cucul_draw_triangle(cucul_canvas_t *, int, int, int, int, int, int, char const *);
140int cucul_draw_thin_triangle(cucul_canvas_t *, int, int, int, int, int, int);
141int cucul_fill_triangle(cucul_canvas_t *, int, int, int, int, int, int, char const *);
142/*  @} */
143
144/** \defgroup frame libcucul canvas frame handling
145 *
146 *  These functions provide high level routines for canvas frame insertion,
147 *  removal, copying etc.
148 *
149 *  @{ */
150unsigned int cucul_get_canvas_frame_count(cucul_canvas_t *);
151void cucul_set_canvas_frame(cucul_canvas_t *, unsigned int);
152void cucul_create_canvas_frame(cucul_canvas_t *, unsigned int);
153void cucul_free_canvas_frame(cucul_canvas_t *, unsigned int);
154/*  @} */
155
156/** \defgroup dither libcucul bitmap dithering
157 *
158 *  These functions provide high level routines for dither allocation and
159 *  rendering.
160 *
161 *  @{ */
162cucul_dither_t *cucul_create_dither(unsigned int, unsigned int,
163                                    unsigned int, unsigned int,
164                                    unsigned int, unsigned int,
165                                    unsigned int, unsigned int);
166void cucul_set_dither_palette(cucul_dither_t *,
167                              unsigned int r[], unsigned int g[],
168                              unsigned int b[], unsigned int a[]);
169void cucul_set_dither_brightness(cucul_dither_t *, float);
170void cucul_set_dither_gamma(cucul_dither_t *, float);
171void cucul_set_dither_contrast(cucul_dither_t *, float);
172void cucul_set_dither_invert(cucul_dither_t *, int);
173void cucul_set_dither_antialias(cucul_dither_t *, char const *);
174char const * const * cucul_get_dither_antialias_list(cucul_dither_t const *);
175void cucul_set_dither_color(cucul_dither_t *, char const *);
176char const * const * cucul_get_dither_color_list(cucul_dither_t const *);
177void cucul_set_dither_charset(cucul_dither_t *, char const *);
178char const * const * cucul_get_dither_charset_list(cucul_dither_t const *);
179void cucul_set_dither_mode(cucul_dither_t *, char const *);
180char const * const * cucul_get_dither_mode_list(cucul_dither_t const *);
181void cucul_dither_bitmap(cucul_canvas_t *, int, int, int, int,
182                         cucul_dither_t const *, void *);
183void cucul_free_dither(cucul_dither_t *);
184/*  @} */
185
186/** \defgroup font libcucul font handling
187 *
188 *  These functions provide font handling routines and high quality
189 *  canvas to bitmap rendering.
190 *
191 *  @{ */
192cucul_font_t *cucul_load_font(void const *, unsigned int);
193char const * const * cucul_get_font_list(void);
194unsigned int cucul_get_font_width(cucul_font_t *);
195unsigned int cucul_get_font_height(cucul_font_t *);
196void cucul_render_canvas(cucul_canvas_t *, cucul_font_t *, void *,
197                         unsigned int, unsigned int, unsigned int);
198void cucul_free_font(cucul_font_t *);
199/*  @} */
200
201/** \defgroup importexport libcucul importers/exporters from/to various formats
202 *
203 *  These functions import various file formats into a new canvas, or export
204 *  the current canvas to various text formats.
205 *
206 *  @{ */
207cucul_buffer_t * cucul_export_canvas(cucul_canvas_t *, char const *);
208char const * const * cucul_get_export_list(void);
209cucul_canvas_t * cucul_import_canvas(void const *, unsigned int, char const *);
210char const * const * cucul_get_import_list(void);
211/*  @} */
212
213#ifdef __cplusplus
214}
215#endif
216
217#endif /* __CUCUL_H__ */
Note: See TracBrowser for help on using the repository browser.