選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。
 
 
 
 
 
 

302 行
12 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. /** font structure */
  34. typedef struct cucul_font cucul_font_t;
  35. /** \defgroup attr_defines libcucul attribute definitions
  36. *
  37. * Colours and styles that can be used with cucul_set_attr().
  38. *
  39. * @{ */
  40. #define CUCUL_BLACK 0x00 /**< The colour index for black. */
  41. #define CUCUL_BLUE 0x01 /**< The colour index for blue. */
  42. #define CUCUL_GREEN 0x02 /**< The colour index for green. */
  43. #define CUCUL_CYAN 0x03 /**< The colour index for cyan. */
  44. #define CUCUL_RED 0x04 /**< The colour index for red. */
  45. #define CUCUL_MAGENTA 0x05 /**< The colour index for magenta. */
  46. #define CUCUL_BROWN 0x06 /**< The colour index for brown. */
  47. #define CUCUL_LIGHTGRAY 0x07 /**< The colour index for light gray. */
  48. #define CUCUL_DARKGRAY 0x08 /**< The colour index for dark gray. */
  49. #define CUCUL_LIGHTBLUE 0x09 /**< The colour index for blue. */
  50. #define CUCUL_LIGHTGREEN 0x0a /**< The colour index for light green. */
  51. #define CUCUL_LIGHTCYAN 0x0b /**< The colour index for light cyan. */
  52. #define CUCUL_LIGHTRED 0x0c /**< The colour index for light red. */
  53. #define CUCUL_LIGHTMAGENTA 0x0d /**< The colour index for light magenta. */
  54. #define CUCUL_YELLOW 0x0e /**< The colour index for yellow. */
  55. #define CUCUL_WHITE 0x0f /**< The colour index for white. */
  56. #define CUCUL_DEFAULT 0x10 /**< The output driver's default colour. */
  57. #define CUCUL_TRANSPARENT 0x20 /**< The transparent colour. */
  58. #define CUCUL_BOLD 0x01 /**< The style mask for bold. */
  59. #define CUCUL_ITALICS 0x02 /**< The style mask for italics. */
  60. #define CUCUL_UNDERLINE 0x04 /**< The style mask for underline. */
  61. #define CUCUL_BLINK 0x08 /**< The style mask for blink. */
  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. int 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. int cucul_free_canvas(cucul_canvas_t *);
  74. int cucul_rand(int, int);
  75. /* @} */
  76. /** \defgroup canvas libcucul canvas drawing
  77. *
  78. * These functions provide low-level character printing routines and
  79. * higher level graphics functions.
  80. *
  81. * @{ */
  82. #define CUCUL_MAGIC_FULLWIDTH 0x000ffffe /**< Used to indicate that the previous character was a fullwidth glyph. */
  83. int cucul_gotoxy(cucul_canvas_t *, int, int);
  84. int cucul_get_cursor_x(cucul_canvas_t *);
  85. int cucul_get_cursor_y(cucul_canvas_t *);
  86. int cucul_put_char(cucul_canvas_t *, int, int, unsigned long int);
  87. unsigned long int cucul_get_char(cucul_canvas_t *, int, int);
  88. int cucul_put_str(cucul_canvas_t *, int, int, char const *);
  89. unsigned long int cucul_get_attr(cucul_canvas_t *, int, int);
  90. int cucul_set_attr(cucul_canvas_t *, unsigned long int);
  91. int cucul_put_attr(cucul_canvas_t *, int, int, unsigned long int);
  92. int cucul_set_color_ansi(cucul_canvas_t *, unsigned char, unsigned char);
  93. int cucul_set_color_argb(cucul_canvas_t *, unsigned int, unsigned int);
  94. int cucul_printf(cucul_canvas_t *, int, int, char const *, ...);
  95. int cucul_clear_canvas(cucul_canvas_t *);
  96. int cucul_set_canvas_handle(cucul_canvas_t *, int, int);
  97. int cucul_get_canvas_handle_x(cucul_canvas_t *);
  98. int cucul_get_canvas_handle_y(cucul_canvas_t *);
  99. int cucul_blit(cucul_canvas_t *, int, int, cucul_canvas_t const *,
  100. cucul_canvas_t const *);
  101. int cucul_set_canvas_boundaries(cucul_canvas_t *, int, int,
  102. unsigned int, unsigned int);
  103. /* @} */
  104. /** \defgroup transform libcucul canvas transformation
  105. *
  106. * These functions perform horizontal and vertical canvas flipping.
  107. *
  108. * @{ */
  109. int cucul_invert(cucul_canvas_t *);
  110. int cucul_flip(cucul_canvas_t *);
  111. int cucul_flop(cucul_canvas_t *);
  112. int cucul_rotate(cucul_canvas_t *);
  113. /* @} */
  114. /** \defgroup attributes libcucul attribute conversions
  115. *
  116. * These functions perform conversions between attribute values.
  117. *
  118. * @{ */
  119. unsigned char cucul_attr_to_ansi(unsigned long int);
  120. unsigned char cucul_attr_to_ansi_fg(unsigned long int);
  121. unsigned char cucul_attr_to_ansi_bg(unsigned long int);
  122. /* @} */
  123. /** \defgroup charset libcucul character set conversions
  124. *
  125. * These functions perform conversions between usual character sets.
  126. *
  127. * @{ */
  128. unsigned long int cucul_utf8_to_utf32(char const *, unsigned int *);
  129. unsigned int cucul_utf32_to_utf8(char *, unsigned long int);
  130. unsigned char cucul_utf32_to_cp437(unsigned long int);
  131. unsigned long int cucul_cp437_to_utf32(unsigned char);
  132. int cucul_utf32_is_fullwidth(unsigned long int);
  133. /* @} */
  134. /** \defgroup prim libcucul primitives drawing
  135. *
  136. * These functions provide routines for primitive drawing, such as lines,
  137. * boxes, triangles and ellipses.
  138. *
  139. * @{ */
  140. int cucul_draw_line(cucul_canvas_t *, int, int, int, int, unsigned long int);
  141. int cucul_draw_polyline(cucul_canvas_t *, int const x[], int const y[], int,
  142. unsigned long int);
  143. int cucul_draw_thin_line(cucul_canvas_t *, int, int, int, int);
  144. int cucul_draw_thin_polyline(cucul_canvas_t *, int const x[], int const y[],
  145. int);
  146. int cucul_draw_circle(cucul_canvas_t *, int, int, int, unsigned long int);
  147. int cucul_draw_ellipse(cucul_canvas_t *, int, int, int, int, unsigned long int);
  148. int cucul_draw_thin_ellipse(cucul_canvas_t *, int, int, int, int);
  149. int cucul_fill_ellipse(cucul_canvas_t *, int, int, int, int, unsigned long int);
  150. int cucul_draw_box(cucul_canvas_t *, int, int, int, int, unsigned long int);
  151. int cucul_draw_thin_box(cucul_canvas_t *, int, int, int, int);
  152. int cucul_draw_cp437_box(cucul_canvas_t *, int, int, int, int);
  153. int cucul_fill_box(cucul_canvas_t *, int, int, int, int, unsigned long int);
  154. int cucul_draw_triangle(cucul_canvas_t *, int, int, int, int, int, int,
  155. unsigned long int);
  156. int cucul_draw_thin_triangle(cucul_canvas_t *, int, int, int, int, int, int);
  157. int cucul_fill_triangle(cucul_canvas_t *, int, int, int, int, int, int,
  158. unsigned long int);
  159. /* @} */
  160. /** \defgroup frame libcucul canvas frame handling
  161. *
  162. * These functions provide high level routines for canvas frame insertion,
  163. * removal, copying etc.
  164. *
  165. * @{ */
  166. unsigned int cucul_get_canvas_frame_count(cucul_canvas_t *);
  167. int cucul_set_canvas_frame(cucul_canvas_t *, unsigned int);
  168. int cucul_create_canvas_frame(cucul_canvas_t *, unsigned int);
  169. int cucul_free_canvas_frame(cucul_canvas_t *, unsigned int);
  170. /* @} */
  171. /** \defgroup dither libcucul bitmap dithering
  172. *
  173. * These functions provide high level routines for dither allocation and
  174. * rendering.
  175. *
  176. * @{ */
  177. cucul_dither_t *cucul_create_dither(unsigned int, unsigned int,
  178. unsigned int, unsigned int,
  179. unsigned long int, unsigned long int,
  180. unsigned long int, unsigned long int);
  181. int cucul_set_dither_palette(cucul_dither_t *,
  182. unsigned int r[], unsigned int g[],
  183. unsigned int b[], unsigned int a[]);
  184. int cucul_set_dither_brightness(cucul_dither_t *, float);
  185. int cucul_set_dither_gamma(cucul_dither_t *, float);
  186. int cucul_set_dither_contrast(cucul_dither_t *, float);
  187. int cucul_set_dither_invert(cucul_dither_t *, int);
  188. int cucul_set_dither_antialias(cucul_dither_t *, char const *);
  189. char const * const * cucul_get_dither_antialias_list(cucul_dither_t const *);
  190. int cucul_set_dither_color(cucul_dither_t *, char const *);
  191. char const * const * cucul_get_dither_color_list(cucul_dither_t const *);
  192. int cucul_set_dither_charset(cucul_dither_t *, char const *);
  193. char const * const * cucul_get_dither_charset_list(cucul_dither_t const *);
  194. int cucul_set_dither_mode(cucul_dither_t *, char const *);
  195. char const * const * cucul_get_dither_mode_list(cucul_dither_t const *);
  196. int cucul_dither_bitmap(cucul_canvas_t *, int, int, int, int,
  197. cucul_dither_t const *, void *);
  198. int cucul_free_dither(cucul_dither_t *);
  199. /* @} */
  200. /** \defgroup font libcucul font handling
  201. *
  202. * These functions provide font handling routines and high quality
  203. * canvas to bitmap rendering.
  204. *
  205. * @{ */
  206. cucul_font_t *cucul_load_font(void const *, unsigned int);
  207. char const * const * cucul_get_font_list(void);
  208. unsigned int cucul_get_font_width(cucul_font_t *);
  209. unsigned int cucul_get_font_height(cucul_font_t *);
  210. unsigned long int const *cucul_get_font_blocks(cucul_font_t *);
  211. int cucul_render_canvas(cucul_canvas_t *, cucul_font_t *, void *,
  212. unsigned int, unsigned int, unsigned int);
  213. int cucul_free_font(cucul_font_t *);
  214. /* @} */
  215. /** \defgroup importexport libcucul importers/exporters from/to various formats
  216. *
  217. * These functions import various file formats into a new canvas, or export
  218. * the current canvas to various text formats.
  219. *
  220. * @{ */
  221. long int cucul_import_memory(cucul_canvas_t *, void const *,
  222. unsigned long int, char const *);
  223. long int cucul_import_file(cucul_canvas_t *, char const *, char const *);
  224. char const * const * cucul_get_import_list(void);
  225. void *cucul_export_memory(cucul_canvas_t *, char const *, unsigned long int *);
  226. char const * const * cucul_get_export_list(void);
  227. /* @} */
  228. #if !defined(_DOXYGEN_SKIP_ME)
  229. /* Legacy stuff from beta versions, will probably disappear in 1.0 */
  230. typedef struct cucul_buffer cucul_buffer_t;
  231. # ifdef __GNUC__
  232. # define CUCUL_DEPRECATED __attribute__ ((deprecated))
  233. # else
  234. # define CUCUL_DEPRECATED
  235. # endif
  236. int cucul_putchar(cucul_canvas_t *, int, int,
  237. unsigned long int) CUCUL_DEPRECATED;
  238. unsigned long int cucul_getchar(cucul_canvas_t *,
  239. int, int) CUCUL_DEPRECATED;
  240. int cucul_putstr(cucul_canvas_t *, int, int,
  241. char const *) CUCUL_DEPRECATED;
  242. int cucul_set_color(cucul_canvas_t *, unsigned char,
  243. unsigned char) CUCUL_DEPRECATED;
  244. int cucul_set_truecolor(cucul_canvas_t *, unsigned int,
  245. unsigned int) CUCUL_DEPRECATED;
  246. cucul_buffer_t *cucul_load_memory(void *,
  247. unsigned long int) CUCUL_DEPRECATED;
  248. cucul_buffer_t *cucul_load_file(char const *) CUCUL_DEPRECATED;
  249. unsigned long int cucul_get_buffer_size(cucul_buffer_t *) CUCUL_DEPRECATED;
  250. void * cucul_get_buffer_data(cucul_buffer_t *) CUCUL_DEPRECATED;
  251. int cucul_free_buffer(cucul_buffer_t *) CUCUL_DEPRECATED;
  252. cucul_buffer_t * cucul_export_canvas(cucul_canvas_t *,
  253. char const *) CUCUL_DEPRECATED;
  254. cucul_canvas_t * cucul_import_canvas(cucul_buffer_t *,
  255. char const *) CUCUL_DEPRECATED;
  256. # define CUCUL_COLOR_BLACK CUCUL_BLACK
  257. # define CUCUL_COLOR_BLUE CUCUL_BLUE
  258. # define CUCUL_COLOR_GREEN CUCUL_GREEN
  259. # define CUCUL_COLOR_CYAN CUCUL_CYAN
  260. # define CUCUL_COLOR_RED CUCUL_RED
  261. # define CUCUL_COLOR_MAGENTA CUCUL_MAGENTA
  262. # define CUCUL_COLOR_BROWN CUCUL_BROWN
  263. # define CUCUL_COLOR_LIGHTGRAY CUCUL_LIGHTGRAY
  264. # define CUCUL_COLOR_DARKGRAY CUCUL_DARKGRAY
  265. # define CUCUL_COLOR_LIGHTBLUE CUCUL_LIGHTBLUE
  266. # define CUCUL_COLOR_LIGHTGREEN CUCUL_LIGHTGREEN
  267. # define CUCUL_COLOR_LIGHTCYAN CUCUL_LIGHTCYAN
  268. # define CUCUL_COLOR_LIGHTRED CUCUL_LIGHTRED
  269. # define CUCUL_COLOR_LIGHTMAGENTA CUCUL_LIGHTMAGENTA
  270. # define CUCUL_COLOR_YELLOW CUCUL_YELLOW
  271. # define CUCUL_COLOR_WHITE CUCUL_YELLOW
  272. # define CUCUL_COLOR_DEFAULT CUCUL_DEFAULT
  273. # define CUCUL_COLOR_TRANSPARENT CUCUL_TRANSPARENT
  274. #endif
  275. #ifdef __cplusplus
  276. }
  277. #endif
  278. #endif /* __CUCUL_H__ */