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

Last change on this file since 824 was 824, checked in by Sam Hocevar, 16 years ago
  • Documentation improvements. Wrote a small migration guide and added the skeleton of a tutorial for Jylam.
  • Property svn:keywords set to Id
File size: 8.6 KB
RevLine 
[79]1/*
[672]2 *  libcucul      Canvas for ultrafast compositing of Unicode letters
[524]3 *  Copyright (c) 2002-2006 Sam Hocevar <sam@zoy.org>
[268]4 *                All Rights Reserved
[79]5 *
[769]6 *  $Id: cucul.h 824 2006-04-21 18:03:22Z sam $
7 *
[268]8 *  This library is free software; you can redistribute it and/or
[522]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.
[79]12 */
13
[524]14/** \file cucul.h
[268]15 *  \version \$Id: cucul.h 824 2006-04-21 18:03:22Z sam $
16 *  \author Sam Hocevar <sam@zoy.org>
[524]17 *  \brief The \e libcucul public header.
[205]18 *
[268]19 *  This header contains the public types and functions that applications
[524]20 *  using \e libcucul may use.
[205]21 */
22
[524]23#ifndef __CUCUL_H__
24#define __CUCUL_H__
[205]25
[773]26/** libcucul API version */
[644]27#define CUCUL_API_VERSION_1
28
[153]29#ifdef __cplusplus
30extern "C"
31{
32#endif
33
[777]34/** \e libcucul context */
[810]35typedef struct cucul_canvas cucul_canvas_t;
[777]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;
[733]44
[824]45/** \defgroup colour libcucul colour definitions
[267]46 *
[609]47 *  Colours that can be used with cucul_set_color().
[733]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/*  @} */
[79]69
[824]70/** \defgroup cucul libcucul basic functions
[268]71 *
72 *  These functions provide the basic \e libcaca routines for library
73 *  initialisation, system information retrieval and configuration.
74 *
75 *  @{ */
[813]76cucul_canvas_t * cucul_create_canvas(unsigned int, unsigned int);
77cucul_canvas_t * cucul_load_canvas(void *, unsigned int);
78void cucul_set_canvas_size(cucul_canvas_t *, unsigned int, unsigned int);
79unsigned int cucul_get_canvas_width(cucul_canvas_t *);
80unsigned int cucul_get_canvas_height(cucul_canvas_t *);
81void cucul_free_canvas(cucul_canvas_t *);
[795]82int cucul_rand(int, int);
[268]83/*  @} */
[79]84
[824]85/** \defgroup buffer libcucul buffer handling
[777]86 *
87 *  These functions provide methods to handle libcucul buffers.
88 *
89 *  @{ */
90unsigned long int cucul_get_buffer_size(cucul_buffer_t *);
91void * cucul_get_buffer_data(cucul_buffer_t *);
92void cucul_free_buffer(cucul_buffer_t *);
93/*  @} */
94
[824]95/** \defgroup canvas libcucul canvas drawing
[268]96 *
[670]97 *  These functions provide low-level character printing routines and
98 *  higher level graphics functions.
[268]99 *
100 *  @{ */
[810]101void cucul_set_color(cucul_canvas_t *, unsigned char, unsigned char);
102void cucul_set_truecolor(cucul_canvas_t *, unsigned int, unsigned int);
[733]103char const *cucul_get_color_name(unsigned int);
[810]104void cucul_putchar(cucul_canvas_t *, int, int, char);
105void cucul_putstr(cucul_canvas_t *, int, int, char const *);
106void cucul_printf(cucul_canvas_t *, int, int, char const *, ...);
[814]107void cucul_clear_canvas(cucul_canvas_t *, unsigned char);
[810]108void cucul_blit(cucul_canvas_t *, int, int, cucul_canvas_t const *, cucul_canvas_t const *);
[268]109/*  @} */
[147]110
[824]111/** \defgroup transform libcucul canvas transformation
[673]112 *
113 *  These functions perform horizontal and vertical canvas flipping.
114 *
115 *  @{ */
[810]116void cucul_invert(cucul_canvas_t *);
117void cucul_flip(cucul_canvas_t *);
118void cucul_flop(cucul_canvas_t *);
119void cucul_rotate(cucul_canvas_t *);
[673]120/*  @} */
121
[824]122/** \defgroup prim libcucul primitives drawing
[268]123 *
124 *  These functions provide routines for primitive drawing, such as lines,
125 *  boxes, triangles and ellipses.
126 *
127 *  @{ */
[810]128void cucul_draw_line(cucul_canvas_t *, int, int, int, int, char const *);
129void cucul_draw_polyline(cucul_canvas_t *, int const x[], int const y[], int, char const *);
130void cucul_draw_thin_line(cucul_canvas_t *, int, int, int, int);
131void cucul_draw_thin_polyline(cucul_canvas_t *, int const x[], int const y[], int);
[151]132
[810]133void cucul_draw_circle(cucul_canvas_t *, int, int, int, char const *);
134void cucul_draw_ellipse(cucul_canvas_t *, int, int, int, int, char const *);
135void cucul_draw_thin_ellipse(cucul_canvas_t *, int, int, int, int);
136void cucul_fill_ellipse(cucul_canvas_t *, int, int, int, int, char const *);
[151]137
[810]138void cucul_draw_box(cucul_canvas_t *, int, int, int, int, char const *);
139void cucul_draw_thin_box(cucul_canvas_t *, int, int, int, int);
140void cucul_fill_box(cucul_canvas_t *, int, int, int, int, char const *);
[151]141
[810]142void cucul_draw_triangle(cucul_canvas_t *, int, int, int, int, int, int, char const *);
143void cucul_draw_thin_triangle(cucul_canvas_t *, int, int, int, int, int, int);
144void cucul_fill_triangle(cucul_canvas_t *, int, int, int, int, int, int, char const *);
[268]145/*  @} */
[95]146
[824]147/** \defgroup sprite libcucul sprite handling
[268]148 *
149 *  These functions provide high level routines for sprite loading, animation
150 *  and rendering.
151 *
152 *  @{ */
[777]153cucul_sprite_t * cucul_load_sprite(char const *);
154int cucul_get_sprite_frames(cucul_sprite_t const *);
155int cucul_get_sprite_width(cucul_sprite_t const *, int);
156int cucul_get_sprite_height(cucul_sprite_t const *, int);
157int cucul_get_sprite_dx(cucul_sprite_t const *, int);
158int cucul_get_sprite_dy(cucul_sprite_t const *, int);
[810]159void cucul_draw_sprite(cucul_canvas_t *, int, int, cucul_sprite_t const *, int);
[777]160void cucul_free_sprite(cucul_sprite_t *);
[268]161/*  @} */
[115]162
[824]163/** \defgroup dither libcucul bitmap dithering
[268]164 *
[734]165 *  These functions provide high level routines for dither allocation and
[268]166 *  rendering.
167 *
168 *  @{ */
[777]169cucul_dither_t *cucul_create_dither(unsigned int, unsigned int,
[666]170                                         unsigned int, unsigned int,
171                                         unsigned int, unsigned int,
172                                         unsigned int, unsigned int);
[777]173void cucul_set_dither_palette(cucul_dither_t *,
[653]174                              unsigned int r[], unsigned int g[],
175                              unsigned int b[], unsigned int a[]);
[777]176void cucul_set_dither_brightness(cucul_dither_t *, float);
177void cucul_set_dither_gamma(cucul_dither_t *, float);
178void cucul_set_dither_contrast(cucul_dither_t *, float);
179void cucul_set_dither_invert(cucul_dither_t *, int);
180void cucul_set_dither_antialias(cucul_dither_t *, char const *);
181char const * const * cucul_get_dither_antialias_list(cucul_dither_t const *);
182void cucul_set_dither_color(cucul_dither_t *, char const *);
183char const * const * cucul_get_dither_color_list(cucul_dither_t const *);
184void cucul_set_dither_charset(cucul_dither_t *, char const *);
185char const * const * cucul_get_dither_charset_list(cucul_dither_t const *);
186void cucul_set_dither_mode(cucul_dither_t *, char const *);
187char const * const * cucul_get_dither_mode_list(cucul_dither_t const *);
[810]188void cucul_dither_bitmap(cucul_canvas_t *, int, int, int, int,
[777]189                         cucul_dither_t const *, void *);
190void cucul_free_dither(cucul_dither_t *);
[268]191/*  @} */
[183]192
[824]193/** \defgroup font libcucul font handling
[746]194 *
195 *  These functions provide font handling routines and high quality
196 *  canvas to bitmap rendering.
197 *
198 *  @{ */
[777]199cucul_font_t *cucul_load_font(void const *, unsigned int);
[763]200char const * const * cucul_get_font_list(void);
[777]201unsigned int cucul_get_font_width(cucul_font_t *);
202unsigned int cucul_get_font_height(cucul_font_t *);
[810]203void cucul_render_canvas(cucul_canvas_t *, cucul_font_t *, void *,
[758]204                         unsigned int, unsigned int, unsigned int);
[777]205void cucul_free_font(cucul_font_t *);
[746]206/*  @} */
207
[824]208/** \defgroup exporter libcucul exporters to various formats
[485]209 *
[609]210 *  These functions export the current canvas to various text formats. It
[777]211 *  is necessary to call cucul_free_buffer() to dispose of the data.
[485]212 *
213 *  @{ */
[810]214cucul_buffer_t * cucul_create_export(cucul_canvas_t *, char const *);
[708]215char const * const * cucul_get_export_list(void);
[485]216/*  @} */
217
[153]218#ifdef __cplusplus
219}
220#endif
221
[524]222#endif /* __CUCUL_H__ */
Note: See TracBrowser for help on using the repository browser.