Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.
 
 
 
 
 
 

252 строки
9.4 KiB

  1. /*
  2. * libcaca Colour ASCII-Art library
  3. * Copyright (c) 2002-2006 Sam Hocevar <sam@zoy.org>
  4. * All Rights Reserved
  5. *
  6. * This library is free software; you can redistribute it and/or
  7. * modify it under the terms of the Do What The Fuck You Want To
  8. * Public License, Version 2, as published by Sam Hocevar. See
  9. * http://sam.zoy.org/wtfpl/COPYING for more details.
  10. */
  11. /** \file caca.h
  12. * \version \$Id$
  13. * \author Sam Hocevar <sam@zoy.org>
  14. * \brief The \e libcaca public header.
  15. *
  16. * This header contains the public types and functions that applications
  17. * using \e libcaca may use.
  18. */
  19. /** \mainpage libcaca developer documentation
  20. *
  21. * \section intro Introduction
  22. *
  23. * \e libcaca is a graphics library that outputs text instead of pixels,
  24. * so that it can work on older video cards or text terminals. It is not
  25. * unlike the famous AAlib library. \e libcaca can use almost any virtual
  26. * terminal to work, thus it should work on all Unix systems (including
  27. * Mac OS X) using either the slang library or the ncurses library, on DOS
  28. * using the conio library, and on Windows systems using either slang or
  29. * ncurses (through Cygwin emulation) or conio. There is also a native X11
  30. * driver, and an OpenGL driver (through freeglut) that does not require a
  31. * text terminal. For machines without a screen, and with a valid tcp stack,
  32. * the network driver (BSD sockets) should perfectly fit your needs.
  33. *
  34. * \e libcaca is free software, released under the Do What The Fuck You
  35. * Want To Public License. This ensures that no one, not even the \e libcaca
  36. * developers, will ever have anything to say about what you do with the
  37. * software. It used to be licensed under the GNU Lesser General Public
  38. * License, but that was not free enough.
  39. *
  40. * \section api The libcaca API
  41. *
  42. * \e libcaca relies on a low-level, device independent library, called
  43. * \e libcucul. \e libcucul can be used alone as a simple ASCII and/or
  44. * Unicode compositing canvas.
  45. *
  46. * The complete \e libcucul and \e libcaca programming interface is
  47. * available from the cucul.h and caca.h headers.
  48. *
  49. * \section env Environment variables
  50. *
  51. * Some environment variables can be used to change the behaviour of
  52. * \e libcaca or \e libcucul without having to modify the program which
  53. * uses them. These variables are:
  54. *
  55. * \li \b CACA_DRIVER: set the backend video driver. In order of preference:
  56. * - \c conio uses the DOS conio.h interface.
  57. * - \c ncurses uses the ncurses library.
  58. * - \c slang uses the S-Lang library.
  59. * - \c x11 uses the native X11 driver.
  60. * - \c gl uses freeglut and opengl libraries.
  61. * - \c network uses BSD sockets calls.
  62. *
  63. * \li \b CUCUL_BACKGROUND: set the background type.
  64. * - \c solid uses solid coloured backgrounds for all characters. This
  65. * feature does not work with all terminal emulators. This is the
  66. * default choice.
  67. * - \c black uses only black backgrounds to render characters.
  68. *
  69. * \li \b CUCUL_ANTIALIASING: set the antialiasing mode. Antialiasing
  70. * smoothens the rendered image and avoids the commonly seen staircase
  71. * effect.
  72. * - \c none disables antialiasing.
  73. * - \c prefilter uses a simple prefilter antialiasing method. This is
  74. * the default choice.
  75. *
  76. * \li \b CUCUL_DITHERING: set the dithering mode. Dithering is necessary
  77. * when rendering a picture that has more colours than the usually
  78. * available palette.
  79. * - \c none disables dithering.
  80. * - \c ordered2 uses a 2x2 Bayer matrix for dithering.
  81. * - \c ordered4 uses a 4x4 Bayer matrix for dithering. This is the
  82. * default choice.
  83. * - \c ordered8 uses a 8x8 Bayer matrix for dithering.
  84. * - \c random uses random dithering.
  85. *
  86. * \li \b CACA_GEOMETRY: set the video display size. The format of this
  87. * variable must be XxY, with X and Y being integer values. This option
  88. * currently works with the network, X11 and GL drivers.
  89. *
  90. * \li \b CACA_FONT: set the rendered font. The format of this variable is
  91. * implementation dependent, but since it currently only works with the
  92. * X11 driver, an X11 font name such as "fixed" or "5x7" is expected.
  93. */
  94. #ifndef __CACA_H__
  95. #define __CACA_H__
  96. #define CACA_API_VERSION_1
  97. #include <cucul.h>
  98. #ifdef __cplusplus
  99. extern "C"
  100. {
  101. #endif
  102. /** \brief User event types.
  103. *
  104. * Event types returned by caca_get_event().
  105. */
  106. enum caca_event_type
  107. {
  108. CACA_EVENT_NONE = 0x0000, /**< No event. */
  109. CACA_EVENT_KEY_PRESS = 0x0001, /**< A key was pressed. */
  110. CACA_EVENT_KEY_RELEASE = 0x0002, /**< A key was released. */
  111. CACA_EVENT_MOUSE_PRESS = 0x0004, /**< A mouse button was pressed. */
  112. CACA_EVENT_MOUSE_RELEASE = 0x0008, /**< A mouse button was released. */
  113. CACA_EVENT_MOUSE_MOTION = 0x0010, /**< The mouse was moved. */
  114. CACA_EVENT_RESIZE = 0x0020, /**< The window was resized. */
  115. CACA_EVENT_ANY = 0xffff /**< Bitmask for any event. */
  116. };
  117. /** \brief User events.
  118. *
  119. * This structure is filled by caca_get_event() when an event is received.
  120. * The \e type field is always valid. The validity of the \e data union
  121. * depends on the value of the \e type field:
  122. *
  123. * \li \b CACA_EVENT_NONE: no other field is valid.
  124. *
  125. * \li \b CACA_EVENT_KEY_PRESS, \b CACA_EVENT_KEY_RELEASE: the \e data.key.c
  126. * field is valid and contains either the ASCII value for the key, or
  127. * an \e enum \e caca_key value. If the value is a printable ASCII
  128. * character, the \e data.key.ucs4 and \e data.key.utf8 fields are
  129. * also filled and contain respectively the UCS-4/UTF-32 and the UTF-8
  130. * representations of the character. Otherwise, their content is
  131. * undefined.
  132. *
  133. * \li \b CACA_EVENT_MOUSE_PRESS, \b CACA_EVENT_MOUSE_RELEASE: the
  134. * \e data.mouse.button field is valid and contains the index of the
  135. * mouse button that was pressed.
  136. *
  137. * \li \b CACA_EVENT_MOUSE_MOTION: the \e data.mouse.x and \e data.mouse.y
  138. * fields are valid and contain the mouse coordinates in character
  139. * cells.
  140. *
  141. * \li \b CACA_EVENT_RESIZE: the \e data.resize.w and \e data.resize.h
  142. * fields are valid and contain the new width and height values of
  143. * the \e libcucul canvas attached to \e libcaca.
  144. *
  145. * The result of accessing data members outside the above conditions is
  146. * undefined.
  147. */
  148. struct caca_event
  149. {
  150. enum caca_event_type type;
  151. union
  152. {
  153. struct { unsigned int x, y, button; } mouse;
  154. struct { unsigned int w, h; } resize;
  155. struct { unsigned int c; unsigned long int ucs4; char utf8[8]; } key;
  156. } data;
  157. };
  158. /** \brief Special key values.
  159. *
  160. * Special key values returned by caca_get_event() for which there is no
  161. * ASCII equivalent.
  162. */
  163. enum caca_key
  164. {
  165. CACA_KEY_UNKNOWN = 0x00, /**< Unknown key. */
  166. /* The following keys have ASCII equivalents */
  167. CACA_KEY_BACKSPACE = 0x08, /**< The backspace key. */
  168. CACA_KEY_TAB = 0x09, /**< The tabulation key. */
  169. CACA_KEY_RETURN = 0x0d, /**< The return key. */
  170. CACA_KEY_PAUSE = 0x13, /**< The pause key. */
  171. CACA_KEY_ESCAPE = 0x1b, /**< The escape key. */
  172. CACA_KEY_DELETE = 0x7f, /**< The delete key. */
  173. /* The following keys do not have ASCII equivalents but have been
  174. * chosen to match the SDL equivalents */
  175. CACA_KEY_UP = 0x111, /**< The up arrow key. */
  176. CACA_KEY_DOWN = 0x112, /**< The down arrow key. */
  177. CACA_KEY_LEFT = 0x113, /**< The left arrow key. */
  178. CACA_KEY_RIGHT = 0x114, /**< The right arrow key. */
  179. CACA_KEY_INSERT = 0x115, /**< The insert key. */
  180. CACA_KEY_HOME = 0x116, /**< The home key. */
  181. CACA_KEY_END = 0x117, /**< The end key. */
  182. CACA_KEY_PAGEUP = 0x118, /**< The page up key. */
  183. CACA_KEY_PAGEDOWN = 0x119, /**< The page down key. */
  184. CACA_KEY_F1 = 0x11a, /**< The F1 key. */
  185. CACA_KEY_F2 = 0x11b, /**< The F2 key. */
  186. CACA_KEY_F3 = 0x11c, /**< The F3 key. */
  187. CACA_KEY_F4 = 0x11d, /**< The F4 key. */
  188. CACA_KEY_F5 = 0x11e, /**< The F5 key. */
  189. CACA_KEY_F6 = 0x11f, /**< The F6 key. */
  190. CACA_KEY_F7 = 0x120, /**< The F7 key. */
  191. CACA_KEY_F8 = 0x121, /**< The F8 key. */
  192. CACA_KEY_F9 = 0x122, /**< The F9 key. */
  193. CACA_KEY_F10 = 0x123, /**< The F10 key. */
  194. CACA_KEY_F11 = 0x124, /**< The F11 key. */
  195. CACA_KEY_F12 = 0x125, /**< The F12 key. */
  196. CACA_KEY_F13 = 0x126, /**< The F13 key. */
  197. CACA_KEY_F14 = 0x127, /**< The F14 key. */
  198. CACA_KEY_F15 = 0x128 /**< The F15 key. */
  199. };
  200. typedef struct caca_context caca_t;
  201. /** \defgroup basic Basic functions
  202. *
  203. * These functions provide the basic \e libcaca routines for driver
  204. * initialisation, system information retrieval and configuration.
  205. *
  206. * @{ */
  207. caca_t * caca_attach(cucul_t *qq);
  208. void caca_detach(caca_t *kk);
  209. void caca_set_delay(caca_t *kk, unsigned int);
  210. void caca_display(caca_t *kk);
  211. unsigned int caca_get_rendertime(caca_t *kk);
  212. unsigned int caca_get_window_width(caca_t *kk);
  213. unsigned int caca_get_window_height(caca_t *kk);
  214. int caca_set_window_title(caca_t *kk, char const *);
  215. /* @} */
  216. /** \defgroup event Event handling
  217. *
  218. * These functions handle user events such as keyboard input and mouse
  219. * clicks.
  220. *
  221. * @{ */
  222. int caca_get_event(caca_t *kk, unsigned int, struct caca_event *);
  223. int caca_wait_event(caca_t *kk, unsigned int, struct caca_event *);
  224. unsigned int caca_get_mouse_x(caca_t *kk);
  225. unsigned int caca_get_mouse_y(caca_t *kk);
  226. void caca_set_mouse(caca_t *kk, int);
  227. /* @} */
  228. #ifdef __cplusplus
  229. }
  230. #endif
  231. #endif /* __CACA_H__ */