cacalabs
/
libcaca
mirror of https://github.com/cacalabs/libcaca.git
1
0
Fork 0
Code Issues 0 Releases 7 Wiki Activity
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.
1315 Commits
1 Branch
26 MiB
 
 
 
 
 
 
Tree: e87056cd1b
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'e87056cd1b'
${ noResults }
libcaca/cucul/cucul.h

383 lines
17 KiB
Raw Blame History 

  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. #include <cucul_types.h>

  28. 

  29. #undef __extern

  30. #if defined(_DOXYGEN_SKIP_ME)

  31. #elif defined(_WIN32) && defined(__LIBCUCUL__)

  32. #   define __extern extern __declspec(dllexport)

  33. #else

  34. #   define __extern extern

  35. #endif

  36. 

  37. /** libcucul API version */

  38. #define CUCUL_API_VERSION_1

  39. 

  40. #ifdef __cplusplus

  41. extern "C"

  42. {

  43. #endif

  44. 

  45. /** \e libcucul canvas */

  46. typedef struct cucul_canvas cucul_canvas_t;

  47. /** dither structure */

  48. typedef struct cucul_dither cucul_dither_t;

  49. /** font structure */

  50. typedef struct cucul_font cucul_font_t;

  51. /** file handle structure */

  52. typedef struct cucul_file cucul_file_t;

  53. 

  54. /** \defgroup cucul_attr libcucul attribute definitions

  55.  *

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

  57.  *

  58.  *  @{ */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  77. 

  78. #define CUCUL_BOLD 0x01 /**< The style mask for bold. */

  79. #define CUCUL_ITALICS 0x02 /**< The style mask for italics. */

  80. #define CUCUL_UNDERLINE 0x04 /**< The style mask for underline. */

  81. #define CUCUL_BLINK 0x08 /**< The style mask for blink. */

  82. /*  @} */

  83. 

  84. /** \defgroup libcucul libcucul basic functions

  85.  *

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

  87.  *  initialisation, system information retrieval and configuration.

  88.  *

  89.  *  @{ */

  90. __extern cucul_canvas_t * cucul_create_canvas(int, int);

  91. __extern int cucul_manage_canvas(cucul_canvas_t *, int (*)(void *), void *);

  92. __extern int cucul_unmanage_canvas(cucul_canvas_t *, int (*)(void *), void *);

  93. __extern int cucul_set_canvas_size(cucul_canvas_t *, int, int);

  94. __extern int cucul_get_canvas_width(cucul_canvas_t const *);

  95. __extern int cucul_get_canvas_height(cucul_canvas_t const *);

  96. __extern uint8_t const * cucul_get_canvas_chars(cucul_canvas_t const *);

  97. __extern uint8_t const * cucul_get_canvas_attrs(cucul_canvas_t const *);

  98. __extern int cucul_free_canvas(cucul_canvas_t *);

  99. __extern int cucul_rand(int, int);

  100. __extern char const * cucul_get_version(void);

  101. /*  @} */

  102. 

  103. /** \defgroup cucul_canvas libcucul canvas drawing

  104.  *

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

  106.  *  higher level graphics functions.

  107.  *

  108.  *  @{ */

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

  110. __extern int cucul_gotoxy(cucul_canvas_t *, int, int);

  111. __extern int cucul_get_cursor_x(cucul_canvas_t const *);

  112. __extern int cucul_get_cursor_y(cucul_canvas_t const *);

  113. __extern int cucul_put_char(cucul_canvas_t *, int, int, uint32_t);

  114. __extern uint32_t cucul_get_char(cucul_canvas_t const *, int, int);

  115. __extern int cucul_put_str(cucul_canvas_t *, int, int, char const *);

  116. __extern uint32_t cucul_get_attr(cucul_canvas_t const *, int, int);

  117. __extern int cucul_set_attr(cucul_canvas_t *, uint32_t);

  118. __extern int cucul_put_attr(cucul_canvas_t *, int, int, uint32_t);

  119. __extern int cucul_set_color_ansi(cucul_canvas_t *, uint8_t, uint8_t);

  120. __extern int cucul_set_color_argb(cucul_canvas_t *, uint16_t, uint16_t);

  121. __extern int cucul_printf(cucul_canvas_t *, int, int, char const *, ...);

  122. __extern int cucul_clear_canvas(cucul_canvas_t *);

  123. __extern int cucul_set_canvas_handle(cucul_canvas_t *, int, int);

  124. __extern int cucul_get_canvas_handle_x(cucul_canvas_t const *);

  125. __extern int cucul_get_canvas_handle_y(cucul_canvas_t const *);

  126. __extern int cucul_blit(cucul_canvas_t *, int, int, cucul_canvas_t const *,

  127.                         cucul_canvas_t const *);

  128. __extern int cucul_set_canvas_boundaries(cucul_canvas_t *, int, int, int, int);

  129. /*  @} */

  130. 

  131. /** \defgroup cucul_transform libcucul canvas transformation

  132.  *

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

  134.  *

  135.  *  @{ */

  136. __extern int cucul_invert(cucul_canvas_t *);

  137. __extern int cucul_flip(cucul_canvas_t *);

  138. __extern int cucul_flop(cucul_canvas_t *);

  139. __extern int cucul_rotate_180(cucul_canvas_t *);

  140. __extern int cucul_rotate_left(cucul_canvas_t *);

  141. __extern int cucul_rotate_right(cucul_canvas_t *);

  142. __extern int cucul_stretch_left(cucul_canvas_t *);

  143. __extern int cucul_stretch_right(cucul_canvas_t *);

  144. /*  @} */

  145. 

  146. /** \defgroup cucul_attributes libcucul attribute conversions

  147.  *

  148.  *  These functions perform conversions between attribute values.

  149.  *

  150.  *  @{ */

  151. __extern uint8_t cucul_attr_to_ansi(uint32_t);

  152. __extern uint8_t cucul_attr_to_ansi_fg(uint32_t);

  153. __extern uint8_t cucul_attr_to_ansi_bg(uint32_t);

  154. __extern uint16_t cucul_attr_to_rgb12_fg(uint32_t);

  155. __extern uint16_t cucul_attr_to_rgb12_bg(uint32_t);

  156. __extern void cucul_attr_to_argb64(uint32_t, uint8_t[8]);

  157. /*  @} */

  158. 

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

  160.  *

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

  162.  *

  163.  *  @{ */

  164. __extern uint32_t cucul_utf8_to_utf32(char const *, size_t *);

  165. __extern size_t cucul_utf32_to_utf8(char *, uint32_t);

  166. __extern uint8_t cucul_utf32_to_cp437(uint32_t);

  167. __extern uint32_t cucul_cp437_to_utf32(uint8_t);

  168. __extern char cucul_utf32_to_ascii(uint32_t);

  169. __extern int cucul_utf32_is_fullwidth(uint32_t);

  170. /*  @} */

  171. 

  172. /** \defgroup cucul_primitives libcucul primitives drawing

  173.  *

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

  175.  *  boxes, triangles and ellipses.

  176.  *

  177.  *  @{ */

  178. __extern int cucul_draw_line(cucul_canvas_t *, int, int, int, int, uint32_t);

  179. __extern int cucul_draw_polyline(cucul_canvas_t *, int const x[],

  180.                                  int const y[], int, uint32_t);

  181. __extern int cucul_draw_thin_line(cucul_canvas_t *, int, int, int, int);

  182. __extern int cucul_draw_thin_polyline(cucul_canvas_t *, int const x[],

  183.                                       int const y[], int);

  184. 

  185. __extern int cucul_draw_circle(cucul_canvas_t *, int, int, int, uint32_t);

  186. __extern int cucul_draw_ellipse(cucul_canvas_t *, int, int, int, int, uint32_t);

  187. __extern int cucul_draw_thin_ellipse(cucul_canvas_t *, int, int, int, int);

  188. __extern int cucul_fill_ellipse(cucul_canvas_t *, int, int, int, int, uint32_t);

  189. 

  190. __extern int cucul_draw_box(cucul_canvas_t *, int, int, int, int, uint32_t);

  191. __extern int cucul_draw_thin_box(cucul_canvas_t *, int, int, int, int);

  192. __extern int cucul_draw_cp437_box(cucul_canvas_t *, int, int, int, int);

  193. __extern int cucul_fill_box(cucul_canvas_t *, int, int, int, int, uint32_t);

  194. 

  195. __extern int cucul_draw_triangle(cucul_canvas_t *, int, int, int, int, int,

  196.                                  int, uint32_t);

  197. __extern int cucul_draw_thin_triangle(cucul_canvas_t *, int, int, int, int,

  198.                                       int, int);

  199. __extern int cucul_fill_triangle(cucul_canvas_t *, int, int, int, int, int,

  200.                                  int, uint32_t);

  201. /*  @} */

  202. 

  203. /** \defgroup cucul_frame libcucul canvas frame handling

  204.  *

  205.  *  These functions provide high level routines for canvas frame insertion,

  206.  *  removal, copying etc.

  207.  *

  208.  *  @{ */

  209. __extern int cucul_get_frame_count(cucul_canvas_t const *);

  210. __extern int cucul_set_frame(cucul_canvas_t *, int);

  211. __extern char const *cucul_get_frame_name(cucul_canvas_t const *);

  212. __extern int cucul_set_frame_name(cucul_canvas_t *, char const *);

  213. __extern int cucul_create_frame(cucul_canvas_t *, int);

  214. __extern int cucul_free_frame(cucul_canvas_t *, int);

  215. /*  @} */

  216. 

  217. /** \defgroup cucul_dither libcucul bitmap dithering

  218.  *

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

  220.  *  rendering.

  221.  *

  222.  *  @{ */

  223. __extern cucul_dither_t *cucul_create_dither(int, int, int, int,

  224.                                              uint32_t, uint32_t,

  225.                                              uint32_t, uint32_t);

  226. __extern int cucul_set_dither_palette(cucul_dither_t *,

  227.                                       uint32_t r[], uint32_t g[],

  228.                                       uint32_t b[], uint32_t a[]);

  229. __extern int cucul_set_dither_brightness(cucul_dither_t *, float);

  230. __extern float cucul_get_dither_brightness(cucul_dither_t const *);

  231. __extern int cucul_set_dither_gamma(cucul_dither_t *, float);

  232. __extern float cucul_get_dither_gamma(cucul_dither_t const *);

  233. __extern int cucul_set_dither_contrast(cucul_dither_t *, float);

  234. __extern float cucul_get_dither_contrast(cucul_dither_t const *);

  235. __extern int cucul_set_dither_antialias(cucul_dither_t *, char const *);

  236. __extern char const * const * cucul_get_dither_antialias_list(cucul_dither_t

  237.                                                               const *);

  238. __extern char const * cucul_get_dither_antialias(cucul_dither_t const *);

  239. __extern int cucul_set_dither_color(cucul_dither_t *, char const *);

  240. __extern char const * const * cucul_get_dither_color_list(cucul_dither_t

  241.                                                           const *);

  242. __extern char const * cucul_get_dither_color(cucul_dither_t const *);

  243. __extern int cucul_set_dither_charset(cucul_dither_t *, char const *);

  244. __extern char const * const * cucul_get_dither_charset_list(cucul_dither_t

  245.                                                             const *);

  246. __extern char const * cucul_get_dither_charset(cucul_dither_t const *);

  247. __extern int cucul_set_dither_algorithm(cucul_dither_t *, char const *);

  248. __extern char const * const * cucul_get_dither_algorithm_list(cucul_dither_t

  249.                                                               const *);

  250. __extern char const * cucul_get_dither_algorithm(cucul_dither_t const *);

  251. __extern int cucul_dither_bitmap(cucul_canvas_t *, int, int, int, int,

  252.                          cucul_dither_t const *, void *);

  253. __extern int cucul_free_dither(cucul_dither_t *);

  254. /*  @} */

  255. 

  256. /** \defgroup cucul_font libcucul font handling

  257.  *

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

  259.  *  canvas to bitmap rendering.

  260.  *

  261.  *  @{ */

  262. __extern cucul_font_t *cucul_load_font(void const *, size_t);

  263. __extern char const * const * cucul_get_font_list(void);

  264. __extern int cucul_get_font_width(cucul_font_t const *);

  265. __extern int cucul_get_font_height(cucul_font_t const *);

  266. __extern uint32_t const *cucul_get_font_blocks(cucul_font_t const *);

  267. __extern int cucul_render_canvas(cucul_canvas_t const *, cucul_font_t const *,

  268.                                  void *, int, int, int);

  269. __extern int cucul_free_font(cucul_font_t *);

  270. /*  @} */

  271. 

  272. /** \defgroup cucul_figfont libcucul FIGfont handling

  273.  *

  274.  *  These functions provide FIGlet and TOIlet font handling routines.

  275.  *

  276.  *  @{ */

  277. __extern int cucul_canvas_set_figfont(cucul_canvas_t *, char const *);

  278. __extern int cucul_put_figchar(cucul_canvas_t *, uint32_t);

  279. /*  @} */

  280. 

  281. /** \defgroup cucul_file libcucul file IO

  282.  *

  283.  *  These functions allow to read and write files in a platform-independent

  284.  *  way.

  285.  *  @{ */

  286. __extern cucul_file_t *cucul_file_open(char const *, const char *);

  287. __extern int cucul_file_close(cucul_file_t *);

  288. __extern uint64_t cucul_file_tell(cucul_file_t *);

  289. __extern size_t cucul_file_read(cucul_file_t *, void *, size_t);

  290. __extern size_t cucul_file_write(cucul_file_t *, const void *, size_t);

  291. __extern char * cucul_file_gets(cucul_file_t *, char *, int);

  292. __extern int cucul_file_eof(cucul_file_t *);

  293. /*  @} */

  294. 

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

  296.  *  formats

  297.  *

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

  299.  *  the current canvas to various text formats.

  300.  *

  301.  *  @{ */

  302. __extern ssize_t cucul_import_memory(cucul_canvas_t *, void const *,

  303.                                      size_t, char const *);

  304. __extern ssize_t cucul_import_file(cucul_canvas_t *, char const *,

  305.                                    char const *);

  306. __extern char const * const * cucul_get_import_list(void);

  307. __extern void *cucul_export_memory(cucul_canvas_t const *, char const *,

  308.                                    size_t *);

  309. __extern char const * const * cucul_get_export_list(void);

  310. /*  @} */

  311. 

  312. #if !defined(_DOXYGEN_SKIP_ME)

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

  314. typedef struct cucul_buffer cucul_buffer_t;

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

  316. #       define CUCUL_DEPRECATED __attribute__ ((__deprecated__))

  317. #   else

  318. #       define CUCUL_DEPRECATED

  319. #   endif

  320. __extern int cucul_putchar(cucul_canvas_t *, int, int,

  321.                            unsigned long int) CUCUL_DEPRECATED;

  322. __extern unsigned long int cucul_getchar(cucul_canvas_t *,

  323.                                          int, int) CUCUL_DEPRECATED;

  324. __extern int cucul_putstr(cucul_canvas_t *, int, int,

  325.                           char const *) CUCUL_DEPRECATED;

  326. __extern int cucul_set_color(cucul_canvas_t *, unsigned char,

  327.                              unsigned char) CUCUL_DEPRECATED;

  328. __extern int cucul_set_truecolor(cucul_canvas_t *, unsigned int,

  329.                                  unsigned int) CUCUL_DEPRECATED;

  330. __extern unsigned int cucul_get_canvas_frame_count(cucul_canvas_t *)

  331.                                                    CUCUL_DEPRECATED;

  332. __extern int cucul_set_canvas_frame(cucul_canvas_t *,

  333.                                     unsigned int) CUCUL_DEPRECATED;

  334. __extern int cucul_create_canvas_frame(cucul_canvas_t *,

  335.                                        unsigned int) CUCUL_DEPRECATED;

  336. __extern int cucul_free_canvas_frame(cucul_canvas_t *,

  337.                                      unsigned int) CUCUL_DEPRECATED;

  338. __extern cucul_buffer_t *cucul_load_memory(void *,

  339.                                            unsigned long int) CUCUL_DEPRECATED;

  340. __extern cucul_buffer_t *cucul_load_file(char const *) CUCUL_DEPRECATED;

  341. __extern unsigned long int cucul_get_buffer_size(cucul_buffer_t *)

  342.                                                  CUCUL_DEPRECATED;

  343. __extern void * cucul_get_buffer_data(cucul_buffer_t *) CUCUL_DEPRECATED;

  344. __extern int cucul_free_buffer(cucul_buffer_t *) CUCUL_DEPRECATED;

  345. __extern cucul_buffer_t * cucul_export_canvas(cucul_canvas_t *,

  346.                                               char const *) CUCUL_DEPRECATED;

  347. __extern cucul_canvas_t * cucul_import_canvas(cucul_buffer_t *,

  348.                                               char const *) CUCUL_DEPRECATED;

  349. __extern int cucul_rotate(cucul_canvas_t *) CUCUL_DEPRECATED;

  350. __extern int cucul_set_dither_invert(cucul_dither_t *, int) CUCUL_DEPRECATED;

  351. __extern int cucul_set_dither_mode(cucul_dither_t *,

  352.                                    char const *) CUCUL_DEPRECATED;

  353. __extern char const * const * cucul_get_dither_mode_list(cucul_dither_t

  354.                                                          const *)

  355.                                                          CUCUL_DEPRECATED;

  356. #   define CUCUL_COLOR_BLACK CUCUL_BLACK

  357. #   define CUCUL_COLOR_BLUE CUCUL_BLUE

  358. #   define CUCUL_COLOR_GREEN CUCUL_GREEN

  359. #   define CUCUL_COLOR_CYAN CUCUL_CYAN

  360. #   define CUCUL_COLOR_RED CUCUL_RED

  361. #   define CUCUL_COLOR_MAGENTA CUCUL_MAGENTA

  362. #   define CUCUL_COLOR_BROWN CUCUL_BROWN

  363. #   define CUCUL_COLOR_LIGHTGRAY CUCUL_LIGHTGRAY

  364. #   define CUCUL_COLOR_DARKGRAY CUCUL_DARKGRAY

  365. #   define CUCUL_COLOR_LIGHTBLUE CUCUL_LIGHTBLUE

  366. #   define CUCUL_COLOR_LIGHTGREEN CUCUL_LIGHTGREEN

  367. #   define CUCUL_COLOR_LIGHTCYAN CUCUL_LIGHTCYAN

  368. #   define CUCUL_COLOR_LIGHTRED CUCUL_LIGHTRED

  369. #   define CUCUL_COLOR_LIGHTMAGENTA CUCUL_LIGHTMAGENTA

  370. #   define CUCUL_COLOR_YELLOW CUCUL_YELLOW

  371. #   define CUCUL_COLOR_WHITE CUCUL_YELLOW

  372. #   define CUCUL_COLOR_DEFAULT CUCUL_DEFAULT

  373. #   define CUCUL_COLOR_TRANSPARENT CUCUL_TRANSPARENT

  374. #endif

  375. 

  376. #ifdef __cplusplus

  377. }

  378. #endif

  379. 

  380. #undef __extern

  381. 

  382. #endif /* __CUCUL_H__ */