Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.

cucul.h 8.1 KiB

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