Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
 
 
 
 
 
 

220 linhas
8.5 KiB

  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 canvas */
  30. typedef struct cucul_canvas cucul_canvas_t;
  31. /** dither structure */
  32. typedef struct cucul_dither cucul_dither_t;
  33. /** data buffer structure */
  34. typedef struct cucul_buffer cucul_buffer_t;
  35. /** font structure */
  36. typedef struct cucul_font cucul_font_t;
  37. /** \defgroup colour libcucul colour definitions
  38. *
  39. * Colours that can be used with cucul_set_color().
  40. *
  41. * @{ */
  42. #define CUCUL_COLOR_BLACK 0x00 /**< The colour index for black. */
  43. #define CUCUL_COLOR_BLUE 0x01 /**< The colour index for blue. */
  44. #define CUCUL_COLOR_GREEN 0x02 /**< The colour index for green. */
  45. #define CUCUL_COLOR_CYAN 0x03 /**< The colour index for cyan. */
  46. #define CUCUL_COLOR_RED 0x04 /**< The colour index for red. */
  47. #define CUCUL_COLOR_MAGENTA 0x05 /**< The colour index for magenta. */
  48. #define CUCUL_COLOR_BROWN 0x06 /**< The colour index for brown. */
  49. #define CUCUL_COLOR_LIGHTGRAY 0x07 /**< The colour index for light gray. */
  50. #define CUCUL_COLOR_DARKGRAY 0x08 /**< The colour index for dark gray. */
  51. #define CUCUL_COLOR_LIGHTBLUE 0x09 /**< The colour index for blue. */
  52. #define CUCUL_COLOR_LIGHTGREEN 0x0a /**< The colour index for light green. */
  53. #define CUCUL_COLOR_LIGHTCYAN 0x0b /**< The colour index for light cyan. */
  54. #define CUCUL_COLOR_LIGHTRED 0x0c /**< The colour index for light red. */
  55. #define CUCUL_COLOR_LIGHTMAGENTA 0x0d /**< The colour index for light magenta. */
  56. #define CUCUL_COLOR_YELLOW 0x0e /**< The colour index for yellow. */
  57. #define CUCUL_COLOR_WHITE 0x0f /**< The colour index for white. */
  58. #define CUCUL_COLOR_DEFAULT 0x10 /**< The output driver's default colour. */
  59. #define CUCUL_COLOR_TRANSPARENT 0x20 /**< The transparent colour. */
  60. /* @} */
  61. /** \defgroup cucul libcucul basic functions
  62. *
  63. * These functions provide the basic \e libcaca routines for library
  64. * initialisation, system information retrieval and configuration.
  65. *
  66. * @{ */
  67. cucul_canvas_t * cucul_create_canvas(unsigned int, unsigned int);
  68. int cucul_set_canvas_size(cucul_canvas_t *, unsigned int, unsigned int);
  69. unsigned int cucul_get_canvas_width(cucul_canvas_t *);
  70. unsigned int cucul_get_canvas_height(cucul_canvas_t *);
  71. int cucul_free_canvas(cucul_canvas_t *);
  72. int cucul_rand(int, int);
  73. /* @} */
  74. /** \defgroup buffer libcucul buffer handling
  75. *
  76. * These functions provide methods to handle libcucul buffers.
  77. *
  78. * @{ */
  79. cucul_buffer_t *cucul_load_memory(void *, unsigned long int);
  80. cucul_buffer_t *cucul_load_file(char const *);
  81. unsigned long int cucul_get_buffer_size(cucul_buffer_t *);
  82. void * cucul_get_buffer_data(cucul_buffer_t *);
  83. int 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. int cucul_set_color(cucul_canvas_t *, unsigned char, unsigned char);
  92. int cucul_set_truecolor(cucul_canvas_t *, unsigned int, unsigned int);
  93. char const *cucul_get_color_name(unsigned int);
  94. int cucul_putchar(cucul_canvas_t *, int, int, char);
  95. int cucul_putstr(cucul_canvas_t *, int, int, char const *);
  96. int cucul_printf(cucul_canvas_t *, int, int, char const *, ...);
  97. int cucul_clear_canvas(cucul_canvas_t *);
  98. int 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. int cucul_draw_line(cucul_canvas_t *, int, int, int, int, char const *);
  117. int cucul_draw_polyline(cucul_canvas_t *, int const x[], int const y[], int, char const *);
  118. int cucul_draw_thin_line(cucul_canvas_t *, int, int, int, int);
  119. int cucul_draw_thin_polyline(cucul_canvas_t *, int const x[], int const y[], int);
  120. int cucul_draw_circle(cucul_canvas_t *, int, int, int, char const *);
  121. int cucul_draw_ellipse(cucul_canvas_t *, int, int, int, int, char const *);
  122. int cucul_draw_thin_ellipse(cucul_canvas_t *, int, int, int, int);
  123. int cucul_fill_ellipse(cucul_canvas_t *, int, int, int, int, char const *);
  124. int cucul_draw_box(cucul_canvas_t *, int, int, int, int, char const *);
  125. int cucul_draw_thin_box(cucul_canvas_t *, int, int, int, int);
  126. int cucul_fill_box(cucul_canvas_t *, int, int, int, int, char const *);
  127. int cucul_draw_triangle(cucul_canvas_t *, int, int, int, int, int, int, char const *);
  128. int cucul_draw_thin_triangle(cucul_canvas_t *, int, int, int, int, int, int);
  129. int cucul_fill_triangle(cucul_canvas_t *, int, int, int, int, int, int, char const *);
  130. /* @} */
  131. /** \defgroup frame libcucul canvas frame handling
  132. *
  133. * These functions provide high level routines for canvas frame insertion,
  134. * removal, copying etc.
  135. *
  136. * @{ */
  137. unsigned int cucul_get_canvas_frame_count(cucul_canvas_t *);
  138. void cucul_set_canvas_frame(cucul_canvas_t *, unsigned int);
  139. void cucul_create_canvas_frame(cucul_canvas_t *, unsigned int);
  140. void cucul_free_canvas_frame(cucul_canvas_t *, unsigned int);
  141. /* @} */
  142. /** \defgroup dither libcucul bitmap dithering
  143. *
  144. * These functions provide high level routines for dither allocation and
  145. * rendering.
  146. *
  147. * @{ */
  148. cucul_dither_t *cucul_create_dither(unsigned int, unsigned int,
  149. unsigned int, unsigned int,
  150. unsigned int, unsigned int,
  151. unsigned int, unsigned int);
  152. void cucul_set_dither_palette(cucul_dither_t *,
  153. unsigned int r[], unsigned int g[],
  154. unsigned int b[], unsigned int a[]);
  155. void cucul_set_dither_brightness(cucul_dither_t *, float);
  156. void cucul_set_dither_gamma(cucul_dither_t *, float);
  157. void cucul_set_dither_contrast(cucul_dither_t *, float);
  158. void cucul_set_dither_invert(cucul_dither_t *, int);
  159. void cucul_set_dither_antialias(cucul_dither_t *, char const *);
  160. char const * const * cucul_get_dither_antialias_list(cucul_dither_t const *);
  161. void cucul_set_dither_color(cucul_dither_t *, char const *);
  162. char const * const * cucul_get_dither_color_list(cucul_dither_t const *);
  163. void cucul_set_dither_charset(cucul_dither_t *, char const *);
  164. char const * const * cucul_get_dither_charset_list(cucul_dither_t const *);
  165. void cucul_set_dither_mode(cucul_dither_t *, char const *);
  166. char const * const * cucul_get_dither_mode_list(cucul_dither_t const *);
  167. void cucul_dither_bitmap(cucul_canvas_t *, int, int, int, int,
  168. cucul_dither_t const *, void *);
  169. void cucul_free_dither(cucul_dither_t *);
  170. /* @} */
  171. /** \defgroup font libcucul font handling
  172. *
  173. * These functions provide font handling routines and high quality
  174. * canvas to bitmap rendering.
  175. *
  176. * @{ */
  177. cucul_font_t *cucul_load_font(void const *, unsigned int);
  178. char const * const * cucul_get_font_list(void);
  179. unsigned int cucul_get_font_width(cucul_font_t *);
  180. unsigned int cucul_get_font_height(cucul_font_t *);
  181. void cucul_render_canvas(cucul_canvas_t *, cucul_font_t *, void *,
  182. unsigned int, unsigned int, unsigned int);
  183. void cucul_free_font(cucul_font_t *);
  184. /* @} */
  185. /** \defgroup importexport libcucul importers/exporters from/to various formats
  186. *
  187. * These functions import various file formats into a new canvas, or export
  188. * the current canvas to various text formats.
  189. *
  190. * @{ */
  191. cucul_buffer_t * cucul_export_canvas(cucul_canvas_t *, char const *);
  192. char const * const * cucul_get_export_list(void);
  193. cucul_canvas_t * cucul_import_canvas(cucul_buffer_t *, char const *);
  194. char const * const * cucul_get_import_list(void);
  195. /* @} */
  196. #ifdef __cplusplus
  197. }
  198. #endif
  199. #endif /* __CUCUL_H__ */