cacalabs
/
libcaca
espelhamento de https://github.com/cacalabs/libcaca.git
1
0
Fork 0
Código Issues 0 Versões 7 Wiki Atividade
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.
1727 Commits
1 Branch
84 MiB
 
 
 
 
 
 
Tag: 4ea7d027a7
Branches Tags
${ item.name }
Criar branch ${ searchTerm }
de 4ea7d027a7
${ noResults }
libcaca/caca/caca.h

870 linhas
37 KiB
Original Anotar Histórico 

  1. /*

  2.  *  libcaca       Colour ASCII-Art library

  3.  *  Copyright (c) 2002-2009 Sam Hocevar <sam@hocevar.net>

  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 caca.h

  16.  *  \version \$Id$

  17.  *  \author Sam Hocevar <sam@hocevar.net>

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

  19.  *

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

  21.  *  using \e libcaca may use.

  22.  */

  23. 

  24. #ifndef __CACA_H__

  25. #define __CACA_H__

  26. 

  27. #include <caca_types.h>

  28. 

  29. #if !defined(__KERNEL__)

  30. #   include <stdarg.h>

  31. #endif

  32. 

  33. #undef __extern

  34. #if defined(_DOXYGEN_SKIP_ME)

  35. #elif defined(_WIN32) && defined(__LIBCACA__)

  36. #   define __extern extern __declspec(dllexport)

  37. #elif defined(_WIN32)

  38. #   define __extern extern __declspec(dllimport)

  39. #else

  40. #   define __extern extern

  41. #endif

  42. 

  43. /** libcaca API version */

  44. #define CACA_API_VERSION_1

  45. 

  46. #ifdef __cplusplus

  47. extern "C"

  48. {

  49. #endif

  50. 

  51. /** \e libcaca canvas */

  52. typedef struct caca_canvas caca_canvas_t;

  53. /** dither structure */

  54. typedef struct caca_dither caca_dither_t;

  55. /** font structure */

  56. typedef struct caca_font caca_font_t;

  57. /** file handle structure */

  58. typedef struct caca_file caca_file_t;

  59. /** \e libcaca display context */

  60. typedef struct caca_display caca_display_t;

  61. /** \e libcaca event structure */

  62. typedef struct caca_event caca_event_t;

  63. 

  64. /** \defgroup caca_attr libcaca attribute definitions

  65.  *

  66.  *  Colours and styles that can be used with caca_set_attr().

  67.  *

  68.  *  @{ */

  69. enum caca_color

  70. {

  71.     CACA_BLACK =        0x00, /**< The colour index for black. */

  72.     CACA_BLUE =         0x01, /**< The colour index for blue. */

  73.     CACA_GREEN =        0x02, /**< The colour index for green. */

  74.     CACA_CYAN =         0x03, /**< The colour index for cyan. */

  75.     CACA_RED =          0x04, /**< The colour index for red. */

  76.     CACA_MAGENTA =      0x05, /**< The colour index for magenta. */

  77.     CACA_BROWN =        0x06, /**< The colour index for brown. */

  78.     CACA_LIGHTGRAY =    0x07, /**< The colour index for light gray. */

  79.     CACA_DARKGRAY =     0x08, /**< The colour index for dark gray. */

  80.     CACA_LIGHTBLUE =    0x09, /**< The colour index for blue. */

  81.     CACA_LIGHTGREEN =   0x0a, /**< The colour index for light green. */

  82.     CACA_LIGHTCYAN =    0x0b, /**< The colour index for light cyan. */

  83.     CACA_LIGHTRED =     0x0c, /**< The colour index for light red. */

  84.     CACA_LIGHTMAGENTA = 0x0d, /**< The colour index for light magenta. */

  85.     CACA_YELLOW =       0x0e, /**< The colour index for yellow. */

  86.     CACA_WHITE =        0x0f, /**< The colour index for white. */

  87.     CACA_DEFAULT =      0x10, /**< The output driver's default colour. */

  88.     CACA_TRANSPARENT =  0x20, /**< The transparent colour. */

  89. };

  90. 

  91. enum caca_style

  92. {

  93.     CACA_BOLD =      0x01, /**< The style mask for bold. */

  94.     CACA_ITALICS =   0x02, /**< The style mask for italics. */

  95.     CACA_UNDERLINE = 0x04, /**< The style mask for underline. */

  96.     CACA_BLINK =     0x08, /**< The style mask for blink. */

  97. };

  98. /*  @} */

  99. 

  100. /** \brief User event type enumeration.

  101.  *

  102.  *  This enum serves two purposes:

  103.  *  - Build listening masks for caca_get_event().

  104.  *  - Define the type of a \e caca_event_t.

  105.  */

  106. enum caca_event_type

  107. {

  108.     CACA_EVENT_NONE =          0x0000, /**< No event. */

  109. 

  110.     CACA_EVENT_KEY_PRESS =     0x0001, /**< A key was pressed. */

  111.     CACA_EVENT_KEY_RELEASE =   0x0002, /**< A key was released. */

  112.     CACA_EVENT_MOUSE_PRESS =   0x0004, /**< A mouse button was pressed. */

  113.     CACA_EVENT_MOUSE_RELEASE = 0x0008, /**< A mouse button was released. */

  114.     CACA_EVENT_MOUSE_MOTION =  0x0010, /**< The mouse was moved. */

  115.     CACA_EVENT_RESIZE =        0x0020, /**< The window was resized. */

  116.     CACA_EVENT_QUIT =          0x0040, /**< The user requested to quit. */

  117. 

  118.     CACA_EVENT_ANY =           0xffff  /**< Bitmask for any event. */

  119. };

  120. 

  121. /** \brief Handling of user events.

  122.  *

  123.  *  This structure is filled by caca_get_event() when an event is received.

  124.  *  It is an opaque structure that should only be accessed through

  125.  *  caca_event_get_type() and similar functions. The struct members may no

  126.  *  longer be directly accessible in future versions.

  127.  */

  128. struct caca_event

  129. {

  130.     enum caca_event_type type;

  131.     union

  132.     {

  133.         struct { int x, y, button; } mouse;

  134.         struct { int w, h; } resize;

  135.         struct { int ch; uint32_t utf32; char utf8[8]; } key;

  136.     } data;

  137.     uint8_t padding[16];

  138. };

  139. 

  140. /** \brief Special key values.

  141.  *

  142.  *  Special key values returned by caca_get_event() for which there is no

  143.  *  printable ASCII equivalent.

  144.  */

  145. enum caca_key

  146. {

  147.     CACA_KEY_UNKNOWN = 0x00, /**< Unknown key. */

  148. 

  149.     /* The following keys have ASCII equivalents */

  150.     CACA_KEY_CTRL_A =    0x01, /**< The Ctrl-A key. */

  151.     CACA_KEY_CTRL_B =    0x02, /**< The Ctrl-B key. */

  152.     CACA_KEY_CTRL_C =    0x03, /**< The Ctrl-C key. */

  153.     CACA_KEY_CTRL_D =    0x04, /**< The Ctrl-D key. */

  154.     CACA_KEY_CTRL_E =    0x05, /**< The Ctrl-E key. */

  155.     CACA_KEY_CTRL_F =    0x06, /**< The Ctrl-F key. */

  156.     CACA_KEY_CTRL_G =    0x07, /**< The Ctrl-G key. */

  157.     CACA_KEY_BACKSPACE = 0x08, /**< The backspace key. */

  158.     CACA_KEY_TAB =       0x09, /**< The tabulation key. */

  159.     CACA_KEY_CTRL_J =    0x0a, /**< The Ctrl-J key. */

  160.     CACA_KEY_CTRL_K =    0x0b, /**< The Ctrl-K key. */

  161.     CACA_KEY_CTRL_L =    0x0c, /**< The Ctrl-L key. */

  162.     CACA_KEY_RETURN =    0x0d, /**< The return key. */

  163.     CACA_KEY_CTRL_N =    0x0e, /**< The Ctrl-N key. */

  164.     CACA_KEY_CTRL_O =    0x0f, /**< The Ctrl-O key. */

  165.     CACA_KEY_CTRL_P =    0x10, /**< The Ctrl-P key. */

  166.     CACA_KEY_CTRL_Q =    0x11, /**< The Ctrl-Q key. */

  167.     CACA_KEY_CTRL_R =    0x12, /**< The Ctrl-R key. */

  168.     CACA_KEY_PAUSE =     0x13, /**< The pause key. */

  169.     CACA_KEY_CTRL_T =    0x14, /**< The Ctrl-T key. */

  170.     CACA_KEY_CTRL_U =    0x15, /**< The Ctrl-U key. */

  171.     CACA_KEY_CTRL_V =    0x16, /**< The Ctrl-V key. */

  172.     CACA_KEY_CTRL_W =    0x17, /**< The Ctrl-W key. */

  173.     CACA_KEY_CTRL_X =    0x18, /**< The Ctrl-X key. */

  174.     CACA_KEY_CTRL_Y =    0x19, /**< The Ctrl-Y key. */

  175.     CACA_KEY_CTRL_Z =    0x1a, /**< The Ctrl-Z key. */

  176.     CACA_KEY_ESCAPE =    0x1b, /**< The escape key. */

  177.     CACA_KEY_DELETE =    0x7f, /**< The delete key. */

  178. 

  179.     /* The following keys do not have ASCII equivalents but have been

  180.      * chosen to match the SDL equivalents */

  181.     CACA_KEY_UP =    0x111, /**< The up arrow key. */

  182.     CACA_KEY_DOWN =  0x112, /**< The down arrow key. */

  183.     CACA_KEY_LEFT =  0x113, /**< The left arrow key. */

  184.     CACA_KEY_RIGHT = 0x114, /**< The right arrow key. */

  185. 

  186.     CACA_KEY_INSERT =   0x115, /**< The insert key. */

  187.     CACA_KEY_HOME =     0x116, /**< The home key. */

  188.     CACA_KEY_END =      0x117, /**< The end key. */

  189.     CACA_KEY_PAGEUP =   0x118, /**< The page up key. */

  190.     CACA_KEY_PAGEDOWN = 0x119, /**< The page down key. */

  191. 

  192.     CACA_KEY_F1 =  0x11a, /**< The F1 key. */

  193.     CACA_KEY_F2 =  0x11b, /**< The F2 key. */

  194.     CACA_KEY_F3 =  0x11c, /**< The F3 key. */

  195.     CACA_KEY_F4 =  0x11d, /**< The F4 key. */

  196.     CACA_KEY_F5 =  0x11e, /**< The F5 key. */

  197.     CACA_KEY_F6 =  0x11f, /**< The F6 key. */

  198.     CACA_KEY_F7 =  0x120, /**< The F7 key. */

  199.     CACA_KEY_F8 =  0x121, /**< The F8 key. */

  200.     CACA_KEY_F9 =  0x122, /**< The F9 key. */

  201.     CACA_KEY_F10 = 0x123, /**< The F10 key. */

  202.     CACA_KEY_F11 = 0x124, /**< The F11 key. */

  203.     CACA_KEY_F12 = 0x125, /**< The F12 key. */

  204.     CACA_KEY_F13 = 0x126, /**< The F13 key. */

  205.     CACA_KEY_F14 = 0x127, /**< The F14 key. */

  206.     CACA_KEY_F15 = 0x128  /**< The F15 key. */

  207. };

  208. 

  209. /** \defgroup libcaca libcaca basic functions

  210.  *

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

  212.  *  initialisation, system information retrieval and configuration.

  213.  *

  214.  *  @{ */

  215. __extern caca_canvas_t * caca_create_canvas(int, int);

  216. __extern int caca_manage_canvas(caca_canvas_t *, int (*)(void *), void *);

  217. __extern int caca_unmanage_canvas(caca_canvas_t *, int (*)(void *), void *);

  218. __extern int caca_set_canvas_size(caca_canvas_t *, int, int);

  219. __extern int caca_get_canvas_width(caca_canvas_t const *);

  220. __extern int caca_get_canvas_height(caca_canvas_t const *);

  221. __extern uint8_t const * caca_get_canvas_chars(caca_canvas_t const *);

  222. __extern uint8_t const * caca_get_canvas_attrs(caca_canvas_t const *);

  223. __extern int caca_free_canvas(caca_canvas_t *);

  224. __extern int caca_rand(int, int);

  225. __extern char const * caca_get_version(void);

  226. /*  @} */

  227. 

  228. /** \defgroup caca_canvas libcaca canvas drawing

  229.  *

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

  231.  *  higher level graphics functions.

  232.  *

  233.  *  @{ */

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

  235. __extern int caca_gotoxy(caca_canvas_t *, int, int);

  236. __extern int caca_wherex(caca_canvas_t const *);

  237. __extern int caca_wherey(caca_canvas_t const *);

  238. __extern int caca_put_char(caca_canvas_t *, int, int, uint32_t);

  239. __extern uint32_t caca_get_char(caca_canvas_t const *, int, int);

  240. __extern int caca_put_str(caca_canvas_t *, int, int, char const *);

  241. __extern int caca_printf(caca_canvas_t *, int, int, char const *, ...);

  242. __extern int caca_vprintf(caca_canvas_t *, int, int, char const *, va_list);

  243. __extern int caca_clear_canvas(caca_canvas_t *);

  244. __extern int caca_set_canvas_handle(caca_canvas_t *, int, int);

  245. __extern int caca_get_canvas_handle_x(caca_canvas_t const *);

  246. __extern int caca_get_canvas_handle_y(caca_canvas_t const *);

  247. __extern int caca_blit(caca_canvas_t *, int, int, caca_canvas_t const *,

  248.                        caca_canvas_t const *);

  249. __extern int caca_set_canvas_boundaries(caca_canvas_t *, int, int, int, int);

  250. /*  @} */

  251. 

  252. /** \defgroup caca_dirty libcaca dirty rectangle manipulation

  253.  *

  254.  *  These functions manipulate dirty rectangles for optimised blitting.

  255.  *  @{ */

  256. __extern int caca_disable_dirty_rect(caca_canvas_t *);

  257. __extern int caca_enable_dirty_rect(caca_canvas_t *);

  258. __extern int caca_get_dirty_rect_count(caca_canvas_t *);

  259. __extern int caca_get_dirty_rect(caca_canvas_t *, int, int *, int *,

  260.                                  int *, int *);

  261. __extern int caca_add_dirty_rect(caca_canvas_t *, int, int, int, int);

  262. __extern int caca_remove_dirty_rect(caca_canvas_t *, int, int, int, int);

  263. __extern int caca_clear_dirty_rect_list(caca_canvas_t *);

  264. /*  @} */

  265. 

  266. /** \defgroup caca_transform libcaca canvas transformation

  267.  *

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

  269.  *

  270.  *  @{ */

  271. __extern int caca_invert(caca_canvas_t *);

  272. __extern int caca_flip(caca_canvas_t *);

  273. __extern int caca_flop(caca_canvas_t *);

  274. __extern int caca_rotate_180(caca_canvas_t *);

  275. __extern int caca_rotate_left(caca_canvas_t *);

  276. __extern int caca_rotate_right(caca_canvas_t *);

  277. __extern int caca_stretch_left(caca_canvas_t *);

  278. __extern int caca_stretch_right(caca_canvas_t *);

  279. /*  @} */

  280. 

  281. /** \defgroup caca_attributes libcaca attribute conversions

  282.  *

  283.  *  These functions perform conversions between attribute values.

  284.  *

  285.  *  @{ */

  286. __extern uint32_t caca_get_attr(caca_canvas_t const *, int, int);

  287. __extern int caca_set_attr(caca_canvas_t *, uint32_t);

  288. __extern int caca_put_attr(caca_canvas_t *, int, int, uint32_t);

  289. __extern int caca_set_color_ansi(caca_canvas_t *, uint8_t, uint8_t);

  290. __extern int caca_set_color_argb(caca_canvas_t *, uint16_t, uint16_t);

  291. __extern uint8_t caca_attr_to_ansi(uint32_t);

  292. __extern uint8_t caca_attr_to_ansi_fg(uint32_t);

  293. __extern uint8_t caca_attr_to_ansi_bg(uint32_t);

  294. __extern uint16_t caca_attr_to_rgb12_fg(uint32_t);

  295. __extern uint16_t caca_attr_to_rgb12_bg(uint32_t);

  296. __extern void caca_attr_to_argb64(uint32_t, uint8_t[8]);

  297. /*  @} */

  298. 

  299. /** \defgroup caca_charset libcaca character set conversions

  300.  *

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

  302.  *

  303.  *  @{ */

  304. __extern uint32_t caca_utf8_to_utf32(char const *, size_t *);

  305. __extern size_t caca_utf32_to_utf8(char *, uint32_t);

  306. __extern uint8_t caca_utf32_to_cp437(uint32_t);

  307. __extern uint32_t caca_cp437_to_utf32(uint8_t);

  308. __extern char caca_utf32_to_ascii(uint32_t);

  309. __extern int caca_utf32_is_fullwidth(uint32_t);

  310. /*  @} */

  311. 

  312. /** \defgroup caca_primitives libcaca primitives drawing

  313.  *

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

  315.  *  boxes, triangles and ellipses.

  316.  *

  317.  *  @{ */

  318. __extern int caca_draw_line(caca_canvas_t *, int, int, int, int, uint32_t);

  319. __extern int caca_draw_polyline(caca_canvas_t *, int const x[],

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

  321. __extern int caca_draw_thin_line(caca_canvas_t *, int, int, int, int);

  322. __extern int caca_draw_thin_polyline(caca_canvas_t *, int const x[],

  323.                                       int const y[], int);

  324. 

  325. __extern int caca_draw_circle(caca_canvas_t *, int, int, int, uint32_t);

  326. __extern int caca_draw_ellipse(caca_canvas_t *, int, int, int, int, uint32_t);

  327. __extern int caca_draw_thin_ellipse(caca_canvas_t *, int, int, int, int);

  328. __extern int caca_fill_ellipse(caca_canvas_t *, int, int, int, int, uint32_t);

  329. 

  330. __extern int caca_draw_box(caca_canvas_t *, int, int, int, int, uint32_t);

  331. __extern int caca_draw_thin_box(caca_canvas_t *, int, int, int, int);

  332. __extern int caca_draw_cp437_box(caca_canvas_t *, int, int, int, int);

  333. __extern int caca_fill_box(caca_canvas_t *, int, int, int, int, uint32_t);

  334. 

  335. __extern int caca_draw_triangle(caca_canvas_t *, int, int, int, int, int,

  336.                                  int, uint32_t);

  337. __extern int caca_draw_thin_triangle(caca_canvas_t *, int, int, int, int,

  338.                                       int, int);

  339. __extern int caca_fill_triangle(caca_canvas_t *, int, int, int, int, int,

  340.                                  int, uint32_t);

  341. __extern int caca_fill_triangle_textured(caca_canvas_t *cv,

  342.                                          int coords[6],

  343.                                          caca_canvas_t *tex,

  344.                                          float uv[6]);

  345. /*  @} */

  346. 

  347. /** \defgroup caca_frame libcaca canvas frame handling

  348.  *

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

  350.  *  removal, copying etc.

  351.  *

  352.  *  @{ */

  353. __extern int caca_get_frame_count(caca_canvas_t const *);

  354. __extern int caca_set_frame(caca_canvas_t *, int);

  355. __extern char const *caca_get_frame_name(caca_canvas_t const *);

  356. __extern int caca_set_frame_name(caca_canvas_t *, char const *);

  357. __extern int caca_create_frame(caca_canvas_t *, int);

  358. __extern int caca_free_frame(caca_canvas_t *, int);

  359. /*  @} */

  360. 

  361. /** \defgroup caca_dither libcaca bitmap dithering

  362.  *

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

  364.  *  rendering.

  365.  *

  366.  *  @{ */

  367. __extern caca_dither_t *caca_create_dither(int, int, int, int,

  368.                                              uint32_t, uint32_t,

  369.                                              uint32_t, uint32_t);

  370. __extern int caca_set_dither_palette(caca_dither_t *,

  371.                                       uint32_t r[], uint32_t g[],

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

  373. __extern int caca_set_dither_brightness(caca_dither_t *, float);

  374. __extern float caca_get_dither_brightness(caca_dither_t const *);

  375. __extern int caca_set_dither_gamma(caca_dither_t *, float);

  376. __extern float caca_get_dither_gamma(caca_dither_t const *);

  377. __extern int caca_set_dither_contrast(caca_dither_t *, float);

  378. __extern float caca_get_dither_contrast(caca_dither_t const *);

  379. __extern int caca_set_dither_antialias(caca_dither_t *, char const *);

  380. __extern char const * const * caca_get_dither_antialias_list(caca_dither_t

  381.                                                               const *);

  382. __extern char const * caca_get_dither_antialias(caca_dither_t const *);

  383. __extern int caca_set_dither_color(caca_dither_t *, char const *);

  384. __extern char const * const * caca_get_dither_color_list(caca_dither_t

  385.                                                           const *);

  386. __extern char const * caca_get_dither_color(caca_dither_t const *);

  387. __extern int caca_set_dither_charset(caca_dither_t *, char const *);

  388. __extern char const * const * caca_get_dither_charset_list(caca_dither_t

  389.                                                             const *);

  390. __extern char const * caca_get_dither_charset(caca_dither_t const *);

  391. __extern int caca_set_dither_algorithm(caca_dither_t *, char const *);

  392. __extern char const * const * caca_get_dither_algorithm_list(caca_dither_t

  393.                                                               const *);

  394. __extern char const * caca_get_dither_algorithm(caca_dither_t const *);

  395. __extern int caca_dither_bitmap(caca_canvas_t *, int, int, int, int,

  396.                          caca_dither_t const *, void const *);

  397. __extern int caca_free_dither(caca_dither_t *);

  398. /*  @} */

  399. 

  400. /** \defgroup caca_font libcaca font handling

  401.  *

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

  403.  *  canvas to bitmap rendering.

  404.  *

  405.  *  @{ */

  406. __extern caca_font_t *caca_load_font(void const *, size_t);

  407. __extern char const * const * caca_get_font_list(void);

  408. __extern int caca_get_font_width(caca_font_t const *);

  409. __extern int caca_get_font_height(caca_font_t const *);

  410. __extern uint32_t const *caca_get_font_blocks(caca_font_t const *);

  411. __extern int caca_render_canvas(caca_canvas_t const *, caca_font_t const *,

  412.                                  void *, int, int, int);

  413. __extern int caca_free_font(caca_font_t *);

  414. /*  @} */

  415. 

  416. /** \defgroup caca_figfont libcaca FIGfont handling

  417.  *

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

  419.  *

  420.  *  @{ */

  421. __extern int caca_canvas_set_figfont(caca_canvas_t *, char const *);

  422. __extern int caca_put_figchar(caca_canvas_t *, uint32_t);

  423. __extern int caca_flush_figlet(caca_canvas_t *);

  424. /*  @} */

  425. 

  426. /** \defgroup caca_file libcaca file IO

  427.  *

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

  429.  *  way.

  430.  *  @{ */

  431. __extern caca_file_t *caca_file_open(char const *, const char *);

  432. __extern int caca_file_close(caca_file_t *);

  433. __extern uint64_t caca_file_tell(caca_file_t *);

  434. __extern size_t caca_file_read(caca_file_t *, void *, size_t);

  435. __extern size_t caca_file_write(caca_file_t *, const void *, size_t);

  436. __extern char * caca_file_gets(caca_file_t *, char *, int);

  437. __extern int caca_file_eof(caca_file_t *);

  438. /*  @} */

  439. 

  440. /** \defgroup caca_importexport libcaca importers/exporters from/to various

  441.  *  formats

  442.  *

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

  444.  *  the current canvas to various text formats.

  445.  *

  446.  *  @{ */

  447. __extern ssize_t caca_import_canvas_from_memory(caca_canvas_t *, void const *,

  448.                                                 size_t, char const *);

  449. __extern ssize_t caca_import_canvas_from_file(caca_canvas_t *, char const *,

  450.                                               char const *);

  451. __extern ssize_t caca_import_area_from_memory(caca_canvas_t *, int, int,

  452.                                               void const *, size_t,

  453.                                               char const *);

  454. __extern ssize_t caca_import_area_from_file(caca_canvas_t *, int, int,

  455.                                             char const *, char const *);

  456. __extern char const * const * caca_get_import_list(void);

  457. __extern void *caca_export_canvas_to_memory(caca_canvas_t const *,

  458.                                             char const *, size_t *);

  459. __extern void *caca_export_area_to_memory(caca_canvas_t const *, int, int,

  460.                                           int, int, char const *, size_t *);

  461. __extern char const * const * caca_get_export_list(void);

  462. /*  @} */

  463. 

  464. /** \defgroup caca_display libcaca display functions

  465.  *

  466.  *  These functions provide the basic \e libcaca routines for display

  467.  *  initialisation, system information retrieval and configuration.

  468.  *

  469.  *  @{ */

  470. __extern caca_display_t * caca_create_display(caca_canvas_t *);

  471. __extern caca_display_t * caca_create_display_with_driver(caca_canvas_t *,

  472.                                                           char const *);

  473. __extern char const * const * caca_get_display_driver_list(void);

  474. __extern char const * caca_get_display_driver(caca_display_t *);

  475. __extern int caca_set_display_driver(caca_display_t *, char const *);

  476. __extern int caca_free_display(caca_display_t *);

  477. __extern caca_canvas_t * caca_get_canvas(caca_display_t *);

  478. __extern int caca_refresh_display(caca_display_t *);

  479. __extern int caca_set_display_time(caca_display_t *, int);

  480. __extern int caca_get_display_time(caca_display_t const *);

  481. __extern int caca_get_display_width(caca_display_t const *);

  482. __extern int caca_get_display_height(caca_display_t const *);

  483. __extern int caca_set_display_title(caca_display_t *, char const *);

  484. __extern int caca_set_mouse(caca_display_t *, int);

  485. __extern int caca_set_cursor(caca_display_t *, int);

  486. /*  @} */

  487. 

  488. /** \defgroup caca_event libcaca event handling

  489.  *

  490.  *  These functions handle user events such as keyboard input and mouse

  491.  *  clicks.

  492.  *

  493.  *  @{ */

  494. __extern int caca_get_event(caca_display_t *, int, caca_event_t *, int);

  495. __extern int caca_get_mouse_x(caca_display_t const *);

  496. __extern int caca_get_mouse_y(caca_display_t const *);

  497. __extern enum caca_event_type caca_get_event_type(caca_event_t const *);

  498. __extern int caca_get_event_key_ch(caca_event_t const *);

  499. __extern uint32_t caca_get_event_key_utf32(caca_event_t const *);

  500. __extern int caca_get_event_key_utf8(caca_event_t const *, char *);

  501. __extern int caca_get_event_mouse_button(caca_event_t const *);

  502. __extern int caca_get_event_mouse_x(caca_event_t const *);

  503. __extern int caca_get_event_mouse_y(caca_event_t const *);

  504. __extern int caca_get_event_resize_width(caca_event_t const *);

  505. __extern int caca_get_event_resize_height(caca_event_t const *);

  506. /*  @} */

  507. 

  508. /** \brief DOS colours

  509.  *

  510.  *  This enum lists the colour values for the DOS conio.h compatibility

  511.  *  layer.

  512.  */

  513. enum CACA_CONIO_COLORS

  514. {

  515.     CACA_CONIO_BLINK = 128,

  516.     CACA_CONIO_BLACK = 0,

  517.     CACA_CONIO_BLUE = 1,

  518.     CACA_CONIO_GREEN = 2,

  519.     CACA_CONIO_CYAN = 3,

  520.     CACA_CONIO_RED = 4,

  521.     CACA_CONIO_MAGENTA = 5,

  522.     CACA_CONIO_BROWN = 6,

  523.     CACA_CONIO_LIGHTGRAY = 7,

  524.     CACA_CONIO_DARKGRAY = 8,

  525.     CACA_CONIO_LIGHTBLUE = 9,

  526.     CACA_CONIO_LIGHTGREEN = 10,

  527.     CACA_CONIO_LIGHTCYAN = 11,

  528.     CACA_CONIO_LIGHTRED = 12,

  529.     CACA_CONIO_LIGHTMAGENTA = 13,

  530.     CACA_CONIO_YELLOW = 14,

  531.     CACA_CONIO_WHITE = 15,

  532. };

  533. 

  534. /** \brief DOS cursor modes

  535.  *

  536.  *  This enum lists the cursor mode values for the DOS conio.h compatibility

  537.  *  layer.

  538.  */

  539. enum CACA_CONIO_CURSOR

  540. {

  541.     CACA_CONIO__NOCURSOR = 0,

  542.     CACA_CONIO__SOLIDCURSOR = 1,

  543.     CACA_CONIO__NORMALCURSOR = 2,

  544. };

  545. 

  546. /** \brief DOS video modes

  547.  *

  548.  *  This enum lists the video mode values for the DOS conio.h compatibility

  549.  *  layer.

  550.  */

  551. enum CACA_CONIO_MODE

  552. {

  553.     CACA_CONIO_LASTMODE = -1,

  554.     CACA_CONIO_BW40 = 0,

  555.     CACA_CONIO_C40 = 1,

  556.     CACA_CONIO_BW80 = 2,

  557.     CACA_CONIO_C80 = 3,

  558.     CACA_CONIO_MONO = 7,

  559.     CACA_CONIO_C4350 = 64,

  560. };

  561. 

  562. /** \brief DOS text area information

  563.  *

  564.  *  This structure stores text area information for the DOS conio.h

  565.  *  compatibility layer.

  566.  */

  567. struct caca_conio_text_info

  568. {

  569.     unsigned char winleft;        /* left window coordinate */

  570.     unsigned char wintop;         /* top window coordinate */

  571.     unsigned char winright;       /* right window coordinate */

  572.     unsigned char winbottom;      /* bottom window coordinate */

  573.     unsigned char attribute;      /* text attribute */

  574.     unsigned char normattr;       /* normal attribute */

  575.     unsigned char currmode;       /* current video mode:

  576.                                      BW40, BW80, C40, C80, or C4350 */

  577.     unsigned char screenheight;   /* text screen's height */

  578.     unsigned char screenwidth;    /* text screen's width */

  579.     unsigned char curx;           /* x-coordinate in current window */

  580.     unsigned char cury;           /* y-coordinate in current window */

  581. };

  582. 

  583. /** \brief DOS direct video control */

  584. __extern int caca_conio_directvideo;

  585. 

  586. /** \brief DOS scrolling control */

  587. __extern int caca_conio__wscroll;

  588. 

  589. /** \defgroup conio libcaca DOS conio.h compatibility layer

  590.  *

  591.  *  These functions implement DOS-like functions for high-level text

  592.  *  operations.

  593.  *

  594.  *  @{ */

  595. __extern char * caca_conio_cgets(char *str);

  596. __extern void   caca_conio_clreol(void);

  597. __extern void   caca_conio_clrscr(void);

  598. __extern int    caca_conio_cprintf(const char *format, ...);

  599. __extern int    caca_conio_cputs(const char *str);

  600. __extern int    caca_conio_cscanf(char *format, ...);

  601. __extern void   caca_conio_delay(unsigned int);

  602. __extern void   caca_conio_delline(void);

  603. __extern int    caca_conio_getch(void);

  604. __extern int    caca_conio_getche(void);

  605. __extern char * caca_conio_getpass(const char *prompt);

  606. __extern int    caca_conio_gettext(int left, int top, int right, int bottom,

  607.                                    void *destin);

  608. __extern void   caca_conio_gettextinfo(struct caca_conio_text_info *r);

  609. __extern void   caca_conio_gotoxy(int x, int y);

  610. __extern void   caca_conio_highvideo(void);

  611. __extern void   caca_conio_insline(void);

  612. __extern int    caca_conio_kbhit(void);

  613. __extern void   caca_conio_lowvideo(void);

  614. __extern int    caca_conio_movetext(int left, int top, int right, int bottom,

  615.                                     int destleft, int desttop);

  616. __extern void   caca_conio_normvideo(void);

  617. __extern void   caca_conio_nosound(void);

  618. __extern int    caca_conio_printf(const char *format, ...);

  619. __extern int    caca_conio_putch(int ch);

  620. __extern int    caca_conio_puttext(int left, int top, int right, int bottom,

  621.                                    void *destin);

  622. __extern void   caca_conio__setcursortype(int cur_t);

  623. __extern void   caca_conio_sleep(unsigned int);

  624. __extern void   caca_conio_sound(unsigned int);

  625. __extern void   caca_conio_textattr(int newattr);

  626. __extern void   caca_conio_textbackground(int newcolor);

  627. __extern void   caca_conio_textcolor(int newcolor);

  628. __extern void   caca_conio_textmode(int newmode);

  629. __extern int    caca_conio_ungetch(int ch);

  630. __extern int    caca_conio_wherex(void);

  631. __extern int    caca_conio_wherey(void);

  632. __extern void   caca_conio_window(int left, int top, int right, int bottom);

  633. /*  @} */

  634. 

  635. #if !defined(_DOXYGEN_SKIP_ME)

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

  637. typedef struct cucul_buffer cucul_buffer_t;

  638. 

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

  640. #       define CACA_DEPRECATED __attribute__ ((__deprecated__))

  641. #       define CACA_ALIAS(x) __attribute__ ((weak, alias(#x)))

  642. #   else

  643. #       define CACA_DEPRECATED

  644. #       define CACA_ALIAS(x)

  645. #   endif

  646. 

  647. 

  648. /* Aliases from old libcaca and libcucul functions */

  649. __extern int cucul_putchar(caca_canvas_t *, int, int,

  650.                            unsigned long int) CACA_DEPRECATED;

  651. __extern unsigned long int cucul_getchar(caca_canvas_t *,

  652.                                          int, int) CACA_DEPRECATED;

  653. __extern int cucul_putstr(caca_canvas_t *, int, int,

  654.                           char const *) CACA_DEPRECATED;

  655. __extern int cucul_set_color(caca_canvas_t *, unsigned char,

  656.                              unsigned char) CACA_DEPRECATED;

  657. __extern int cucul_set_truecolor(caca_canvas_t *, unsigned int,

  658.                                  unsigned int) CACA_DEPRECATED;

  659. __extern unsigned int cucul_get_canvas_frame_count(caca_canvas_t *)

  660.                                                    CACA_DEPRECATED;

  661. __extern int cucul_set_canvas_frame(caca_canvas_t *,

  662.                                     unsigned int) CACA_DEPRECATED;

  663. __extern int cucul_create_canvas_frame(caca_canvas_t *,

  664.                                        unsigned int) CACA_DEPRECATED;

  665. __extern int cucul_free_canvas_frame(caca_canvas_t *,

  666.                                      unsigned int) CACA_DEPRECATED;

  667. __extern cucul_buffer_t *cucul_load_memory(void *,

  668.                                            unsigned long int) CACA_DEPRECATED;

  669. __extern cucul_buffer_t *cucul_load_file(char const *) CACA_DEPRECATED;

  670. __extern unsigned long int cucul_get_buffer_size(cucul_buffer_t *)

  671.                                                  CACA_DEPRECATED;

  672. __extern void * cucul_get_buffer_data(cucul_buffer_t *) CACA_DEPRECATED;

  673. __extern int cucul_free_buffer(cucul_buffer_t *) CACA_DEPRECATED;

  674. __extern cucul_buffer_t * cucul_export_canvas(caca_canvas_t *,

  675.                                               char const *) CACA_DEPRECATED;

  676. __extern caca_canvas_t * cucul_import_canvas(cucul_buffer_t *,

  677.                                               char const *) CACA_DEPRECATED;

  678. __extern ssize_t caca_import_memory(caca_canvas_t *, void const *, size_t,

  679.                                     char const *) CACA_DEPRECATED;

  680. __extern ssize_t caca_import_file(caca_canvas_t *, char const *,

  681.                                   char const *) CACA_DEPRECATED;

  682. __extern void *caca_export_memory(caca_canvas_t const *, char const *,

  683.                                   size_t *) CACA_DEPRECATED;

  684. __extern int cucul_rotate(caca_canvas_t *) CACA_DEPRECATED;

  685. __extern int cucul_set_dither_invert(caca_dither_t *, int) CACA_DEPRECATED;

  686. __extern int cucul_set_dither_mode(caca_dither_t *,

  687.                                    char const *) CACA_DEPRECATED;

  688. __extern char const * const * cucul_get_dither_mode_list(caca_dither_t const *)

  689.                                                          CACA_DEPRECATED;

  690. #   define CUCUL_COLOR_BLACK CACA_BLACK

  691. #   define CUCUL_COLOR_BLUE CACA_BLUE

  692. #   define CUCUL_COLOR_GREEN CACA_GREEN

  693. #   define CUCUL_COLOR_CYAN CACA_CYAN

  694. #   define CUCUL_COLOR_RED CACA_RED

  695. #   define CUCUL_COLOR_MAGENTA CACA_MAGENTA

  696. #   define CUCUL_COLOR_BROWN CACA_BROWN

  697. #   define CUCUL_COLOR_LIGHTGRAY CACA_LIGHTGRAY

  698. #   define CUCUL_COLOR_DARKGRAY CACA_DARKGRAY

  699. #   define CUCUL_COLOR_LIGHTBLUE CACA_LIGHTBLUE

  700. #   define CUCUL_COLOR_LIGHTGREEN CACA_LIGHTGREEN

  701. #   define CUCUL_COLOR_LIGHTCYAN CACA_LIGHTCYAN

  702. #   define CUCUL_COLOR_LIGHTRED CACA_LIGHTRED

  703. #   define CUCUL_COLOR_LIGHTMAGENTA CACA_LIGHTMAGENTA

  704. #   define CUCUL_COLOR_YELLOW CACA_YELLOW

  705. #   define CUCUL_COLOR_WHITE CACA_YELLOW

  706. #   define CUCUL_COLOR_DEFAULT CACA_DEFAULT

  707. #   define CUCUL_COLOR_TRANSPARENT CACA_TRANSPARENT

  708. 

  709. /* Aliases from the libcucul/libcaca merge */

  710. #   define cucul_canvas_t caca_canvas_t

  711. #   define cucul_dither_t caca_dither_t

  712. #   define cucul_font_t caca_font_t

  713. #   define cucul_file_t caca_file_t

  714. #   define cucul_display_t caca_display_t

  715. #   define cucul_event_t caca_event_t

  716. 

  717. #   define CUCUL_BLACK CACA_BLACK

  718. #   define CUCUL_BLUE CACA_BLUE

  719. #   define CUCUL_GREEN CACA_GREEN

  720. #   define CUCUL_CYAN CACA_CYAN

  721. #   define CUCUL_RED CACA_RED

  722. #   define CUCUL_MAGENTA CACA_MAGENTA

  723. #   define CUCUL_BROWN CACA_BROWN

  724. #   define CUCUL_LIGHTGRAY CACA_LIGHTGRAY

  725. #   define CUCUL_DARKGRAY CACA_DARKGRAY

  726. #   define CUCUL_LIGHTBLUE CACA_LIGHTBLUE

  727. #   define CUCUL_LIGHTGREEN CACA_LIGHTGREEN

  728. #   define CUCUL_LIGHTCYAN CACA_LIGHTCYAN

  729. #   define CUCUL_LIGHTRED CACA_LIGHTRED

  730. #   define CUCUL_LIGHTMAGENTA CACA_LIGHTMAGENTA

  731. #   define CUCUL_YELLOW CACA_YELLOW

  732. #   define CUCUL_WHITE CACA_YELLOW

  733. #   define CUCUL_DEFAULT CACA_DEFAULT

  734. #   define CUCUL_TRANSPARENT CACA_TRANSPARENT

  735. 

  736. #   define CUCUL_BOLD CACA_BOLD

  737. #   define CUCUL_ITALICS CACA_ITALICS

  738. #   define CUCUL_UNDERLINE CACA_UNDERLINE

  739. #   define CUCUL_BLINK CACA_BLINK

  740. 

  741. #   if !defined __LIBCACA__

  742. #       define caca_get_cursor_x caca_wherex

  743. #       define caca_get_cursor_y caca_wherey

  744. #       define cucul_draw_triangle caca_draw_triangle

  745. #       define cucul_draw_thin_triangle caca_draw_thin_triangle

  746. #       define cucul_fill_triangle caca_fill_triangle

  747. #       define cucul_load_font caca_load_font

  748. #       define cucul_get_font_list caca_get_font_list

  749. #       define cucul_get_font_width caca_get_font_width

  750. #       define cucul_get_font_height caca_get_font_height

  751. #       define cucul_get_font_blocks caca_get_font_blocks

  752. #       define cucul_render_canvas caca_render_canvas

  753. #       define cucul_free_font caca_free_font

  754. #       define cucul_gotoxy caca_gotoxy

  755. #       define cucul_get_cursor_x caca_wherex

  756. #       define cucul_get_cursor_y caca_wherey

  757. #       define cucul_put_char caca_put_char

  758. #       define cucul_get_char caca_get_char

  759. #       define cucul_put_str caca_put_str

  760. #       define cucul_printf caca_printf

  761. #       define cucul_clear_canvas caca_clear_canvas

  762. #       define cucul_set_canvas_handle caca_set_canvas_handle

  763. #       define cucul_get_canvas_handle_x caca_get_canvas_handle_x

  764. #       define cucul_get_canvas_handle_y caca_get_canvas_handle_y

  765. #       define cucul_blit caca_blit

  766. #       define cucul_set_canvas_boundaries caca_set_canvas_boundaries

  767. #       define cucul_import_memory caca_import_memory

  768. #       define cucul_import_file caca_import_file

  769. #       define cucul_get_import_list caca_get_import_list

  770. #       define cucul_create_canvas caca_create_canvas

  771. #       define cucul_manage_canvas caca_manage_canvas

  772. #       define cucul_unmanage_canvas caca_unmanage_canvas

  773. #       define cucul_set_canvas_size caca_set_canvas_size

  774. #       define cucul_get_canvas_width caca_get_canvas_width

  775. #       define cucul_get_canvas_height caca_get_canvas_height

  776. #       define cucul_get_canvas_chars caca_get_canvas_chars

  777. #       define cucul_get_canvas_attrs caca_get_canvas_attrs

  778. #       define cucul_free_canvas caca_free_canvas

  779. #       define cucul_rand caca_rand

  780. #       define cucul_export_memory caca_export_memory

  781. #       define cucul_get_export_list caca_get_export_list

  782. #       define cucul_get_version caca_get_version

  783. #       define cucul_utf8_to_utf32 caca_utf8_to_utf32

  784. #       define cucul_utf32_to_utf8 caca_utf32_to_utf8

  785. #       define cucul_utf32_to_cp437 caca_utf32_to_cp437

  786. #       define cucul_cp437_to_utf32 caca_cp437_to_utf32

  787. #       define cucul_utf32_to_ascii caca_utf32_to_ascii

  788. #       define cucul_utf32_is_fullwidth caca_utf32_is_fullwidth

  789. #       define cucul_draw_circle caca_draw_circle

  790. #       define cucul_draw_ellipse caca_draw_ellipse

  791. #       define cucul_draw_thin_ellipse caca_draw_thin_ellipse

  792. #       define cucul_fill_ellipse caca_fill_ellipse

  793. #       define cucul_canvas_set_figfont caca_canvas_set_figfont

  794. #       define cucul_put_figchar caca_put_figchar

  795. #       define cucul_flush_figlet caca_flush_figlet

  796. #       define cucul_putchar caca_putchar

  797. #       define cucul_getchar caca_getchar

  798. #       define cucul_get_attr caca_get_attr

  799. #       define cucul_set_attr caca_set_attr

  800. #       define cucul_put_attr caca_put_attr

  801. #       define cucul_set_color_ansi caca_set_color_ansi

  802. #       define cucul_set_color_argb caca_set_color_argb

  803. #       define cucul_attr_to_ansi caca_attr_to_ansi

  804. #       define cucul_attr_to_ansi_fg caca_attr_to_ansi_fg

  805. #       define cucul_attr_to_ansi_bg caca_attr_to_ansi_bg

  806. #       define cucul_attr_to_rgb12_fg caca_attr_to_rgb12_fg

  807. #       define cucul_attr_to_rgb12_bg caca_attr_to_rgb12_bg

  808. #       define cucul_attr_to_argb64 caca_attr_to_argb64

  809. #       define cucul_invert caca_invert

  810. #       define cucul_flip caca_flip

  811. #       define cucul_flop caca_flop

  812. #       define cucul_rotate_180 caca_rotate_180

  813. #       define cucul_rotate_left caca_rotate_left

  814. #       define cucul_rotate_right caca_rotate_right

  815. #       define cucul_stretch_left caca_stretch_left

  816. #       define cucul_stretch_right caca_stretch_right

  817. #       define cucul_file_open caca_file_open

  818. #       define cucul_file_close caca_file_close

  819. #       define cucul_file_tell caca_file_tell

  820. #       define cucul_file_read caca_file_read

  821. #       define cucul_file_write caca_file_write

  822. #       define cucul_file_gets caca_file_gets

  823. #       define cucul_file_eof caca_file_eof

  824. #       define cucul_create_dither caca_create_dither

  825. #       define cucul_set_dither_palette caca_set_dither_palette

  826. #       define cucul_set_dither_brightness caca_set_dither_brightness

  827. #       define cucul_get_dither_brightness caca_get_dither_brightness

  828. #       define cucul_set_dither_gamma caca_set_dither_gamma

  829. #       define cucul_get_dither_gamma caca_get_dither_gamma

  830. #       define cucul_set_dither_contrast caca_set_dither_contrast

  831. #       define cucul_get_dither_contrast caca_get_dither_contrast

  832. #       define cucul_set_dither_antialias caca_set_dither_antialias

  833. #       define cucul_get_dither_antialias_list caca_get_dither_antialias_list

  834. #       define cucul_get_dither_antialias caca_get_dither_antialias

  835. #       define cucul_set_dither_color caca_set_dither_color

  836. #       define cucul_get_dither_color_list caca_get_dither_color_list

  837. #       define cucul_get_dither_color caca_get_dither_color

  838. #       define cucul_set_dither_charset caca_set_dither_charset

  839. #       define cucul_get_dither_charset_list caca_get_dither_charset_list

  840. #       define cucul_get_dither_charset caca_get_dither_charset

  841. #       define cucul_set_dither_algorithm caca_set_dither_algorithm

  842. #       define cucul_get_dither_algorithm_list caca_get_dither_algorithm_list

  843. #       define cucul_get_dither_algorithm caca_get_dither_algorithm

  844. #       define cucul_dither_bitmap caca_dither_bitmap

  845. #       define cucul_free_dither caca_free_dither

  846. #       define cucul_draw_line caca_draw_line

  847. #       define cucul_draw_polyline caca_draw_polyline

  848. #       define cucul_draw_thin_line caca_draw_thin_line

  849. #       define cucul_draw_thin_polyline caca_draw_thin_polyline

  850. #       define cucul_draw_box caca_draw_box

  851. #       define cucul_draw_thin_box caca_draw_thin_box

  852. #       define cucul_draw_cp437_box caca_draw_cp437_box

  853. #       define cucul_fill_box caca_fill_box

  854. #       define cucul_get_frame_count caca_get_frame_count

  855. #       define cucul_set_frame caca_set_frame

  856. #       define cucul_get_frame_name caca_get_frame_name

  857. #       define cucul_set_frame_name caca_set_frame_name

  858. #       define cucul_create_frame caca_create_frame

  859. #       define cucul_free_frame caca_free_frame

  860. #   endif

  861. #endif

  862. 

  863. #ifdef __cplusplus

  864. }

  865. #endif

  866. 

  867. #undef __extern

  868. 

  869. #endif /* __CACA_H__ */