Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223
  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. /** libcucul API version */
  24. #define CUCUL_API_VERSION_1
  25. #ifdef __cplusplus
  26. extern "C"
  27. {
  28. #endif
  29. /** \e libcucul context */
  30. typedef struct cucul_canvas cucul_canvas_t;
  31. /** sprite structure */
  32. typedef struct cucul_sprite cucul_sprite_t;
  33. /** dither structure */
  34. typedef struct cucul_dither cucul_dither_t;
  35. /** data buffer structure */
  36. typedef struct cucul_buffer cucul_buffer_t;
  37. /** font structure */
  38. typedef struct cucul_font cucul_font_t;
  39. /** \defgroup colour libcucul colour definitions
  40. *
  41. * Colours that can be used with cucul_set_color().
  42. *
  43. * @{ */
  44. #define CUCUL_COLOR_BLACK 0x00 /**< The colour index for black. */
  45. #define CUCUL_COLOR_BLUE 0x01 /**< The colour index for blue. */
  46. #define CUCUL_COLOR_GREEN 0x02 /**< The colour index for green. */
  47. #define CUCUL_COLOR_CYAN 0x03 /**< The colour index for cyan. */
  48. #define CUCUL_COLOR_RED 0x04 /**< The colour index for red. */
  49. #define CUCUL_COLOR_MAGENTA 0x05 /**< The colour index for magenta. */
  50. #define CUCUL_COLOR_BROWN 0x06 /**< The colour index for brown. */
  51. #define CUCUL_COLOR_LIGHTGRAY 0x07 /**< The colour index for light gray. */
  52. #define CUCUL_COLOR_DARKGRAY 0x08 /**< The colour index for dark gray. */
  53. #define CUCUL_COLOR_LIGHTBLUE 0x09 /**< The colour index for blue. */
  54. #define CUCUL_COLOR_LIGHTGREEN 0x0a /**< The colour index for light green. */
  55. #define CUCUL_COLOR_LIGHTCYAN 0x0b /**< The colour index for light cyan. */
  56. #define CUCUL_COLOR_LIGHTRED 0x0c /**< The colour index for light red. */
  57. #define CUCUL_COLOR_LIGHTMAGENTA 0x0d /**< The colour index for light magenta. */
  58. #define CUCUL_COLOR_YELLOW 0x0e /**< The colour index for yellow. */
  59. #define CUCUL_COLOR_WHITE 0x0f /**< The colour index for white. */
  60. #define CUCUL_COLOR_DEFAULT 0x10 /**< The output driver's default colour. */
  61. #define CUCUL_COLOR_TRANSPARENT 0x20 /**< The transparent colour. */
  62. /* @} */
  63. /** \defgroup cucul libcucul basic functions
  64. *
  65. * These functions provide the basic \e libcaca routines for library
  66. * initialisation, system information retrieval and configuration.
  67. *
  68. * @{ */
  69. cucul_canvas_t * cucul_create_canvas(unsigned int, unsigned int);
  70. void cucul_set_canvas_size(cucul_canvas_t *, unsigned int, unsigned int);
  71. unsigned int cucul_get_canvas_width(cucul_canvas_t *);
  72. unsigned int cucul_get_canvas_height(cucul_canvas_t *);
  73. void cucul_free_canvas(cucul_canvas_t *);
  74. int cucul_rand(int, int);
  75. /* @} */
  76. /** \defgroup buffer libcucul buffer handling
  77. *
  78. * These functions provide methods to handle libcucul buffers.
  79. *
  80. * @{ */
  81. unsigned long int cucul_get_buffer_size(cucul_buffer_t *);
  82. void * cucul_get_buffer_data(cucul_buffer_t *);
  83. void cucul_free_buffer(cucul_buffer_t *);
  84. /* @} */
  85. /** \defgroup canvas libcucul canvas drawing
  86. *
  87. * These functions provide low-level character printing routines and
  88. * higher level graphics functions.
  89. *
  90. * @{ */
  91. void cucul_set_color(cucul_canvas_t *, unsigned char, unsigned char);
  92. void cucul_set_truecolor(cucul_canvas_t *, unsigned int, unsigned int);
  93. char const *cucul_get_color_name(unsigned int);
  94. void cucul_putchar(cucul_canvas_t *, int, int, char);
  95. void cucul_putstr(cucul_canvas_t *, int, int, char const *);
  96. void cucul_printf(cucul_canvas_t *, int, int, char const *, ...);
  97. void cucul_clear_canvas(cucul_canvas_t *, unsigned char);
  98. void cucul_blit(cucul_canvas_t *, int, int, cucul_canvas_t const *, cucul_canvas_t const *);
  99. /* @} */
  100. /** \defgroup transform libcucul canvas transformation
  101. *
  102. * These functions perform horizontal and vertical canvas flipping.
  103. *
  104. * @{ */
  105. void cucul_invert(cucul_canvas_t *);
  106. void cucul_flip(cucul_canvas_t *);
  107. void cucul_flop(cucul_canvas_t *);
  108. void cucul_rotate(cucul_canvas_t *);
  109. /* @} */
  110. /** \defgroup prim libcucul primitives drawing
  111. *
  112. * These functions provide routines for primitive drawing, such as lines,
  113. * boxes, triangles and ellipses.
  114. *
  115. * @{ */
  116. void cucul_draw_line(cucul_canvas_t *, int, int, int, int, char const *);
  117. void cucul_draw_polyline(cucul_canvas_t *, int const x[], int const y[], int, char const *);
  118. void cucul_draw_thin_line(cucul_canvas_t *, int, int, int, int);
  119. void cucul_draw_thin_polyline(cucul_canvas_t *, int const x[], int const y[], int);
  120. void cucul_draw_circle(cucul_canvas_t *, int, int, int, char const *);
  121. void cucul_draw_ellipse(cucul_canvas_t *, int, int, int, int, char const *);
  122. void cucul_draw_thin_ellipse(cucul_canvas_t *, int, int, int, int);
  123. void cucul_fill_ellipse(cucul_canvas_t *, int, int, int, int, char const *);
  124. void cucul_draw_box(cucul_canvas_t *, int, int, int, int, char const *);
  125. void cucul_draw_thin_box(cucul_canvas_t *, int, int, int, int);
  126. void cucul_fill_box(cucul_canvas_t *, int, int, int, int, char const *);
  127. void cucul_draw_triangle(cucul_canvas_t *, int, int, int, int, int, int, char const *);
  128. void cucul_draw_thin_triangle(cucul_canvas_t *, int, int, int, int, int, int);
  129. void cucul_fill_triangle(cucul_canvas_t *, int, int, int, int, int, int, char const *);
  130. /* @} */
  131. /** \defgroup sprite libcucul sprite handling
  132. *
  133. * These functions provide high level routines for sprite loading, animation
  134. * and rendering.
  135. *
  136. * @{ */
  137. cucul_sprite_t * cucul_load_sprite(char const *);
  138. int cucul_get_sprite_frames(cucul_sprite_t const *);
  139. int cucul_get_sprite_width(cucul_sprite_t const *, int);
  140. int cucul_get_sprite_height(cucul_sprite_t const *, int);
  141. int cucul_get_sprite_dx(cucul_sprite_t const *, int);
  142. int cucul_get_sprite_dy(cucul_sprite_t const *, int);
  143. void cucul_draw_sprite(cucul_canvas_t *, int, int, cucul_sprite_t const *, int);
  144. void cucul_free_sprite(cucul_sprite_t *);
  145. /* @} */
  146. /** \defgroup dither libcucul bitmap dithering
  147. *
  148. * These functions provide high level routines for dither allocation and
  149. * rendering.
  150. *
  151. * @{ */
  152. cucul_dither_t *cucul_create_dither(unsigned int, unsigned int,
  153. unsigned int, unsigned int,
  154. unsigned int, unsigned int,
  155. unsigned int, unsigned int);
  156. void cucul_set_dither_palette(cucul_dither_t *,
  157. unsigned int r[], unsigned int g[],
  158. unsigned int b[], unsigned int a[]);
  159. void cucul_set_dither_brightness(cucul_dither_t *, float);
  160. void cucul_set_dither_gamma(cucul_dither_t *, float);
  161. void cucul_set_dither_contrast(cucul_dither_t *, float);
  162. void cucul_set_dither_invert(cucul_dither_t *, int);
  163. void cucul_set_dither_antialias(cucul_dither_t *, char const *);
  164. char const * const * cucul_get_dither_antialias_list(cucul_dither_t const *);
  165. void cucul_set_dither_color(cucul_dither_t *, char const *);
  166. char const * const * cucul_get_dither_color_list(cucul_dither_t const *);
  167. void cucul_set_dither_charset(cucul_dither_t *, char const *);
  168. char const * const * cucul_get_dither_charset_list(cucul_dither_t const *);
  169. void cucul_set_dither_mode(cucul_dither_t *, char const *);
  170. char const * const * cucul_get_dither_mode_list(cucul_dither_t const *);
  171. void cucul_dither_bitmap(cucul_canvas_t *, int, int, int, int,
  172. cucul_dither_t const *, void *);
  173. void cucul_free_dither(cucul_dither_t *);
  174. /* @} */
  175. /** \defgroup font libcucul font handling
  176. *
  177. * These functions provide font handling routines and high quality
  178. * canvas to bitmap rendering.
  179. *
  180. * @{ */
  181. cucul_font_t *cucul_load_font(void const *, unsigned int);
  182. char const * const * cucul_get_font_list(void);
  183. unsigned int cucul_get_font_width(cucul_font_t *);
  184. unsigned int cucul_get_font_height(cucul_font_t *);
  185. void cucul_render_canvas(cucul_canvas_t *, cucul_font_t *, void *,
  186. unsigned int, unsigned int, unsigned int);
  187. void cucul_free_font(cucul_font_t *);
  188. /* @} */
  189. /** \defgroup importexport libcucul importers/exporters from/to various formats
  190. *
  191. * These functions import various file formats into a new canvas, or export
  192. * the current canvas to various text formats.
  193. *
  194. * @{ */
  195. cucul_buffer_t * cucul_export_canvas(cucul_canvas_t *, char const *);
  196. char const * const * cucul_get_export_list(void);
  197. cucul_canvas_t * cucul_import_canvas(void const *, unsigned int, char const *);
  198. char const * const * cucul_get_import_list(void);
  199. /* @} */
  200. #ifdef __cplusplus
  201. }
  202. #endif
  203. #endif /* __CUCUL_H__ */