You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

преди 19 години
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363
  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. It comes without any warranty, to
  9. * the extent permitted by applicable law. You can redistribute it
  10. * and/or modify it under the terms of the Do What The Fuck You Want
  11. * To Public License, Version 2, as published by Sam Hocevar. See
  12. * http://sam.zoy.org/wtfpl/COPYING for more details.
  13. */
  14. /** \file cucul.h
  15. * \version \$Id$
  16. * \author Sam Hocevar <sam@zoy.org>
  17. * \brief The \e libcucul public header.
  18. *
  19. * This header contains the public types and functions that applications
  20. * using \e libcucul may use.
  21. */
  22. #ifndef __CUCUL_H__
  23. #define __CUCUL_H__
  24. #if !defined(_DOXYGEN_SKIP_ME)
  25. # if defined(__WIN32__) && defined(__LIBCUCUL__)
  26. # define __extern extern __declspec(dllexport)
  27. # else
  28. # define __extern extern
  29. # endif
  30. #endif
  31. /** libcucul API version */
  32. #define CUCUL_API_VERSION_1
  33. #ifdef __cplusplus
  34. extern "C"
  35. {
  36. #endif
  37. /** \e libcucul canvas */
  38. typedef struct cucul_canvas cucul_canvas_t;
  39. /** dither structure */
  40. typedef struct cucul_dither cucul_dither_t;
  41. /** font structure */
  42. typedef struct cucul_font cucul_font_t;
  43. /** \defgroup cucul_attr libcucul attribute definitions
  44. *
  45. * Colours and styles that can be used with cucul_set_attr().
  46. *
  47. * @{ */
  48. #define CUCUL_BLACK 0x00 /**< The colour index for black. */
  49. #define CUCUL_BLUE 0x01 /**< The colour index for blue. */
  50. #define CUCUL_GREEN 0x02 /**< The colour index for green. */
  51. #define CUCUL_CYAN 0x03 /**< The colour index for cyan. */
  52. #define CUCUL_RED 0x04 /**< The colour index for red. */
  53. #define CUCUL_MAGENTA 0x05 /**< The colour index for magenta. */
  54. #define CUCUL_BROWN 0x06 /**< The colour index for brown. */
  55. #define CUCUL_LIGHTGRAY 0x07 /**< The colour index for light gray. */
  56. #define CUCUL_DARKGRAY 0x08 /**< The colour index for dark gray. */
  57. #define CUCUL_LIGHTBLUE 0x09 /**< The colour index for blue. */
  58. #define CUCUL_LIGHTGREEN 0x0a /**< The colour index for light green. */
  59. #define CUCUL_LIGHTCYAN 0x0b /**< The colour index for light cyan. */
  60. #define CUCUL_LIGHTRED 0x0c /**< The colour index for light red. */
  61. #define CUCUL_LIGHTMAGENTA 0x0d /**< The colour index for light magenta. */
  62. #define CUCUL_YELLOW 0x0e /**< The colour index for yellow. */
  63. #define CUCUL_WHITE 0x0f /**< The colour index for white. */
  64. #define CUCUL_DEFAULT 0x10 /**< The output driver's default colour. */
  65. #define CUCUL_TRANSPARENT 0x20 /**< The transparent colour. */
  66. #define CUCUL_BOLD 0x01 /**< The style mask for bold. */
  67. #define CUCUL_ITALICS 0x02 /**< The style mask for italics. */
  68. #define CUCUL_UNDERLINE 0x04 /**< The style mask for underline. */
  69. #define CUCUL_BLINK 0x08 /**< The style mask for blink. */
  70. /* @} */
  71. /** \defgroup libcucul libcucul basic functions
  72. *
  73. * These functions provide the basic \e libcaca routines for library
  74. * initialisation, system information retrieval and configuration.
  75. *
  76. * @{ */
  77. __extern cucul_canvas_t * cucul_create_canvas(unsigned int, unsigned int);
  78. __extern int cucul_set_canvas_size(cucul_canvas_t *, unsigned int,
  79. unsigned int);
  80. __extern unsigned int cucul_get_canvas_width(cucul_canvas_t const *);
  81. __extern unsigned int cucul_get_canvas_height(cucul_canvas_t const *);
  82. __extern int cucul_free_canvas(cucul_canvas_t *);
  83. __extern int cucul_rand(int, int);
  84. /* @} */
  85. /** \defgroup cucul_canvas libcucul canvas drawing
  86. *
  87. * These functions provide low-level character printing routines and
  88. * higher level graphics functions.
  89. *
  90. * @{ */
  91. #define CUCUL_MAGIC_FULLWIDTH 0x000ffffe /**< Used to indicate that the previous character was a fullwidth glyph. */
  92. __extern int cucul_gotoxy(cucul_canvas_t *, int, int);
  93. __extern int cucul_get_cursor_x(cucul_canvas_t const *);
  94. __extern int cucul_get_cursor_y(cucul_canvas_t const *);
  95. __extern int cucul_put_char(cucul_canvas_t *, int, int, unsigned long int);
  96. __extern unsigned long int cucul_get_char(cucul_canvas_t const *, int, int);
  97. __extern int cucul_put_str(cucul_canvas_t *, int, int, char const *);
  98. __extern unsigned long int cucul_get_attr(cucul_canvas_t const *, int, int);
  99. __extern int cucul_set_attr(cucul_canvas_t *, unsigned long int);
  100. __extern int cucul_put_attr(cucul_canvas_t *, int, int, unsigned long int);
  101. __extern int cucul_set_color_ansi(cucul_canvas_t *, unsigned char,
  102. unsigned char);
  103. __extern int cucul_set_color_argb(cucul_canvas_t *, unsigned int,
  104. unsigned int);
  105. __extern int cucul_printf(cucul_canvas_t *, int, int, char const *, ...);
  106. __extern int cucul_clear_canvas(cucul_canvas_t *);
  107. __extern int cucul_set_canvas_handle(cucul_canvas_t *, int, int);
  108. __extern int cucul_get_canvas_handle_x(cucul_canvas_t const *);
  109. __extern int cucul_get_canvas_handle_y(cucul_canvas_t const *);
  110. __extern int cucul_blit(cucul_canvas_t *, int, int, cucul_canvas_t const *,
  111. cucul_canvas_t const *);
  112. __extern int cucul_set_canvas_boundaries(cucul_canvas_t *, int, int,
  113. unsigned int, unsigned int);
  114. /* @} */
  115. /** \defgroup cucul_transform libcucul canvas transformation
  116. *
  117. * These functions perform horizontal and vertical canvas flipping.
  118. *
  119. * @{ */
  120. __extern int cucul_invert(cucul_canvas_t *);
  121. __extern int cucul_flip(cucul_canvas_t *);
  122. __extern int cucul_flop(cucul_canvas_t *);
  123. __extern int cucul_rotate_180(cucul_canvas_t *);
  124. __extern int cucul_rotate_left(cucul_canvas_t *);
  125. __extern int cucul_rotate_right(cucul_canvas_t *);
  126. __extern int cucul_stretch_left(cucul_canvas_t *);
  127. __extern int cucul_stretch_right(cucul_canvas_t *);
  128. /* @} */
  129. /** \defgroup cucul_attributes libcucul attribute conversions
  130. *
  131. * These functions perform conversions between attribute values.
  132. *
  133. * @{ */
  134. __extern unsigned char cucul_attr_to_ansi(unsigned long int);
  135. __extern unsigned char cucul_attr_to_ansi_fg(unsigned long int);
  136. __extern unsigned char cucul_attr_to_ansi_bg(unsigned long int);
  137. /* @} */
  138. /** \defgroup cucul_charset libcucul character set conversions
  139. *
  140. * These functions perform conversions between usual character sets.
  141. *
  142. * @{ */
  143. __extern unsigned long int cucul_utf8_to_utf32(char const *, unsigned int *);
  144. __extern unsigned int cucul_utf32_to_utf8(char *, unsigned long int);
  145. __extern unsigned char cucul_utf32_to_cp437(unsigned long int);
  146. __extern unsigned long int cucul_cp437_to_utf32(unsigned char);
  147. __extern char cucul_utf32_to_ascii(unsigned long int);
  148. __extern int cucul_utf32_is_fullwidth(unsigned long int);
  149. /* @} */
  150. /** \defgroup cucul_primitives libcucul primitives drawing
  151. *
  152. * These functions provide routines for primitive drawing, such as lines,
  153. * boxes, triangles and ellipses.
  154. *
  155. * @{ */
  156. __extern int cucul_draw_line(cucul_canvas_t *, int, int, int, int,
  157. unsigned long int);
  158. __extern int cucul_draw_polyline(cucul_canvas_t *, int const x[],
  159. int const y[], int, unsigned long int);
  160. __extern int cucul_draw_thin_line(cucul_canvas_t *, int, int, int, int);
  161. __extern int cucul_draw_thin_polyline(cucul_canvas_t *, int const x[],
  162. int const y[], int);
  163. __extern int cucul_draw_circle(cucul_canvas_t *, int, int, int,
  164. unsigned long int);
  165. __extern int cucul_draw_ellipse(cucul_canvas_t *, int, int, int, int,
  166. unsigned long int);
  167. __extern int cucul_draw_thin_ellipse(cucul_canvas_t *, int, int, int, int);
  168. __extern int cucul_fill_ellipse(cucul_canvas_t *, int, int, int, int,
  169. unsigned long int);
  170. __extern int cucul_draw_box(cucul_canvas_t *, int, int, int, int,
  171. unsigned long int);
  172. __extern int cucul_draw_thin_box(cucul_canvas_t *, int, int, int, int);
  173. __extern int cucul_draw_cp437_box(cucul_canvas_t *, int, int, int, int);
  174. __extern int cucul_fill_box(cucul_canvas_t *, int, int, int, int,
  175. unsigned long int);
  176. __extern int cucul_draw_triangle(cucul_canvas_t *, int, int, int, int, int,
  177. int, unsigned long int);
  178. __extern int cucul_draw_thin_triangle(cucul_canvas_t *, int, int, int, int,
  179. int, int);
  180. __extern int cucul_fill_triangle(cucul_canvas_t *, int, int, int, int, int,
  181. int, unsigned long int);
  182. /* @} */
  183. /** \defgroup cucul_frame libcucul canvas frame handling
  184. *
  185. * These functions provide high level routines for canvas frame insertion,
  186. * removal, copying etc.
  187. *
  188. * @{ */
  189. __extern unsigned int cucul_get_frame_count(cucul_canvas_t const *);
  190. __extern int cucul_set_frame(cucul_canvas_t *, unsigned int);
  191. __extern char const *cucul_get_frame_name(cucul_canvas_t const *);
  192. __extern int cucul_set_frame_name(cucul_canvas_t *, char const *);
  193. __extern int cucul_create_frame(cucul_canvas_t *, unsigned int);
  194. __extern int cucul_free_frame(cucul_canvas_t *, unsigned int);
  195. /* @} */
  196. /** \defgroup cucul_dither libcucul bitmap dithering
  197. *
  198. * These functions provide high level routines for dither allocation and
  199. * rendering.
  200. *
  201. * @{ */
  202. __extern cucul_dither_t *cucul_create_dither(unsigned int, unsigned int,
  203. unsigned int, unsigned int,
  204. unsigned long int,
  205. unsigned long int,
  206. unsigned long int,
  207. unsigned long int);
  208. __extern int cucul_set_dither_palette(cucul_dither_t *,
  209. unsigned int r[], unsigned int g[],
  210. unsigned int b[], unsigned int a[]);
  211. __extern int cucul_set_dither_brightness(cucul_dither_t *, float);
  212. __extern float cucul_get_dither_brightness(cucul_dither_t const *);
  213. __extern int cucul_set_dither_gamma(cucul_dither_t *, float);
  214. __extern float cucul_get_dither_gamma(cucul_dither_t const *);
  215. __extern int cucul_set_dither_contrast(cucul_dither_t *, float);
  216. __extern float cucul_get_dither_contrast(cucul_dither_t const *);
  217. __extern int cucul_set_dither_antialias(cucul_dither_t *, char const *);
  218. __extern char const * const * cucul_get_dither_antialias_list(cucul_dither_t
  219. const *);
  220. __extern char const * cucul_get_dither_antialias(cucul_dither_t const *);
  221. __extern int cucul_set_dither_color(cucul_dither_t *, char const *);
  222. __extern char const * const * cucul_get_dither_color_list(cucul_dither_t
  223. const *);
  224. __extern char const * cucul_get_dither_color(cucul_dither_t const *);
  225. __extern int cucul_set_dither_charset(cucul_dither_t *, char const *);
  226. __extern char const * const * cucul_get_dither_charset_list(cucul_dither_t
  227. const *);
  228. __extern char const * cucul_get_dither_charset(cucul_dither_t const *);
  229. __extern int cucul_set_dither_algorithm(cucul_dither_t *, char const *);
  230. __extern char const * const * cucul_get_dither_algorithm_list(cucul_dither_t
  231. const *);
  232. __extern char const * cucul_get_dither_algorithm(cucul_dither_t const *);
  233. __extern int cucul_dither_bitmap(cucul_canvas_t *, int, int, int, int,
  234. cucul_dither_t const *, void *);
  235. __extern int cucul_free_dither(cucul_dither_t *);
  236. /* @} */
  237. /** \defgroup cucul_font libcucul font handling
  238. *
  239. * These functions provide font handling routines and high quality
  240. * canvas to bitmap rendering.
  241. *
  242. * @{ */
  243. __extern cucul_font_t *cucul_load_font(void const *, unsigned int);
  244. __extern char const * const * cucul_get_font_list(void);
  245. __extern unsigned int cucul_get_font_width(cucul_font_t const *);
  246. __extern unsigned int cucul_get_font_height(cucul_font_t const *);
  247. __extern unsigned long int const *cucul_get_font_blocks(cucul_font_t const *);
  248. __extern int cucul_render_canvas(cucul_canvas_t const *, cucul_font_t const *,
  249. void *, unsigned int, unsigned int,
  250. unsigned int);
  251. __extern int cucul_free_font(cucul_font_t *);
  252. /* @} */
  253. /** \defgroup cucul_importexport libcucul importers/exporters from/to various
  254. * formats
  255. *
  256. * These functions import various file formats into a new canvas, or export
  257. * the current canvas to various text formats.
  258. *
  259. * @{ */
  260. __extern long int cucul_import_memory(cucul_canvas_t *, void const *,
  261. unsigned long int, char const *);
  262. __extern long int cucul_import_file(cucul_canvas_t *, char const *,
  263. char const *);
  264. __extern char const * const * cucul_get_import_list(void);
  265. __extern void *cucul_export_memory(cucul_canvas_t const *, char const *,
  266. unsigned long int *);
  267. __extern char const * const * cucul_get_export_list(void);
  268. /* @} */
  269. #if !defined(_DOXYGEN_SKIP_ME)
  270. /* Legacy stuff from beta versions, will probably disappear in 1.0 */
  271. typedef struct cucul_buffer cucul_buffer_t;
  272. # if defined __GNUC__ && __GNUC__ >= 3
  273. # define CUCUL_DEPRECATED __attribute__ ((__deprecated__))
  274. # else
  275. # define CUCUL_DEPRECATED
  276. # endif
  277. __extern int cucul_putchar(cucul_canvas_t *, int, int,
  278. unsigned long int) CUCUL_DEPRECATED;
  279. __extern unsigned long int cucul_getchar(cucul_canvas_t *,
  280. int, int) CUCUL_DEPRECATED;
  281. __extern int cucul_putstr(cucul_canvas_t *, int, int,
  282. char const *) CUCUL_DEPRECATED;
  283. __extern int cucul_set_color(cucul_canvas_t *, unsigned char,
  284. unsigned char) CUCUL_DEPRECATED;
  285. __extern int cucul_set_truecolor(cucul_canvas_t *, unsigned int,
  286. unsigned int) CUCUL_DEPRECATED;
  287. __extern unsigned int cucul_get_canvas_frame_count(cucul_canvas_t *)
  288. CUCUL_DEPRECATED;
  289. __extern int cucul_set_canvas_frame(cucul_canvas_t *,
  290. unsigned int) CUCUL_DEPRECATED;
  291. __extern int cucul_create_canvas_frame(cucul_canvas_t *,
  292. unsigned int) CUCUL_DEPRECATED;
  293. __extern int cucul_free_canvas_frame(cucul_canvas_t *,
  294. unsigned int) CUCUL_DEPRECATED;
  295. __extern cucul_buffer_t *cucul_load_memory(void *,
  296. unsigned long int) CUCUL_DEPRECATED;
  297. __extern cucul_buffer_t *cucul_load_file(char const *) CUCUL_DEPRECATED;
  298. __extern unsigned long int cucul_get_buffer_size(cucul_buffer_t *)
  299. CUCUL_DEPRECATED;
  300. __extern void * cucul_get_buffer_data(cucul_buffer_t *) CUCUL_DEPRECATED;
  301. __extern int cucul_free_buffer(cucul_buffer_t *) CUCUL_DEPRECATED;
  302. __extern cucul_buffer_t * cucul_export_canvas(cucul_canvas_t *,
  303. char const *) CUCUL_DEPRECATED;
  304. __extern cucul_canvas_t * cucul_import_canvas(cucul_buffer_t *,
  305. char const *) CUCUL_DEPRECATED;
  306. __extern int cucul_rotate(cucul_canvas_t *) CUCUL_DEPRECATED;
  307. __extern int cucul_set_dither_invert(cucul_dither_t *, int) CUCUL_DEPRECATED;
  308. __extern int cucul_set_dither_mode(cucul_dither_t *,
  309. char const *) CUCUL_DEPRECATED;
  310. __extern char const * const * cucul_get_dither_mode_list(cucul_dither_t
  311. const *)
  312. CUCUL_DEPRECATED;
  313. # define CUCUL_COLOR_BLACK CUCUL_BLACK
  314. # define CUCUL_COLOR_BLUE CUCUL_BLUE
  315. # define CUCUL_COLOR_GREEN CUCUL_GREEN
  316. # define CUCUL_COLOR_CYAN CUCUL_CYAN
  317. # define CUCUL_COLOR_RED CUCUL_RED
  318. # define CUCUL_COLOR_MAGENTA CUCUL_MAGENTA
  319. # define CUCUL_COLOR_BROWN CUCUL_BROWN
  320. # define CUCUL_COLOR_LIGHTGRAY CUCUL_LIGHTGRAY
  321. # define CUCUL_COLOR_DARKGRAY CUCUL_DARKGRAY
  322. # define CUCUL_COLOR_LIGHTBLUE CUCUL_LIGHTBLUE
  323. # define CUCUL_COLOR_LIGHTGREEN CUCUL_LIGHTGREEN
  324. # define CUCUL_COLOR_LIGHTCYAN CUCUL_LIGHTCYAN
  325. # define CUCUL_COLOR_LIGHTRED CUCUL_LIGHTRED
  326. # define CUCUL_COLOR_LIGHTMAGENTA CUCUL_LIGHTMAGENTA
  327. # define CUCUL_COLOR_YELLOW CUCUL_YELLOW
  328. # define CUCUL_COLOR_WHITE CUCUL_YELLOW
  329. # define CUCUL_COLOR_DEFAULT CUCUL_DEFAULT
  330. # define CUCUL_COLOR_TRANSPARENT CUCUL_TRANSPARENT
  331. #endif
  332. #ifdef __cplusplus
  333. }
  334. #endif
  335. #if !defined(_DOXYGEN_SKIP_ME)
  336. # undef __extern
  337. #endif
  338. #endif /* __CUCUL_H__ */