caca.h File Reference

The libcaca public header. More...


Data Structures

struct  caca_event
 User events. More...

Defines

#define CACA_API_VERSION_1

Typedefs

typedef caca_display caca_display_t
typedef caca_event caca_event_t

Enumerations

enum  caca_key {
  CACA_KEY_UNKNOWN = 0x00, CACA_KEY_BACKSPACE = 0x08, CACA_KEY_TAB = 0x09, CACA_KEY_RETURN = 0x0d,
  CACA_KEY_PAUSE = 0x13, CACA_KEY_ESCAPE = 0x1b, CACA_KEY_DELETE = 0x7f, CACA_KEY_UP = 0x111,
  CACA_KEY_DOWN = 0x112, CACA_KEY_LEFT = 0x113, CACA_KEY_RIGHT = 0x114, CACA_KEY_INSERT = 0x115,
  CACA_KEY_HOME = 0x116, CACA_KEY_END = 0x117, CACA_KEY_PAGEUP = 0x118, CACA_KEY_PAGEDOWN = 0x119,
  CACA_KEY_F1 = 0x11a, CACA_KEY_F2 = 0x11b, CACA_KEY_F3 = 0x11c, CACA_KEY_F4 = 0x11d,
  CACA_KEY_F5 = 0x11e, CACA_KEY_F6 = 0x11f, CACA_KEY_F7 = 0x120, CACA_KEY_F8 = 0x121,
  CACA_KEY_F9 = 0x122, CACA_KEY_F10 = 0x123, CACA_KEY_F11 = 0x124, CACA_KEY_F12 = 0x125,
  CACA_KEY_F13 = 0x126, CACA_KEY_F14 = 0x127, CACA_KEY_F15 = 0x128
}
 Special key values. More...

Functions

caca_display_t * caca_create_display (cucul_canvas_t *)
 Attach a caca graphical context to a cucul canvas.
void caca_free_display (caca_display_t *)
 Detach a caca graphical context from a cucul backend context.
void caca_set_delay (caca_display_t *, unsigned int)
 Set the refresh delay.
void caca_refresh_display (caca_display_t *)
 Flush pending changes and redraw the screen.
unsigned int caca_get_rendertime (caca_display_t *)
 Get the average rendering time.
unsigned int caca_get_display_width (caca_display_t *)
 Get the display width.
unsigned int caca_get_display_height (caca_display_t *)
 Get the display height.
int caca_set_display_title (caca_display_t *, char const *)
 Set the display title.
int caca_get_event (caca_display_t *, unsigned int, caca_event_t *, int)
 Get the next mouse or keyboard input event.
unsigned int caca_get_mouse_x (caca_display_t *)
 Return the X mouse coordinate.
unsigned int caca_get_mouse_y (caca_display_t *)
 Return the Y mouse coordinate.
void caca_set_mouse (caca_display_t *, int)
 Show or hide the mouse pointer.

Detailed Description

Version:
$Id: caca.h 613 2006-04-21 18:03:22Z sam $
Author:
Sam Hocevar <sam@zoy.org>
This header contains the public types and functions that applications using libcaca may use.

Define Documentation

#define CACA_API_VERSION_1
 

libcaca API version

Typedef Documentation

typedef struct caca_display caca_display_t
 

libcaca context

typedef struct caca_event caca_event_t
 

event structure

Enumeration Type Documentation

enum caca_key
 

Special key values returned by caca_get_event() for which there is no ASCII equivalent.

Enumerator:
CACA_KEY_UNKNOWN  Unknown key.
CACA_KEY_BACKSPACE  The backspace key.
CACA_KEY_TAB  The tabulation key.
CACA_KEY_RETURN  The return key.
CACA_KEY_PAUSE  The pause key.
CACA_KEY_ESCAPE  The escape key.
CACA_KEY_DELETE  The delete key.
CACA_KEY_UP  The up arrow key.
CACA_KEY_DOWN  The down arrow key.
CACA_KEY_LEFT  The left arrow key.
CACA_KEY_RIGHT  The right arrow key.
CACA_KEY_INSERT  The insert key.
CACA_KEY_HOME  The home key.
CACA_KEY_END  The end key.
CACA_KEY_PAGEUP  The page up key.
CACA_KEY_PAGEDOWN  The page down key.
CACA_KEY_F1  The F1 key.
CACA_KEY_F2  The F2 key.
CACA_KEY_F3  The F3 key.
CACA_KEY_F4  The F4 key.
CACA_KEY_F5  The F5 key.
CACA_KEY_F6  The F6 key.
CACA_KEY_F7  The F7 key.
CACA_KEY_F8  The F8 key.
CACA_KEY_F9  The F9 key.
CACA_KEY_F10  The F10 key.
CACA_KEY_F11  The F11 key.
CACA_KEY_F12  The F12 key.
CACA_KEY_F13  The F13 key.
CACA_KEY_F14  The F14 key.
CACA_KEY_F15  The F15 key.