25'ten fazla konu seçemezsiniz Konular bir harf veya rakamla başlamalı, kısa çizgiler ('-') içerebilir ve en fazla 35 karakter uzunluğunda olabilir.
 
 
 
 
 
 

179 satır
6.1 KiB

  1. /*
  2. * libcaca Colour ASCII-Art library
  3. * Copyright (c) 2002-2006 Sam Hocevar <sam@zoy.org>
  4. * All Rights Reserved
  5. *
  6. * $Id$
  7. *
  8. * This library is free software; you can redistribute it and/or
  9. * modify it under the terms of the Do What The Fuck You Want To
  10. * Public License, Version 2, as published by Sam Hocevar. See
  11. * http://sam.zoy.org/wtfpl/COPYING for more details.
  12. */
  13. /** \file caca.h
  14. * \version \$Id$
  15. * \author Sam Hocevar <sam@zoy.org>
  16. * \brief The \e libcaca public header.
  17. *
  18. * This header contains the public types and functions that applications
  19. * using \e libcaca may use.
  20. */
  21. #ifndef __CACA_H__
  22. #define __CACA_H__
  23. /** libcaca API version */
  24. #define CACA_API_VERSION_1
  25. #include <cucul.h>
  26. #ifdef __cplusplus
  27. extern "C"
  28. {
  29. #endif
  30. /** \e libcaca context */
  31. typedef struct caca_display caca_display_t;
  32. /** event structure */
  33. typedef struct caca_event caca_event_t;
  34. /** \brief User events.
  35. *
  36. * This structure is filled by caca_get_event() when an event is received.
  37. * The \e type field is always valid. The validity of the \e data union
  38. * depends on the value of the \e type field:
  39. *
  40. * \li \b CACA_EVENT_NONE: no other field is valid.
  41. *
  42. * \li \b CACA_EVENT_KEY_PRESS, \b CACA_EVENT_KEY_RELEASE: the \e data.key.ch
  43. * field is valid and contains either the ASCII value for the key, or
  44. * an \e enum \e caca_key value. If the value is a printable ASCII
  45. * character, the \e data.key.ucs4 and \e data.key.utf8 fields are
  46. * also filled and contain respectively the UCS-4/UTF-32 and the UTF-8
  47. * representations of the character. Otherwise, their content is
  48. * undefined.
  49. *
  50. * \li \b CACA_EVENT_MOUSE_PRESS, \b CACA_EVENT_MOUSE_RELEASE: the
  51. * \e data.mouse.button field is valid and contains the index of the
  52. * mouse button that was pressed.
  53. *
  54. * \li \b CACA_EVENT_MOUSE_MOTION: the \e data.mouse.x and \e data.mouse.y
  55. * fields are valid and contain the mouse coordinates in character
  56. * cells.
  57. *
  58. * \li \b CACA_EVENT_RESIZE: the \e data.resize.w and \e data.resize.h
  59. * fields are valid and contain the new width and height values of
  60. * the \e libcucul canvas attached to \e libcaca.
  61. *
  62. * \li \b CACA_EVENT_QUIT: no other field is valid.
  63. *
  64. * The result of accessing data members outside the above conditions is
  65. * undefined.
  66. */
  67. struct caca_event
  68. {
  69. enum caca_event_type
  70. {
  71. CACA_EVENT_NONE = 0x0000, /**< No event. */
  72. CACA_EVENT_KEY_PRESS = 0x0001, /**< A key was pressed. */
  73. CACA_EVENT_KEY_RELEASE = 0x0002, /**< A key was released. */
  74. CACA_EVENT_MOUSE_PRESS = 0x0004, /**< A mouse button was pressed. */
  75. CACA_EVENT_MOUSE_RELEASE = 0x0008, /**< A mouse button was released. */
  76. CACA_EVENT_MOUSE_MOTION = 0x0010, /**< The mouse was moved. */
  77. CACA_EVENT_RESIZE = 0x0020, /**< The window was resized. */
  78. CACA_EVENT_QUIT = 0x0040, /**< The user requested to quit. */
  79. CACA_EVENT_ANY = 0xffff /**< Bitmask for any event. */
  80. } type;
  81. union
  82. {
  83. struct { unsigned int x, y, button; } mouse;
  84. struct { unsigned int w, h; } resize;
  85. struct { unsigned int ch; unsigned long int ucs4; char utf8[8]; } key;
  86. } data;
  87. };
  88. /** \brief Special key values.
  89. *
  90. * Special key values returned by caca_get_event() for which there is no
  91. * printable ASCII equivalent.
  92. */
  93. enum caca_key
  94. {
  95. CACA_KEY_UNKNOWN = 0x00, /**< Unknown key. */
  96. /* The following keys have ASCII equivalents */
  97. CACA_KEY_BACKSPACE = 0x08, /**< The backspace key. */
  98. CACA_KEY_TAB = 0x09, /**< The tabulation key. */
  99. CACA_KEY_RETURN = 0x0d, /**< The return key. */
  100. CACA_KEY_PAUSE = 0x13, /**< The pause key. */
  101. CACA_KEY_ESCAPE = 0x1b, /**< The escape key. */
  102. CACA_KEY_DELETE = 0x7f, /**< The delete key. */
  103. /* The following keys do not have ASCII equivalents but have been
  104. * chosen to match the SDL equivalents */
  105. CACA_KEY_UP = 0x111, /**< The up arrow key. */
  106. CACA_KEY_DOWN = 0x112, /**< The down arrow key. */
  107. CACA_KEY_LEFT = 0x113, /**< The left arrow key. */
  108. CACA_KEY_RIGHT = 0x114, /**< The right arrow key. */
  109. CACA_KEY_INSERT = 0x115, /**< The insert key. */
  110. CACA_KEY_HOME = 0x116, /**< The home key. */
  111. CACA_KEY_END = 0x117, /**< The end key. */
  112. CACA_KEY_PAGEUP = 0x118, /**< The page up key. */
  113. CACA_KEY_PAGEDOWN = 0x119, /**< The page down key. */
  114. CACA_KEY_F1 = 0x11a, /**< The F1 key. */
  115. CACA_KEY_F2 = 0x11b, /**< The F2 key. */
  116. CACA_KEY_F3 = 0x11c, /**< The F3 key. */
  117. CACA_KEY_F4 = 0x11d, /**< The F4 key. */
  118. CACA_KEY_F5 = 0x11e, /**< The F5 key. */
  119. CACA_KEY_F6 = 0x11f, /**< The F6 key. */
  120. CACA_KEY_F7 = 0x120, /**< The F7 key. */
  121. CACA_KEY_F8 = 0x121, /**< The F8 key. */
  122. CACA_KEY_F9 = 0x122, /**< The F9 key. */
  123. CACA_KEY_F10 = 0x123, /**< The F10 key. */
  124. CACA_KEY_F11 = 0x124, /**< The F11 key. */
  125. CACA_KEY_F12 = 0x125, /**< The F12 key. */
  126. CACA_KEY_F13 = 0x126, /**< The F13 key. */
  127. CACA_KEY_F14 = 0x127, /**< The F14 key. */
  128. CACA_KEY_F15 = 0x128 /**< The F15 key. */
  129. };
  130. /** \defgroup caca libcaca basic functions
  131. *
  132. * These functions provide the basic \e libcaca routines for driver
  133. * initialisation, system information retrieval and configuration.
  134. *
  135. * @{ */
  136. caca_display_t * caca_create_display(cucul_canvas_t *);
  137. void caca_free_display(caca_display_t *);
  138. void caca_set_delay(caca_display_t *, unsigned int);
  139. void caca_refresh_display(caca_display_t *);
  140. unsigned int caca_get_rendertime(caca_display_t *);
  141. unsigned int caca_get_display_width(caca_display_t *);
  142. unsigned int caca_get_display_height(caca_display_t *);
  143. int caca_set_display_title(caca_display_t *, char const *);
  144. /* @} */
  145. /** \defgroup event libcaca event handling
  146. *
  147. * These functions handle user events such as keyboard input and mouse
  148. * clicks.
  149. *
  150. * @{ */
  151. int caca_get_event(caca_display_t *, unsigned int, caca_event_t *, int);
  152. unsigned int caca_get_mouse_x(caca_display_t *);
  153. unsigned int caca_get_mouse_y(caca_display_t *);
  154. void caca_set_mouse(caca_display_t *, int);
  155. /* @} */
  156. #ifdef __cplusplus
  157. }
  158. #endif
  159. #endif /* __CACA_H__ */