No puede seleccionar más de 25 temas Los temas deben comenzar con una letra o número, pueden incluir guiones ('-') y pueden tener hasta 35 caracteres de largo.

cucul.h 7.5 KiB

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