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

Last change on this file since 777 was 777, checked in by Sam Hocevar, 15 years ago
  • Replaced "struct cucul_*" and "struct caca_*" types with opaque typedefs such as cucul_dither_t instead of struct cucul_dither.
  • Made cucul_buffer_t an opaque structure and implemented the two getters cucul_get_buffer_data() and cucul_get_buffer_size().
  • Documented all missing functions and function parameters.
  • Property svn:keywords set to Id
File size: 8.3 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 777 2006-04-16 18:28:47Z 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 777 2006-04-16 18:28:47Z 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 context */
35typedef struct cucul cucul_t;
36/** sprite structure */
37typedef struct cucul_sprite cucul_sprite_t;
38/** dither structure */
39typedef struct cucul_dither cucul_dither_t;
40/** data buffer structure */
41typedef struct cucul_buffer cucul_buffer_t;
42/** font structure */
43typedef struct cucul_font cucul_font_t;
44
45/** \defgroup colour Colour definitions
46 *
47 *  Colours that can be used with cucul_set_color().
48 *
49 *  @{ */
50#define CUCUL_COLOR_BLACK 0x00 /**< The colour index for black. */
51#define CUCUL_COLOR_BLUE 0x01 /**< The colour index for blue. */
52#define CUCUL_COLOR_GREEN 0x02 /**< The colour index for green. */
53#define CUCUL_COLOR_CYAN 0x03 /**< The colour index for cyan. */
54#define CUCUL_COLOR_RED 0x04 /**< The colour index for red. */
55#define CUCUL_COLOR_MAGENTA 0x05 /**< The colour index for magenta. */
56#define CUCUL_COLOR_BROWN 0x06 /**< The colour index for brown. */
57#define CUCUL_COLOR_LIGHTGRAY 0x07 /**< The colour index for light gray. */
58#define CUCUL_COLOR_DARKGRAY 0x08 /**< The colour index for dark gray. */
59#define CUCUL_COLOR_LIGHTBLUE 0x09 /**< The colour index for blue. */
60#define CUCUL_COLOR_LIGHTGREEN 0x0a /**< The colour index for light green. */
61#define CUCUL_COLOR_LIGHTCYAN 0x0b /**< The colour index for light cyan. */
62#define CUCUL_COLOR_LIGHTRED 0x0c /**< The colour index for light red. */
63#define CUCUL_COLOR_LIGHTMAGENTA 0x0d /**< The colour index for light magenta. */
64#define CUCUL_COLOR_YELLOW 0x0e /**< The colour index for yellow. */
65#define CUCUL_COLOR_WHITE 0x0f /**< The colour index for white. */
66#define CUCUL_COLOR_DEFAULT 0x10 /**< The output driver's default colour. */
67#define CUCUL_COLOR_TRANSPARENT 0x20 /**< The transparent colour. */
68/*  @} */
69
70/** \defgroup cucul Basic libcucul functions
71 *
72 *  These functions provide the basic \e libcaca routines for library
73 *  initialisation, system information retrieval and configuration.
74 *
75 *  @{ */
76cucul_t * cucul_create(unsigned int, unsigned int);
77cucul_t * cucul_load(void *, unsigned int);
78void cucul_set_size(cucul_t *, unsigned int, unsigned int);
79unsigned int cucul_get_width(cucul_t *);
80unsigned int cucul_get_height(cucul_t *);
81void cucul_free(cucul_t *);
82/*  @} */
83
84/** \defgroup buffer Buffer handling
85 *
86 *  These functions provide methods to handle libcucul buffers.
87 *
88 *  @{ */
89unsigned long int cucul_get_buffer_size(cucul_buffer_t *);
90void * cucul_get_buffer_data(cucul_buffer_t *);
91void cucul_free_buffer(cucul_buffer_t *);
92/*  @} */
93
94/** \defgroup canvas Canvas drawing
95 *
96 *  These functions provide low-level character printing routines and
97 *  higher level graphics functions.
98 *
99 *  @{ */
100void cucul_set_color(cucul_t *, unsigned int, unsigned int);
101char const *cucul_get_color_name(unsigned int);
102void cucul_putchar(cucul_t *, int, int, char);
103void cucul_putstr(cucul_t *, int, int, char const *);
104void cucul_printf(cucul_t *, int, int, char const *, ...);
105void cucul_clear(cucul_t *);
106void cucul_blit(cucul_t *, int, int, cucul_t const *, cucul_t const *);
107/*  @} */
108
109/** \defgroup transform Canvas transformation
110 *
111 *  These functions perform horizontal and vertical canvas flipping.
112 *
113 *  @{ */
114void cucul_invert(cucul_t *);
115void cucul_flip(cucul_t *);
116void cucul_flop(cucul_t *);
117void cucul_rotate(cucul_t *);
118/*  @} */
119
120/** \defgroup prim Primitives drawing
121 *
122 *  These functions provide routines for primitive drawing, such as lines,
123 *  boxes, triangles and ellipses.
124 *
125 *  @{ */
126void cucul_draw_line(cucul_t *, int, int, int, int, char const *);
127void cucul_draw_polyline(cucul_t *, int const x[], int const y[], int, char const *);
128void cucul_draw_thin_line(cucul_t *, int, int, int, int);
129void cucul_draw_thin_polyline(cucul_t *, int const x[], int const y[], int);
130
131void cucul_draw_circle(cucul_t *, int, int, int, char const *);
132void cucul_draw_ellipse(cucul_t *, int, int, int, int, char const *);
133void cucul_draw_thin_ellipse(cucul_t *, int, int, int, int);
134void cucul_fill_ellipse(cucul_t *, int, int, int, int, char const *);
135
136void cucul_draw_box(cucul_t *, int, int, int, int, char const *);
137void cucul_draw_thin_box(cucul_t *, int, int, int, int);
138void cucul_fill_box(cucul_t *, int, int, int, int, char const *);
139
140void cucul_draw_triangle(cucul_t *, int, int, int, int, int, int, char const *);
141void cucul_draw_thin_triangle(cucul_t *, int, int, int, int, int, int);
142void cucul_fill_triangle(cucul_t *, int, int, int, int, int, int, char const *);
143/*  @} */
144
145/** \defgroup math Mathematical functions
146 *
147 *  These functions provide a few useful math-related routines.
148 *
149 *  @{ */
150int cucul_rand(int, int);
151unsigned int cucul_sqrt(unsigned int);
152/*  @} */
153
154/** \defgroup sprite Sprite handling
155 *
156 *  These functions provide high level routines for sprite loading, animation
157 *  and rendering.
158 *
159 *  @{ */
160cucul_sprite_t * cucul_load_sprite(char const *);
161int cucul_get_sprite_frames(cucul_sprite_t const *);
162int cucul_get_sprite_width(cucul_sprite_t const *, int);
163int cucul_get_sprite_height(cucul_sprite_t const *, int);
164int cucul_get_sprite_dx(cucul_sprite_t const *, int);
165int cucul_get_sprite_dy(cucul_sprite_t const *, int);
166void cucul_draw_sprite(cucul_t *, int, int, cucul_sprite_t const *, int);
167void cucul_free_sprite(cucul_sprite_t *);
168/*  @} */
169
170/** \defgroup dither Bitmap dithering
171 *
172 *  These functions provide high level routines for dither allocation and
173 *  rendering.
174 *
175 *  @{ */
176cucul_dither_t *cucul_create_dither(unsigned int, unsigned int,
177                                         unsigned int, unsigned int,
178                                         unsigned int, unsigned int,
179                                         unsigned int, unsigned int);
180void cucul_set_dither_palette(cucul_dither_t *,
181                              unsigned int r[], unsigned int g[],
182                              unsigned int b[], unsigned int a[]);
183void cucul_set_dither_brightness(cucul_dither_t *, float);
184void cucul_set_dither_gamma(cucul_dither_t *, float);
185void cucul_set_dither_contrast(cucul_dither_t *, float);
186void cucul_set_dither_invert(cucul_dither_t *, int);
187void cucul_set_dither_antialias(cucul_dither_t *, char const *);
188char const * const * cucul_get_dither_antialias_list(cucul_dither_t const *);
189void cucul_set_dither_color(cucul_dither_t *, char const *);
190char const * const * cucul_get_dither_color_list(cucul_dither_t const *);
191void cucul_set_dither_charset(cucul_dither_t *, char const *);
192char const * const * cucul_get_dither_charset_list(cucul_dither_t const *);
193void cucul_set_dither_mode(cucul_dither_t *, char const *);
194char const * const * cucul_get_dither_mode_list(cucul_dither_t const *);
195void cucul_dither_bitmap(cucul_t *, int, int, int, int,
196                         cucul_dither_t const *, void *);
197void cucul_free_dither(cucul_dither_t *);
198/*  @} */
199
200/** \defgroup font Font handling
201 *
202 *  These functions provide font handling routines and high quality
203 *  canvas to bitmap rendering.
204 *
205 *  @{ */
206cucul_font_t *cucul_load_font(void const *, unsigned int);
207char const * const * cucul_get_font_list(void);
208unsigned int cucul_get_font_width(cucul_font_t *);
209unsigned int cucul_get_font_height(cucul_font_t *);
210void cucul_render_canvas(cucul_t *, cucul_font_t *, unsigned char *,
211                         unsigned int, unsigned int, unsigned int);
212void cucul_free_font(cucul_font_t *);
213/*  @} */
214
215/** \defgroup exporter Exporters to various formats
216 *
217 *  These functions export the current canvas to various text formats. It
218 *  is necessary to call cucul_free_buffer() to dispose of the data.
219 *
220 *  @{ */
221cucul_buffer_t * cucul_create_export(cucul_t *, char const *);
222char const * const * cucul_get_export_list(void);
223/*  @} */
224
225#ifdef __cplusplus
226}
227#endif
228
229#endif /* __CUCUL_H__ */
Note: See TracBrowser for help on using the repository browser.