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

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