cacalabs
/
libcaca
miroir de https://github.com/cacalabs/libcaca.git
1
0
Bifurcation 0
Code Tickets 0 Versions 7 Wiki Activité
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.
1177 Révisions
1 Branche
77 MiB
 
 
 
 
 
 
Aborescence: 061ca415b0
Branches Tags
${ item.name }
Créer la branche ${ searchTerm }
de '061ca415b0'
${ noResults }
libcaca/cucul/cucul.h

330 lignes
14 KiB
Brut Annotations Historique 

  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. 

  15. /** \file cucul.h

  16.  *  \version \$Id$

  17.  *  \author Sam Hocevar <sam@zoy.org>

  18.  *  \brief The \e libcucul public header.

  19.  *

  20.  *  This header contains the public types and functions that applications

  21.  *  using \e libcucul may use.

  22.  */

  23. 

  24. #ifndef __CUCUL_H__

  25. #define __CUCUL_H__

  26. 

  27. /** libcucul API version */

  28. #define CUCUL_API_VERSION_1

  29. 

  30. #ifdef __cplusplus

  31. extern "C"

  32. {

  33. #endif

  34. 

  35. /** \e libcucul canvas */

  36. typedef struct cucul_canvas cucul_canvas_t;

  37. /** dither structure */

  38. typedef struct cucul_dither cucul_dither_t;

  39. /** font structure */

  40. typedef struct cucul_font cucul_font_t;

  41. 

  42. /** \defgroup cucul_attr libcucul attribute definitions

  43.  *

  44.  *  Colours and styles that can be used with cucul_set_attr().

  45.  *

  46.  *  @{ */

  47. #define CUCUL_BLACK 0x00 /**< The colour index for black. */

  48. #define CUCUL_BLUE 0x01 /**< The colour index for blue. */

  49. #define CUCUL_GREEN 0x02 /**< The colour index for green. */

  50. #define CUCUL_CYAN 0x03 /**< The colour index for cyan. */

  51. #define CUCUL_RED 0x04 /**< The colour index for red. */

  52. #define CUCUL_MAGENTA 0x05 /**< The colour index for magenta. */

  53. #define CUCUL_BROWN 0x06 /**< The colour index for brown. */

  54. #define CUCUL_LIGHTGRAY 0x07 /**< The colour index for light gray. */

  55. #define CUCUL_DARKGRAY 0x08 /**< The colour index for dark gray. */

  56. #define CUCUL_LIGHTBLUE 0x09 /**< The colour index for blue. */

  57. #define CUCUL_LIGHTGREEN 0x0a /**< The colour index for light green. */

  58. #define CUCUL_LIGHTCYAN 0x0b /**< The colour index for light cyan. */

  59. #define CUCUL_LIGHTRED 0x0c /**< The colour index for light red. */

  60. #define CUCUL_LIGHTMAGENTA 0x0d /**< The colour index for light magenta. */

  61. #define CUCUL_YELLOW 0x0e /**< The colour index for yellow. */

  62. #define CUCUL_WHITE 0x0f /**< The colour index for white. */

  63. #define CUCUL_DEFAULT 0x10 /**< The output driver's default colour. */

  64. #define CUCUL_TRANSPARENT 0x20 /**< The transparent colour. */

  65. 

  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. 

  72. /** \defgroup libcucul libcucul basic functions

  73.  *

  74.  *  These functions provide the basic \e libcaca routines for library

  75.  *  initialisation, system information retrieval and configuration.

  76.  *

  77.  *  @{ */

  78. cucul_canvas_t * cucul_create_canvas(unsigned int, unsigned int);

  79. int cucul_set_canvas_size(cucul_canvas_t *, unsigned int, unsigned int);

  80. unsigned int cucul_get_canvas_width(cucul_canvas_t *);

  81. unsigned int cucul_get_canvas_height(cucul_canvas_t *);

  82. int cucul_free_canvas(cucul_canvas_t *);

  83. int cucul_rand(int, int);

  84. /*  @} */

  85. 

  86. /** \defgroup cucul_canvas libcucul canvas drawing

  87.  *

  88.  *  These functions provide low-level character printing routines and

  89.  *  higher level graphics functions.

  90.  *

  91.  *  @{ */

  92. #define CUCUL_MAGIC_FULLWIDTH 0x000ffffe /**< Used to indicate that the previous character was a fullwidth glyph. */

  93. int cucul_gotoxy(cucul_canvas_t *, int, int);

  94. int cucul_get_cursor_x(cucul_canvas_t *);

  95. int cucul_get_cursor_y(cucul_canvas_t *);

  96. int cucul_put_char(cucul_canvas_t *, int, int, unsigned long int);

  97. unsigned long int cucul_get_char(cucul_canvas_t *, int, int);

  98. int cucul_put_str(cucul_canvas_t *, int, int, char const *);

  99. unsigned long int cucul_get_attr(cucul_canvas_t *, int, int);

  100. int cucul_set_attr(cucul_canvas_t *, unsigned long int);

  101. int cucul_put_attr(cucul_canvas_t *, int, int, unsigned long int);

  102. int cucul_set_color_ansi(cucul_canvas_t *, unsigned char, unsigned char);

  103. int cucul_set_color_argb(cucul_canvas_t *, unsigned int, unsigned int);

  104. int cucul_printf(cucul_canvas_t *, int, int, char const *, ...);

  105. int cucul_clear_canvas(cucul_canvas_t *);

  106. int cucul_set_canvas_handle(cucul_canvas_t *, int, int);

  107. int cucul_get_canvas_handle_x(cucul_canvas_t *);

  108. int cucul_get_canvas_handle_y(cucul_canvas_t *);

  109. int cucul_blit(cucul_canvas_t *, int, int, cucul_canvas_t const *,

  110.                cucul_canvas_t const *);

  111. int cucul_set_canvas_boundaries(cucul_canvas_t *, int, int,

  112.                                 unsigned int, unsigned int);

  113. /*  @} */

  114. 

  115. /** \defgroup cucul_transform libcucul canvas transformation

  116.  *

  117.  *  These functions perform horizontal and vertical canvas flipping.

  118.  *

  119.  *  @{ */

  120. int cucul_invert(cucul_canvas_t *);

  121. int cucul_flip(cucul_canvas_t *);

  122. int cucul_flop(cucul_canvas_t *);

  123. int cucul_rotate_180(cucul_canvas_t *);

  124. int cucul_rotate_left(cucul_canvas_t *);

  125. int cucul_rotate_right(cucul_canvas_t *);

  126. int cucul_stretch_left(cucul_canvas_t *);

  127. int cucul_stretch_right(cucul_canvas_t *);

  128. /*  @} */

  129. 

  130. /** \defgroup cucul_attributes libcucul attribute conversions

  131.  *

  132.  *  These functions perform conversions between attribute values.

  133.  *

  134.  *  @{ */

  135. unsigned char cucul_attr_to_ansi(unsigned long int);

  136. unsigned char cucul_attr_to_ansi_fg(unsigned long int);

  137. unsigned char cucul_attr_to_ansi_bg(unsigned long int);

  138. /*  @} */

  139. 

  140. /** \defgroup cucul_charset libcucul character set conversions

  141.  *

  142.  *  These functions perform conversions between usual character sets.

  143.  *

  144.  *  @{ */

  145. unsigned long int cucul_utf8_to_utf32(char const *, unsigned int *);

  146. unsigned int cucul_utf32_to_utf8(char *, unsigned long int);

  147. unsigned char cucul_utf32_to_cp437(unsigned long int);

  148. unsigned long int cucul_cp437_to_utf32(unsigned char);

  149. char cucul_utf32_to_ascii(unsigned long int);

  150. int cucul_utf32_is_fullwidth(unsigned long int);

  151. /*  @} */

  152. 

  153. /** \defgroup cucul_primitives libcucul primitives drawing

  154.  *

  155.  *  These functions provide routines for primitive drawing, such as lines,

  156.  *  boxes, triangles and ellipses.

  157.  *

  158.  *  @{ */

  159. int cucul_draw_line(cucul_canvas_t *, int, int, int, int, unsigned long int);

  160. int cucul_draw_polyline(cucul_canvas_t *, int const x[], int const y[], int,

  161.                         unsigned long int);

  162. int cucul_draw_thin_line(cucul_canvas_t *, int, int, int, int);

  163. int cucul_draw_thin_polyline(cucul_canvas_t *, int const x[], int const y[],

  164.                              int);

  165. 

  166. int cucul_draw_circle(cucul_canvas_t *, int, int, int, unsigned long int);

  167. int cucul_draw_ellipse(cucul_canvas_t *, int, int, int, int, unsigned long int);

  168. int cucul_draw_thin_ellipse(cucul_canvas_t *, int, int, int, int);

  169. int cucul_fill_ellipse(cucul_canvas_t *, int, int, int, int, unsigned long int);

  170. 

  171. int cucul_draw_box(cucul_canvas_t *, int, int, int, int, unsigned long int);

  172. int cucul_draw_thin_box(cucul_canvas_t *, int, int, int, int);

  173. int cucul_draw_cp437_box(cucul_canvas_t *, int, int, int, int);

  174. int cucul_fill_box(cucul_canvas_t *, int, int, int, int, unsigned long int);

  175. 

  176. int cucul_draw_triangle(cucul_canvas_t *, int, int, int, int, int, int,

  177.                         unsigned long int);

  178. int cucul_draw_thin_triangle(cucul_canvas_t *, int, int, int, int, int, int);

  179. int cucul_fill_triangle(cucul_canvas_t *, int, int, int, int, int, int,

  180.                         unsigned long int);

  181. /*  @} */

  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. unsigned int cucul_get_frame_count(cucul_canvas_t *);

  190. int cucul_set_frame(cucul_canvas_t *, unsigned int);

  191. char const *cucul_get_frame_name(cucul_canvas_t *);

  192. int cucul_set_frame_name(cucul_canvas_t *, char const *);

  193. int cucul_create_frame(cucul_canvas_t *, unsigned int);

  194. int cucul_free_frame(cucul_canvas_t *, unsigned int);

  195. /*  @} */

  196. 

  197. /** \defgroup cucul_dither libcucul bitmap dithering

  198.  *

  199.  *  These functions provide high level routines for dither allocation and

  200.  *  rendering.

  201.  *

  202.  *  @{ */

  203. cucul_dither_t *cucul_create_dither(unsigned int, unsigned int,

  204.                                     unsigned int, unsigned int,

  205.                                     unsigned long int, unsigned long int,

  206.                                     unsigned long int, unsigned long int);

  207. int cucul_set_dither_palette(cucul_dither_t *,

  208.                              unsigned int r[], unsigned int g[],

  209.                              unsigned int b[], unsigned int a[]);

  210. int cucul_set_dither_brightness(cucul_dither_t *, float);

  211. float cucul_get_dither_brightness(cucul_dither_t *);

  212. int cucul_set_dither_gamma(cucul_dither_t *, float);

  213. float cucul_get_dither_gamma(cucul_dither_t *);

  214. int cucul_set_dither_contrast(cucul_dither_t *, float);

  215. float cucul_get_dither_contrast(cucul_dither_t *);

  216. int cucul_set_dither_antialias(cucul_dither_t *, char const *);

  217. char const * const * cucul_get_dither_antialias_list(cucul_dither_t const *);

  218. char const * cucul_get_dither_antialias(cucul_dither_t const *);

  219. int cucul_set_dither_color(cucul_dither_t *, char const *);

  220. char const * const * cucul_get_dither_color_list(cucul_dither_t const *);

  221. char const * cucul_get_dither_color(cucul_dither_t const *);

  222. int cucul_set_dither_charset(cucul_dither_t *, char const *);

  223. char const * const * cucul_get_dither_charset_list(cucul_dither_t const *);

  224. char const * cucul_get_dither_charset(cucul_dither_t const *);

  225. int cucul_set_dither_algorithm(cucul_dither_t *, char const *);

  226. char const * const * cucul_get_dither_algorithm_list(cucul_dither_t const *);

  227. char const * cucul_get_dither_algorithm(cucul_dither_t const *);

  228. int cucul_dither_bitmap(cucul_canvas_t *, int, int, int, int,

  229.                          cucul_dither_t const *, void *);

  230. int cucul_free_dither(cucul_dither_t *);

  231. /*  @} */

  232. 

  233. /** \defgroup cucul_font libcucul font handling

  234.  *

  235.  *  These functions provide font handling routines and high quality

  236.  *  canvas to bitmap rendering.

  237.  *

  238.  *  @{ */

  239. cucul_font_t *cucul_load_font(void const *, unsigned int);

  240. char const * const * cucul_get_font_list(void);

  241. unsigned int cucul_get_font_width(cucul_font_t *);

  242. unsigned int cucul_get_font_height(cucul_font_t *);

  243. unsigned long int const *cucul_get_font_blocks(cucul_font_t *);

  244. int cucul_render_canvas(cucul_canvas_t *, cucul_font_t *, void *,

  245.                          unsigned int, unsigned int, unsigned int);

  246. int cucul_free_font(cucul_font_t *);

  247. /*  @} */

  248. 

  249. /** \defgroup cucul_importexport libcucul importers/exporters from/to various

  250.  *  formats

  251.  *

  252.  *  These functions import various file formats into a new canvas, or export

  253.  *  the current canvas to various text formats.

  254.  *

  255.  *  @{ */

  256. long int cucul_import_memory(cucul_canvas_t *, void const *,

  257.                              unsigned long int, char const *);

  258. long int cucul_import_file(cucul_canvas_t *, char const *, char const *);

  259. char const * const * cucul_get_import_list(void);

  260. void *cucul_export_memory(cucul_canvas_t *, char const *, unsigned long int *);

  261. char const * const * cucul_get_export_list(void);

  262. /*  @} */

  263. 

  264. #if !defined(_DOXYGEN_SKIP_ME)

  265.     /* Legacy stuff from beta versions, will probably disappear in 1.0 */

  266.     typedef struct cucul_buffer cucul_buffer_t;

  267. #   if defined __GNUC__ && __GNUC__ >= 3

  268. #       define CUCUL_DEPRECATED __attribute__ ((__deprecated__))

  269. #   else

  270. #       define CUCUL_DEPRECATED

  271. #   endif

  272.     int cucul_putchar(cucul_canvas_t *, int, int,

  273.                       unsigned long int) CUCUL_DEPRECATED;

  274.     unsigned long int cucul_getchar(cucul_canvas_t *,

  275.                                     int, int) CUCUL_DEPRECATED;

  276.     int cucul_putstr(cucul_canvas_t *, int, int,

  277.                      char const *) CUCUL_DEPRECATED;

  278.     int cucul_set_color(cucul_canvas_t *, unsigned char,

  279.                         unsigned char) CUCUL_DEPRECATED;

  280.     int cucul_set_truecolor(cucul_canvas_t *, unsigned int,

  281.                             unsigned int) CUCUL_DEPRECATED;

  282.     unsigned int cucul_get_canvas_frame_count(cucul_canvas_t *)

  283.                                               CUCUL_DEPRECATED;

  284.     int cucul_set_canvas_frame(cucul_canvas_t *,

  285.                                unsigned int) CUCUL_DEPRECATED;

  286.     int cucul_create_canvas_frame(cucul_canvas_t *,

  287.                                   unsigned int) CUCUL_DEPRECATED;

  288.     int cucul_free_canvas_frame(cucul_canvas_t *,

  289.                                 unsigned int) CUCUL_DEPRECATED;

  290.     cucul_buffer_t *cucul_load_memory(void *,

  291.                                       unsigned long int) CUCUL_DEPRECATED;

  292.     cucul_buffer_t *cucul_load_file(char const *) CUCUL_DEPRECATED;

  293.     unsigned long int cucul_get_buffer_size(cucul_buffer_t *) CUCUL_DEPRECATED;

  294.     void * cucul_get_buffer_data(cucul_buffer_t *) CUCUL_DEPRECATED;

  295.     int cucul_free_buffer(cucul_buffer_t *) CUCUL_DEPRECATED;

  296.     cucul_buffer_t * cucul_export_canvas(cucul_canvas_t *,

  297.                                          char const *) CUCUL_DEPRECATED;

  298.     cucul_canvas_t * cucul_import_canvas(cucul_buffer_t *,

  299.                                          char const *) CUCUL_DEPRECATED;

  300.     int cucul_rotate(cucul_canvas_t *) CUCUL_DEPRECATED;

  301.     int cucul_set_dither_invert(cucul_dither_t *, int) CUCUL_DEPRECATED;

  302.     int cucul_set_dither_mode(cucul_dither_t *, char const *) CUCUL_DEPRECATED;

  303.     char const * const * cucul_get_dither_mode_list(cucul_dither_t

  304.                                                     const *) CUCUL_DEPRECATED;

  305. #   define CUCUL_COLOR_BLACK CUCUL_BLACK

  306. #   define CUCUL_COLOR_BLUE CUCUL_BLUE

  307. #   define CUCUL_COLOR_GREEN CUCUL_GREEN

  308. #   define CUCUL_COLOR_CYAN CUCUL_CYAN

  309. #   define CUCUL_COLOR_RED CUCUL_RED

  310. #   define CUCUL_COLOR_MAGENTA CUCUL_MAGENTA

  311. #   define CUCUL_COLOR_BROWN CUCUL_BROWN

  312. #   define CUCUL_COLOR_LIGHTGRAY CUCUL_LIGHTGRAY

  313. #   define CUCUL_COLOR_DARKGRAY CUCUL_DARKGRAY

  314. #   define CUCUL_COLOR_LIGHTBLUE CUCUL_LIGHTBLUE

  315. #   define CUCUL_COLOR_LIGHTGREEN CUCUL_LIGHTGREEN

  316. #   define CUCUL_COLOR_LIGHTCYAN CUCUL_LIGHTCYAN

  317. #   define CUCUL_COLOR_LIGHTRED CUCUL_LIGHTRED

  318. #   define CUCUL_COLOR_LIGHTMAGENTA CUCUL_LIGHTMAGENTA

  319. #   define CUCUL_COLOR_YELLOW CUCUL_YELLOW

  320. #   define CUCUL_COLOR_WHITE CUCUL_YELLOW

  321. #   define CUCUL_COLOR_DEFAULT CUCUL_DEFAULT

  322. #   define CUCUL_COLOR_TRANSPARENT CUCUL_TRANSPARENT

  323. #endif

  324. 

  325. #ifdef __cplusplus

  326. }

  327. #endif

  328. 

  329. #endif /* __CUCUL_H__ */