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

Last change on this file since 734 was 734, checked in by Sam Hocevar, 15 years ago
  • Renamed *bitmap to *dither. Ben ouais connard, je fais ce que je veux.
  • Property svn:keywords set to Id
File size: 7.5 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 *  This library is free software; you can redistribute it and/or
7 *  modify it under the terms of the Do What The Fuck You Want To
8 *  Public License, Version 2, as published by Sam Hocevar. See
9 *  http://sam.zoy.org/wtfpl/COPYING for more details.
10 */
11
12/** \file cucul.h
13 *  \version \$Id: cucul.h 734 2006-04-10 20:02:38Z sam $
14 *  \author Sam Hocevar <sam@zoy.org>
15 *  \brief The \e libcucul public header.
16 *
17 *  This header contains the public types and functions that applications
18 *  using \e libcucul may use.
19 */
20
21#ifndef __CUCUL_H__
22#define __CUCUL_H__
23
24#define CUCUL_API_VERSION_1
25
26#ifdef __cplusplus
27extern "C"
28{
29#endif
30
31typedef struct cucul_context cucul_t;
32
33/** \defgroup colour Colour definitions
34 *
35 *  Colours that can be used with cucul_set_color().
36 *
37 *  @{ */
38#define CUCUL_COLOR_BLACK 0x00 /**< The colour index for black. */
39#define CUCUL_COLOR_BLUE 0x01 /**< The colour index for blue. */
40#define CUCUL_COLOR_GREEN 0x02 /**< The colour index for green. */
41#define CUCUL_COLOR_CYAN 0x03 /**< The colour index for cyan. */
42#define CUCUL_COLOR_RED 0x04 /**< The colour index for red. */
43#define CUCUL_COLOR_MAGENTA 0x05 /**< The colour index for magenta. */
44#define CUCUL_COLOR_BROWN 0x06 /**< The colour index for brown. */
45#define CUCUL_COLOR_LIGHTGRAY 0x07 /**< The colour index for light gray. */
46#define CUCUL_COLOR_DARKGRAY 0x08 /**< The colour index for dark gray. */
47#define CUCUL_COLOR_LIGHTBLUE 0x09 /**< The colour index for blue. */
48#define CUCUL_COLOR_LIGHTGREEN 0x0a /**< The colour index for light green. */
49#define CUCUL_COLOR_LIGHTCYAN 0x0b /**< The colour index for light cyan. */
50#define CUCUL_COLOR_LIGHTRED 0x0c /**< The colour index for light red. */
51#define CUCUL_COLOR_LIGHTMAGENTA 0x0d /**< The colour index for light magenta. */
52#define CUCUL_COLOR_YELLOW 0x0e /**< The colour index for yellow. */
53#define CUCUL_COLOR_WHITE 0x0f /**< The colour index for white. */
54#define CUCUL_COLOR_DEFAULT 0x10 /**< The output driver's default colour. */
55#define CUCUL_COLOR_TRANSPARENT 0x20 /**< The transparent colour. */
56/*  @} */
57
58/** \defgroup basic Basic functions
59 *
60 *  These functions provide the basic \e libcaca routines for library
61 *  initialisation, system information retrieval and configuration.
62 *
63 *  @{ */
64cucul_t * cucul_create(unsigned int, unsigned int);
65cucul_t * cucul_load(void *, unsigned int);
66void cucul_set_size(cucul_t *, unsigned int, unsigned int);
67unsigned int cucul_get_width(cucul_t *);
68unsigned int cucul_get_height(cucul_t *);
69void cucul_free(cucul_t *);
70/*  @} */
71
72/** \defgroup canvas Canvas drawing
73 *
74 *  These functions provide low-level character printing routines and
75 *  higher level graphics functions.
76 *
77 *  @{ */
78void cucul_set_color(cucul_t *, unsigned int, unsigned int);
79char const *cucul_get_color_name(unsigned int);
80void cucul_putchar(cucul_t *, int, int, char);
81void cucul_putstr(cucul_t *, int, int, char const *);
82void cucul_printf(cucul_t *, int, int, char const *, ...);
83void cucul_clear(cucul_t *);
84void cucul_blit(cucul_t *, int, int, cucul_t const *, cucul_t const *);
85/*  @} */
86
87/** \defgroup transform Canvas transformation
88 *
89 *  These functions perform horizontal and vertical canvas flipping.
90 *
91 *  @{ */
92void cucul_invert(cucul_t *);
93void cucul_flip(cucul_t *);
94void cucul_flop(cucul_t *);
95void cucul_rotate(cucul_t *);
96/*  @} */
97
98/** \defgroup prim Primitives drawing
99 *
100 *  These functions provide routines for primitive drawing, such as lines,
101 *  boxes, triangles and ellipses.
102 *
103 *  @{ */
104void cucul_draw_line(cucul_t *, int, int, int, int, char const *);
105void cucul_draw_polyline(cucul_t *, int const x[], int const y[], int, char const *);
106void cucul_draw_thin_line(cucul_t *, int, int, int, int);
107void cucul_draw_thin_polyline(cucul_t *, int const x[], int const y[], int);
108
109void cucul_draw_circle(cucul_t *, int, int, int, char const *);
110void cucul_draw_ellipse(cucul_t *, int, int, int, int, char const *);
111void cucul_draw_thin_ellipse(cucul_t *, int, int, int, int);
112void cucul_fill_ellipse(cucul_t *, int, int, int, int, char const *);
113
114void cucul_draw_box(cucul_t *, int, int, int, int, char const *);
115void cucul_draw_thin_box(cucul_t *, int, int, int, int);
116void cucul_fill_box(cucul_t *, int, int, int, int, char const *);
117
118void cucul_draw_triangle(cucul_t *, int, int, int, int, int, int, char const *);
119void cucul_draw_thin_triangle(cucul_t *, int, int, int, int, int, int);
120void cucul_fill_triangle(cucul_t *, int, int, int, int, int, int, char const *);
121/*  @} */
122
123/** \defgroup math Mathematical functions
124 *
125 *  These functions provide a few useful math-related routines.
126 *
127 *  @{ */
128int cucul_rand(int, int);
129unsigned int cucul_sqrt(unsigned int);
130/*  @} */
131
132/** \defgroup sprite Sprite handling
133 *
134 *  These functions provide high level routines for sprite loading, animation
135 *  and rendering.
136 *
137 *  @{ */
138struct cucul_sprite;
139struct cucul_sprite * cucul_load_sprite(cucul_t *, char const *);
140int cucul_get_sprite_frames(cucul_t *, struct cucul_sprite const *);
141int cucul_get_sprite_width(cucul_t *, struct cucul_sprite const *, int);
142int cucul_get_sprite_height(cucul_t *, struct cucul_sprite const *, int);
143int cucul_get_sprite_dx(cucul_t *, struct cucul_sprite const *, int);
144int cucul_get_sprite_dy(cucul_t *, struct cucul_sprite const *, int);
145void cucul_draw_sprite(cucul_t *, int, int, struct cucul_sprite const *, int);
146void cucul_free_sprite(struct cucul_sprite *);
147/*  @} */
148
149/** \defgroup dither Bitmap dithering
150 *
151 *  These functions provide high level routines for dither allocation and
152 *  rendering.
153 *
154 *  @{ */
155struct cucul_dither;
156struct cucul_dither *cucul_create_dither(unsigned int, unsigned int,
157                                         unsigned int, unsigned int,
158                                         unsigned int, unsigned int,
159                                         unsigned int, unsigned int);
160void cucul_set_dither_palette(struct cucul_dither *,
161                              unsigned int r[], unsigned int g[],
162                              unsigned int b[], unsigned int a[]);
163void cucul_set_dither_brightness(struct cucul_dither *, float);
164void cucul_set_dither_gamma(struct cucul_dither *, float);
165void cucul_set_dither_contrast(struct cucul_dither *, float);
166void cucul_set_dither_invert(struct cucul_dither *, int);
167void cucul_set_dither_antialias(struct cucul_dither *, char const *);
168char const * const * cucul_get_dither_antialias_list(struct cucul_dither const *);
169void cucul_set_dither_color(struct cucul_dither *, char const *);
170char const * const * cucul_get_dither_color_list(struct cucul_dither const *);
171void cucul_set_dither_charset(struct cucul_dither *, char const *);
172char const * const * cucul_get_dither_charset_list(struct cucul_dither const *);
173void cucul_set_dither_mode(struct cucul_dither *, char const *);
174char const * const * cucul_get_dither_mode_list(struct cucul_dither const *);
175void cucul_dither_bitmap(cucul_t *, int, int, int, int,
176                         struct cucul_dither const *, void *);
177void cucul_free_dither(struct cucul_dither *);
178/*  @} */
179
180/** \defgroup exporter Exporters to various formats
181 *
182 *  These functions export the current canvas to various text formats. It
183 *  is necessary to call cucul_free_export() to dispose of the data.
184 *
185 *  @{ */
186struct cucul_export
187{
188    unsigned int size;
189    char *buffer;
190};
191
192struct cucul_export * cucul_create_export(cucul_t *, char const *);
193char const * const * cucul_get_export_list(void);
194void cucul_free_export(struct cucul_export *);
195/*  @} */
196
197#ifdef __cplusplus
198}
199#endif
200
201#endif /* __CUCUL_H__ */
Note: See TracBrowser for help on using the repository browser.