Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
caca.h File Reference

The libcaca public header. More...

Data Structures

struct  caca_event
 Handling of user events. More...
 
struct  caca_option
 Option parsing. More...
 
struct  caca_conio_text_info
 DOS text area information. More...
 

Macros

#define CACA_API_VERSION_1
 
#define CACA_MAGIC_FULLWIDTH   0x000ffffe
 

Typedefs

typedef struct caca_canvas caca_canvas_t
 
typedef struct caca_dither caca_dither_t
 
typedef struct caca_charfont caca_charfont_t
 
typedef struct caca_font caca_font_t
 
typedef struct caca_file caca_file_t
 
typedef struct caca_display caca_display_t
 
typedef struct caca_event caca_event_t
 

Enumerations

enum  caca_color {
  CACA_BLACK = 0x00,
  CACA_BLUE = 0x01,
  CACA_GREEN = 0x02,
  CACA_CYAN = 0x03,
  CACA_RED = 0x04,
  CACA_MAGENTA = 0x05,
  CACA_BROWN = 0x06,
  CACA_LIGHTGRAY = 0x07,
  CACA_DARKGRAY = 0x08,
  CACA_LIGHTBLUE = 0x09,
  CACA_LIGHTGREEN = 0x0a,
  CACA_LIGHTCYAN = 0x0b,
  CACA_LIGHTRED = 0x0c,
  CACA_LIGHTMAGENTA = 0x0d,
  CACA_YELLOW = 0x0e,
  CACA_WHITE = 0x0f,
  CACA_DEFAULT = 0x10,
  CACA_TRANSPARENT = 0x20
}
 
enum  caca_style {
  CACA_BOLD = 0x01,
  CACA_ITALICS = 0x02,
  CACA_UNDERLINE = 0x04,
  CACA_BLINK = 0x08
}
 
enum  caca_event_type {
  CACA_EVENT_NONE = 0x0000,
  CACA_EVENT_KEY_PRESS = 0x0001,
  CACA_EVENT_KEY_RELEASE = 0x0002,
  CACA_EVENT_MOUSE_PRESS = 0x0004,
  CACA_EVENT_MOUSE_RELEASE = 0x0008,
  CACA_EVENT_MOUSE_MOTION = 0x0010,
  CACA_EVENT_RESIZE = 0x0020,
  CACA_EVENT_QUIT = 0x0040,
  CACA_EVENT_ANY = 0xffff
}
 User event type enumeration. More...
 
enum  caca_key {
  CACA_KEY_UNKNOWN = 0x00,
  CACA_KEY_CTRL_A = 0x01,
  CACA_KEY_CTRL_B = 0x02,
  CACA_KEY_CTRL_C = 0x03,
  CACA_KEY_CTRL_D = 0x04,
  CACA_KEY_CTRL_E = 0x05,
  CACA_KEY_CTRL_F = 0x06,
  CACA_KEY_CTRL_G = 0x07,
  CACA_KEY_BACKSPACE = 0x08,
  CACA_KEY_TAB = 0x09,
  CACA_KEY_CTRL_J = 0x0a,
  CACA_KEY_CTRL_K = 0x0b,
  CACA_KEY_CTRL_L = 0x0c,
  CACA_KEY_RETURN = 0x0d,
  CACA_KEY_CTRL_N = 0x0e,
  CACA_KEY_CTRL_O = 0x0f,
  CACA_KEY_CTRL_P = 0x10,
  CACA_KEY_CTRL_Q = 0x11,
  CACA_KEY_CTRL_R = 0x12,
  CACA_KEY_PAUSE = 0x13,
  CACA_KEY_CTRL_T = 0x14,
  CACA_KEY_CTRL_U = 0x15,
  CACA_KEY_CTRL_V = 0x16,
  CACA_KEY_CTRL_W = 0x17,
  CACA_KEY_CTRL_X = 0x18,
  CACA_KEY_CTRL_Y = 0x19,
  CACA_KEY_CTRL_Z = 0x1a,
  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...
 
enum  CACA_CONIO_COLORS {
  CACA_CONIO_BLINK = 128,
  CACA_CONIO_BLACK = 0,
  CACA_CONIO_BLUE = 1,
  CACA_CONIO_GREEN = 2,
  CACA_CONIO_CYAN = 3,
  CACA_CONIO_RED = 4,
  CACA_CONIO_MAGENTA = 5,
  CACA_CONIO_BROWN = 6,
  CACA_CONIO_LIGHTGRAY = 7,
  CACA_CONIO_DARKGRAY = 8,
  CACA_CONIO_LIGHTBLUE = 9,
  CACA_CONIO_LIGHTGREEN = 10,
  CACA_CONIO_LIGHTCYAN = 11,
  CACA_CONIO_LIGHTRED = 12,
  CACA_CONIO_LIGHTMAGENTA = 13,
  CACA_CONIO_YELLOW = 14,
  CACA_CONIO_WHITE = 15
}
 DOS colours. More...
 
enum  CACA_CONIO_CURSOR {
  CACA_CONIO__NOCURSOR = 0,
  CACA_CONIO__SOLIDCURSOR = 1,
  CACA_CONIO__NORMALCURSOR = 2
}
 DOS cursor modes. More...
 
enum  CACA_CONIO_MODE {
  CACA_CONIO_LASTMODE = -1,
  CACA_CONIO_BW40 = 0,
  CACA_CONIO_C40 = 1,
  CACA_CONIO_BW80 = 2,
  CACA_CONIO_C80 = 3,
  CACA_CONIO_MONO = 7,
  CACA_CONIO_C4350 = 64
}
 DOS video modes. More...
 

Functions

__extern caca_canvas_tcaca_create_canvas (int, int)
 Initialise a libcaca canvas. More...
 
__extern int caca_manage_canvas (caca_canvas_t *, int(*)(void *), void *)
 Manage a canvas. More...
 
__extern int caca_unmanage_canvas (caca_canvas_t *, int(*)(void *), void *)
 unmanage a canvas. More...
 
__extern int caca_set_canvas_size (caca_canvas_t *, int, int)
 Resize a canvas. More...
 
__extern int caca_get_canvas_width (caca_canvas_t const *)
 Get the canvas width. More...
 
__extern int caca_get_canvas_height (caca_canvas_t const *)
 Get the canvas height. More...
 
__extern uint32_t const * caca_get_canvas_chars (caca_canvas_t const *)
 Get the canvas character array. More...
 
__extern uint32_t const * caca_get_canvas_attrs (caca_canvas_t const *)
 Get the canvas attribute array. More...
 
__extern int caca_free_canvas (caca_canvas_t *)
 Free a libcaca canvas. More...
 
__extern int caca_rand (int, int)
 
__extern char const * caca_get_version (void)
 Return the libcaca version. More...
 
__extern int caca_gotoxy (caca_canvas_t *, int, int)
 Set cursor position. More...
 
__extern int caca_wherex (caca_canvas_t const *)
 Get X cursor position. More...
 
__extern int caca_wherey (caca_canvas_t const *)
 Get Y cursor position. More...
 
__extern int caca_put_char (caca_canvas_t *, int, int, uint32_t)
 Print an ASCII or Unicode character. More...
 
__extern uint32_t caca_get_char (caca_canvas_t const *, int, int)
 Get the Unicode character at the given coordinates. More...
 
__extern int caca_put_str (caca_canvas_t *, int, int, char const *)
 Print a string. More...
 
__extern int caca_printf (caca_canvas_t *, int, int, char const *,...)
 Print a formated string. More...
 
__extern int caca_vprintf (caca_canvas_t *, int, int, char const *, va_list)
 Print a formated string (va_list version). More...
 
__extern int caca_clear_canvas (caca_canvas_t *)
 Clear the canvas. More...
 
__extern int caca_set_canvas_handle (caca_canvas_t *, int, int)
 Set cursor handle. More...
 
__extern int caca_get_canvas_handle_x (caca_canvas_t const *)
 Get X handle position. More...
 
__extern int caca_get_canvas_handle_y (caca_canvas_t const *)
 Get Y handle position. More...
 
__extern int caca_blit (caca_canvas_t *, int, int, caca_canvas_t const *, caca_canvas_t const *)
 Blit a canvas onto another one. More...
 
__extern int caca_set_canvas_boundaries (caca_canvas_t *, int, int, int, int)
 Set a canvas' new boundaries. More...
 
__extern int caca_disable_dirty_rect (caca_canvas_t *)
 Disable dirty rectangles. More...
 
__extern int caca_enable_dirty_rect (caca_canvas_t *)
 Enable dirty rectangles. More...
 
__extern int caca_get_dirty_rect_count (caca_canvas_t *)
 Get the number of dirty rectangles in the canvas. More...
 
__extern int caca_get_dirty_rect (caca_canvas_t *, int, int *, int *, int *, int *)
 Get a canvas's dirty rectangle. More...
 
__extern int caca_add_dirty_rect (caca_canvas_t *, int, int, int, int)
 Add an area to the canvas's dirty rectangle list. More...
 
__extern int caca_remove_dirty_rect (caca_canvas_t *, int, int, int, int)
 Remove an area from the dirty rectangle list. More...
 
__extern int caca_clear_dirty_rect_list (caca_canvas_t *)
 Clear a canvas's dirty rectangle list. More...
 
__extern int caca_invert (caca_canvas_t *)
 Invert a canvas' colours. More...
 
__extern int caca_flip (caca_canvas_t *)
 Flip a canvas horizontally. More...
 
__extern int caca_flop (caca_canvas_t *)
 Flip a canvas vertically. More...
 
__extern int caca_rotate_180 (caca_canvas_t *)
 Rotate a canvas. More...
 
__extern int caca_rotate_left (caca_canvas_t *)
 Rotate a canvas, 90 degrees counterclockwise. More...
 
__extern int caca_rotate_right (caca_canvas_t *)
 Rotate a canvas, 90 degrees counterclockwise. More...
 
__extern int caca_stretch_left (caca_canvas_t *)
 Rotate and stretch a canvas, 90 degrees counterclockwise. More...
 
__extern int caca_stretch_right (caca_canvas_t *)
 Rotate and stretch a canvas, 90 degrees clockwise. More...
 
__extern uint32_t caca_get_attr (caca_canvas_t const *, int, int)
 Get the text attribute at the given coordinates. More...
 
__extern int caca_set_attr (caca_canvas_t *, uint32_t)
 Set the default character attribute. More...
 
__extern int caca_unset_attr (caca_canvas_t *, uint32_t)
 Unset flags in the default character attribute. More...
 
__extern int caca_toggle_attr (caca_canvas_t *, uint32_t)
 Toggle flags in the default character attribute. More...
 
__extern int caca_put_attr (caca_canvas_t *, int, int, uint32_t)
 Set the character attribute at the given coordinates. More...
 
__extern int caca_set_color_ansi (caca_canvas_t *, uint8_t, uint8_t)
 Set the default colour pair for text (ANSI version). More...
 
__extern int caca_set_color_argb (caca_canvas_t *, uint16_t, uint16_t)
 Set the default colour pair for text (truecolor version). More...
 
__extern uint8_t caca_attr_to_ansi (uint32_t)
 Get DOS ANSI information from attribute. More...
 
__extern uint8_t caca_attr_to_ansi_fg (uint32_t)
 Get ANSI foreground information from attribute. More...
 
__extern uint8_t caca_attr_to_ansi_bg (uint32_t)
 Get ANSI background information from attribute. More...
 
__extern uint16_t caca_attr_to_rgb12_fg (uint32_t)
 Get 12-bit RGB foreground information from attribute. More...
 
__extern uint16_t caca_attr_to_rgb12_bg (uint32_t)
 Get 12-bit RGB background information from attribute. More...
 
__extern void caca_attr_to_argb64 (uint32_t, uint8_t[8])
 Get 64-bit ARGB information from attribute. More...
 
__extern uint32_t caca_utf8_to_utf32 (char const *, size_t *)
 Convert a UTF-8 character to UTF-32. More...
 
__extern size_t caca_utf32_to_utf8 (char *, uint32_t)
 Convert a UTF-32 character to UTF-8. More...
 
__extern uint8_t caca_utf32_to_cp437 (uint32_t)
 Convert a UTF-32 character to CP437. More...
 
__extern uint32_t caca_cp437_to_utf32 (uint8_t)
 Convert a CP437 character to UTF-32. More...
 
__extern char caca_utf32_to_ascii (uint32_t)
 Convert a UTF-32 character to ASCII. More...
 
__extern int caca_utf32_is_fullwidth (uint32_t)
 Tell whether a UTF-32 character is fullwidth. More...
 
__extern int caca_draw_line (caca_canvas_t *, int, int, int, int, uint32_t)
 Draw a line on the canvas using the given character. More...
 
__extern int caca_draw_polyline (caca_canvas_t *, int const x[], int const y[], int, uint32_t)
 Draw a polyline. More...
 
__extern int caca_draw_thin_line (caca_canvas_t *, int, int, int, int)
 Draw a thin line on the canvas, using ASCII art. More...
 
__extern int caca_draw_thin_polyline (caca_canvas_t *, int const x[], int const y[], int)
 Draw an ASCII art thin polyline. More...
 
__extern int caca_draw_circle (caca_canvas_t *, int, int, int, uint32_t)
 Draw a circle on the canvas using the given character. More...
 
__extern int caca_draw_ellipse (caca_canvas_t *, int, int, int, int, uint32_t)
 Draw an ellipse on the canvas using the given character. More...
 
__extern int caca_draw_thin_ellipse (caca_canvas_t *, int, int, int, int)
 Draw a thin ellipse on the canvas. More...
 
__extern int caca_fill_ellipse (caca_canvas_t *, int, int, int, int, uint32_t)
 Fill an ellipse on the canvas using the given character. More...
 
__extern int caca_draw_box (caca_canvas_t *, int, int, int, int, uint32_t)
 Draw a box on the canvas using the given character. More...
 
__extern int caca_draw_thin_box (caca_canvas_t *, int, int, int, int)
 Draw a thin box on the canvas. More...
 
__extern int caca_draw_cp437_box (caca_canvas_t *, int, int, int, int)
 Draw a box on the canvas using CP437 characters. More...
 
__extern int caca_fill_box (caca_canvas_t *, int, int, int, int, uint32_t)
 Fill a box on the canvas using the given character. More...
 
__extern int caca_draw_triangle (caca_canvas_t *, int, int, int, int, int, int, uint32_t)
 Draw a triangle on the canvas using the given character. More...
 
__extern int caca_draw_thin_triangle (caca_canvas_t *, int, int, int, int, int, int)
 Draw a thin triangle on the canvas. More...
 
__extern int caca_fill_triangle (caca_canvas_t *, int, int, int, int, int, int, uint32_t)
 Fill a triangle on the canvas using the given character. More...
 
__extern int caca_fill_triangle_textured (caca_canvas_t *cv, int coords[6], caca_canvas_t *tex, float uv[6])
 Fill a triangle on the canvas using an arbitrary-sized texture. More...
 
__extern int caca_get_frame_count (caca_canvas_t const *)
 Get the number of frames in a canvas. More...
 
__extern int caca_set_frame (caca_canvas_t *, int)
 Activate a given canvas frame. More...
 
__extern char const * caca_get_frame_name (caca_canvas_t const *)
 Get the current frame's name. More...
 
__extern int caca_set_frame_name (caca_canvas_t *, char const *)
 Set the current frame's name. More...
 
__extern int caca_create_frame (caca_canvas_t *, int)
 Add a frame to a canvas. More...
 
__extern int caca_free_frame (caca_canvas_t *, int)
 Remove a frame from a canvas. More...
 
__extern caca_dither_tcaca_create_dither (int, int, int, int, uint32_t, uint32_t, uint32_t, uint32_t)
 Create an internal dither object. More...
 
__extern int caca_set_dither_palette (caca_dither_t *, uint32_t r[], uint32_t g[], uint32_t b[], uint32_t a[])
 Set the palette of an 8bpp dither object. More...
 
__extern int caca_set_dither_brightness (caca_dither_t *, float)
 Set the brightness of a dither object. More...
 
__extern float caca_get_dither_brightness (caca_dither_t const *)
 Get the brightness of a dither object. More...
 
__extern int caca_set_dither_gamma (caca_dither_t *, float)
 Set the gamma of a dither object. More...
 
__extern float caca_get_dither_gamma (caca_dither_t const *)
 Get the gamma of a dither object. More...
 
__extern int caca_set_dither_contrast (caca_dither_t *, float)
 Set the contrast of a dither object. More...
 
__extern float caca_get_dither_contrast (caca_dither_t const *)
 Get the contrast of a dither object. More...
 
__extern int caca_set_dither_antialias (caca_dither_t *, char const *)
 Set dither antialiasing. More...
 
__extern char const *const * caca_get_dither_antialias_list (caca_dither_t const *)
 Get available antialiasing methods. More...
 
__extern char const * caca_get_dither_antialias (caca_dither_t const *)
 Get current antialiasing method. More...
 
__extern int caca_set_dither_color (caca_dither_t *, char const *)
 Choose colours used for dithering. More...
 
__extern char const *const * caca_get_dither_color_list (caca_dither_t const *)
 Get available colour modes. More...
 
__extern char const * caca_get_dither_color (caca_dither_t const *)
 Get current colour mode. More...
 
__extern int caca_set_dither_charset (caca_dither_t *, char const *)
 Choose characters used for dithering. More...
 
__extern char const *const * caca_get_dither_charset_list (caca_dither_t const *)
 Get available dither character sets. More...
 
__extern char const * caca_get_dither_charset (caca_dither_t const *)
 Get current character set. More...
 
__extern int caca_set_dither_algorithm (caca_dither_t *, char const *)
 Set dithering algorithm. More...
 
__extern char const *const * caca_get_dither_algorithm_list (caca_dither_t const *)
 Get dithering algorithms. More...
 
__extern char const * caca_get_dither_algorithm (caca_dither_t const *)
 Get current dithering algorithm. More...
 
__extern int caca_dither_bitmap (caca_canvas_t *, int, int, int, int, caca_dither_t const *, void const *)
 Dither a bitmap on the canvas. More...
 
__extern int caca_free_dither (caca_dither_t *)
 Free the memory associated with a dither. More...
 
__extern caca_charfont_tcaca_load_charfont (void const *, size_t)
 
__extern int caca_free_charfont (caca_charfont_t *)
 
__extern caca_font_tcaca_load_font (void const *, size_t)
 Load a font from memory for future use. More...
 
__extern char const *const * caca_get_font_list (void)
 Get available builtin fonts. More...
 
__extern int caca_get_font_width (caca_font_t const *)
 Get a font's standard glyph width. More...
 
__extern int caca_get_font_height (caca_font_t const *)
 Get a font's standard glyph height. More...
 
__extern uint32_t const * caca_get_font_blocks (caca_font_t const *)
 Get a font's list of supported glyphs. More...
 
__extern int caca_render_canvas (caca_canvas_t const *, caca_font_t const *, void *, int, int, int)
 Render the canvas onto an image buffer. More...
 
__extern int caca_free_font (caca_font_t *)
 Free a font structure. More...
 
__extern int caca_canvas_set_figfont (caca_canvas_t *, char const *)
 load a figfont and attach it to a canvas
 
__extern int caca_set_figfont_smush (caca_canvas_t *, char const *)
 set the smushing mode of the figfont rendering
 
__extern int caca_set_figfont_width (caca_canvas_t *, int)
 set the width of the figfont rendering
 
__extern int caca_put_figchar (caca_canvas_t *, uint32_t)
 paste a character using the current figfont
 
__extern int caca_flush_figlet (caca_canvas_t *)
 flush the figlet context
 
__extern caca_file_tcaca_file_open (char const *, const char *)
 Open a file for reading or writing. More...
 
__extern int caca_file_close (caca_file_t *)
 Close a file handle. More...
 
__extern uint64_t caca_file_tell (caca_file_t *)
 Return the position in a file handle. More...
 
__extern size_t caca_file_read (caca_file_t *, void *, size_t)
 Read data from a file handle. More...
 
__extern size_t caca_file_write (caca_file_t *, const void *, size_t)
 Write data to a file handle. More...
 
__extern char * caca_file_gets (caca_file_t *, char *, int)
 Read a line from a file handle. More...
 
__extern int caca_file_eof (caca_file_t *)
 Tell whether a file handle reached end of file. More...
 
__extern ssize_t caca_import_canvas_from_memory (caca_canvas_t *, void const *, size_t, char const *)
 Import a memory buffer into a canvas. More...
 
__extern ssize_t caca_import_canvas_from_file (caca_canvas_t *, char const *, char const *)
 Import a file into a canvas. More...
 
__extern ssize_t caca_import_area_from_memory (caca_canvas_t *, int, int, void const *, size_t, char const *)
 Import a memory buffer into a canvas area. More...
 
__extern ssize_t caca_import_area_from_file (caca_canvas_t *, int, int, char const *, char const *)
 Import a file into a canvas area. More...
 
__extern char const *const * caca_get_import_list (void)
 Get available import formats. More...
 
__extern void * caca_export_canvas_to_memory (caca_canvas_t const *, char const *, size_t *)
 Export a canvas into a foreign format. More...
 
__extern void * caca_export_area_to_memory (caca_canvas_t const *, int, int, int, int, char const *, size_t *)
 Export a canvas portion into a foreign format. More...
 
__extern char const *const * caca_get_export_list (void)
 Get available export formats. More...
 
__extern caca_display_tcaca_create_display (caca_canvas_t *)
 Attach a caca graphical context to a caca canvas. More...
 
__extern caca_display_tcaca_create_display_with_driver (caca_canvas_t *, char const *)
 Attach a specific caca graphical context to a caca canvas. More...
 
__extern char const *const * caca_get_display_driver_list (void)
 Get available display drivers. More...
 
__extern char const * caca_get_display_driver (caca_display_t *)
 Return a caca graphical context's current output driver. More...
 
__extern int caca_set_display_driver (caca_display_t *, char const *)
 Set the output driver. More...
 
__extern int caca_free_display (caca_display_t *)
 Detach a caca graphical context from a caca backend context. More...
 
__extern caca_canvas_tcaca_get_canvas (caca_display_t *)
 Get the canvas attached to a caca graphical context. More...
 
__extern int caca_refresh_display (caca_display_t *)
 Flush pending changes and redraw the screen. More...
 
__extern int caca_set_display_time (caca_display_t *, int)
 Set the refresh delay. More...
 
__extern int caca_get_display_time (caca_display_t const *)
 Get the display's average rendering time. More...
 
__extern int caca_get_display_width (caca_display_t const *)
 Get the display width. More...
 
__extern int caca_get_display_height (caca_display_t const *)
 Get the display height. More...
 
__extern int caca_set_display_title (caca_display_t *, char const *)
 Set the display title. More...
 
__extern int caca_set_mouse (caca_display_t *, int)
 Show or hide the mouse pointer. More...
 
__extern int caca_set_cursor (caca_display_t *, int)
 Show or hide the cursor. More...
 
__extern int caca_get_event (caca_display_t *, int, caca_event_t *, int)
 Get the next mouse or keyboard input event. More...
 
__extern int caca_get_mouse_x (caca_display_t const *)
 Return the X mouse coordinate. More...
 
__extern int caca_get_mouse_y (caca_display_t const *)
 Return the Y mouse coordinate. More...
 
__extern enum caca_event_type caca_get_event_type (caca_event_t const *)
 Return an event's type. More...
 
__extern int caca_get_event_key_ch (caca_event_t const *)
 Return a key press or key release event's value. More...
 
__extern uint32_t caca_get_event_key_utf32 (caca_event_t const *)
 Return a key press or key release event's Unicode value. More...
 
__extern int caca_get_event_key_utf8 (caca_event_t const *, char *)
 Return a key press or key release event's UTF-8 value. More...
 
__extern int caca_get_event_mouse_button (caca_event_t const *)
 Return a mouse press or mouse release event's button. More...
 
__extern int caca_get_event_mouse_x (caca_event_t const *)
 Return a mouse motion event's X coordinate. More...
 
__extern int caca_get_event_mouse_y (caca_event_t const *)
 Return a mouse motion event's Y coordinate. More...
 
__extern int caca_get_event_resize_width (caca_event_t const *)
 Return a resize event's display width value. More...
 
__extern int caca_get_event_resize_height (caca_event_t const *)
 Return a resize event's display height value. More...
 
__extern int caca_getopt (int, char *const[], char const *, struct caca_option const *, int *)
 
__extern char * caca_conio_cgets (char *str)
 DOS conio.h cgets() equivalent.
 
__extern void caca_conio_clreol (void)
 DOS conio.h clreol() equivalent.
 
__extern void caca_conio_clrscr (void)
 DOS conio.h clrscr() equivalent.
 
__extern int caca_conio_cprintf (const char *format,...)
 DOS conio.h cprintf() equivalent.
 
__extern int caca_conio_cputs (const char *str)
 DOS conio.h cputs() equivalent.
 
__extern int caca_conio_cscanf (char *format,...)
 DOS stdio.h cscanf() equivalent.
 
__extern void caca_conio_delay (unsigned int)
 DOS dos.h delay() equivalent.
 
__extern void caca_conio_delline (void)
 DOS conio.h delline() equivalent.
 
__extern int caca_conio_getch (void)
 DOS conio.h getch() equivalent.
 
__extern int caca_conio_getche (void)
 DOS conio.h getche() equivalent.
 
__extern char * caca_conio_getpass (const char *prompt)
 DOS conio.h getpass() equivalent.
 
__extern int caca_conio_gettext (int left, int top, int right, int bottom, void *destin)
 DOS conio.h gettext() equivalent.
 
__extern void caca_conio_gettextinfo (struct caca_conio_text_info *r)
 DOS conio.h gettextinfo() equivalent.
 
__extern void caca_conio_gotoxy (int x, int y)
 DOS conio.h gotoxy() equivalent.
 
__extern void caca_conio_highvideo (void)
 DOS conio.h highvideo() equivalent.
 
__extern void caca_conio_insline (void)
 DOS conio.h insline() equivalent.
 
__extern int caca_conio_kbhit (void)
 DOS conio.h kbhit() equivalent.
 
__extern void caca_conio_lowvideo (void)
 DOS conio.h lowvideo() equivalent.
 
__extern int caca_conio_movetext (int left, int top, int right, int bottom, int destleft, int desttop)
 DOS conio.h movetext() equivalent.
 
__extern void caca_conio_normvideo (void)
 DOS conio.h normvideo() equivalent.
 
__extern void caca_conio_nosound (void)
 DOS dos.h nosound() equivalent.
 
__extern int caca_conio_printf (const char *format,...)
 DOS stdio.h printf() equivalent.
 
__extern int caca_conio_putch (int ch)
 DOS conio.h putch() equivalent.
 
__extern int caca_conio_puttext (int left, int top, int right, int bottom, void *destin)
 DOS conio.h puttext() equivalent.
 
__extern void caca_conio__setcursortype (int cur_t)
 DOS conio.h _setcursortype() equivalent.
 
__extern void caca_conio_sleep (unsigned int)
 DOS dos.h sleep() equivalent.
 
__extern void caca_conio_sound (unsigned int)
 DOS dos.h sound() equivalent.
 
__extern void caca_conio_textattr (int newattr)
 DOS conio.h textattr() equivalent.
 
__extern void caca_conio_textbackground (int newcolor)
 DOS conio.h textbackground() equivalent.
 
__extern void caca_conio_textcolor (int newcolor)
 DOS conio.h textcolor() equivalent.
 
__extern void caca_conio_textmode (int newmode)
 DOS conio.h textmode() equivalent.
 
__extern int caca_conio_ungetch (int ch)
 DOS conio.h ungetch() equivalent.
 
__extern int caca_conio_wherex (void)
 DOS conio.h wherex() equivalent.
 
__extern int caca_conio_wherey (void)
 DOS conio.h wherey() equivalent.
 
__extern void caca_conio_window (int left, int top, int right, int bottom)
 DOS conio.h window() equivalent.
 

Variables

__extern int caca_optind
 
__extern char * caca_optarg
 
__extern int caca_conio_directvideo
 DOS direct video control.
 
__extern int caca_conio__wscroll
 DOS scrolling control.
 

Detailed Description

Author
Sam Hocevar sam@h.nosp@m.ocev.nosp@m.ar.ne.nosp@m.t

This header contains the public types and functions that applications using libcaca may use.

Macro Definition Documentation

◆ CACA_API_VERSION_1

#define CACA_API_VERSION_1

libcaca API version

Typedef Documentation

◆ caca_canvas_t

typedef struct caca_canvas caca_canvas_t

libcaca canvas

◆ caca_dither_t

typedef struct caca_dither caca_dither_t

dither structure

◆ caca_charfont_t

typedef struct caca_charfont caca_charfont_t

character font structure

◆ caca_font_t

typedef struct caca_font caca_font_t

bitmap font structure

◆ caca_file_t

typedef struct caca_file caca_file_t

file handle structure

◆ caca_display_t

typedef struct caca_display caca_display_t

libcaca display context

◆ caca_event_t

typedef struct caca_event caca_event_t

libcaca event structure

caca_conio_ungetch
__extern int caca_conio_ungetch(int ch)
DOS conio.h ungetch() equivalent.
Definition: caca_conio.c:497
caca_event_type
caca_event_type
User event type enumeration.
Definition: caca.h:108
caca_get_dither_charset_list
__extern char const *const * caca_get_dither_charset_list(caca_dither_t const *)
Get available dither character sets.
Definition: dither.c:781
caca_get_canvas_chars
__extern uint32_t const * caca_get_canvas_chars(caca_canvas_t const *)
Get the canvas character array.
Definition: canvas.c:272
CACA_LIGHTGREEN
@ CACA_LIGHTGREEN
Definition: caca.h:81
caca_set_dither_brightness
__extern int caca_set_dither_brightness(caca_dither_t *, float)
Set the brightness of a dither object.
Definition: dither.c:421
caca_wherex
__extern int caca_wherex(caca_canvas_t const *)
Get X cursor position.
Definition: string.c:75
caca_fill_triangle
__extern int caca_fill_triangle(caca_canvas_t *, int, int, int, int, int, int, uint32_t)
Fill a triangle on the canvas using the given character.
Definition: triangle.c:87
caca_utf32_to_cp437
__extern uint8_t caca_utf32_to_cp437(uint32_t)
Convert a UTF-32 character to CP437.
Definition: charset.c:191
caca_get_event_resize_height
__extern int caca_get_event_resize_height(caca_event_t const *)
Return a resize event's display height value.
Definition: event.c:340
caca_get_event_mouse_x
__extern int caca_get_event_mouse_x(caca_event_t const *)
Return a mouse motion event's X coordinate.
Definition: event.c:292
caca_conio_clrscr
__extern void caca_conio_clrscr(void)
DOS conio.h clrscr() equivalent.
Definition: caca_conio.c:87
caca_create_display
caca_display_t * caca_create_display(caca_canvas_t *cv)
Attach a caca graphical context to a caca canvas.
Definition: caca/caca.c:68
caca_render_canvas
__extern int caca_render_canvas(caca_canvas_t const *, caca_font_t const *, void *, int, int, int)
Render the canvas onto an image buffer.
Definition: font.c:415
caca_file_eof
__extern int caca_file_eof(caca_file_t *)
Tell whether a file handle reached end of file.
Definition: file.c:298
caca_unset_attr
int caca_unset_attr(caca_canvas_t *cv, uint32_t attr)
Unset flags in the default character attribute.
Definition: attr.c:127
caca_flop
__extern int caca_flop(caca_canvas_t *)
Flip a canvas vertically.
Definition: transform.c:135
caca_conio_gotoxy
__extern void caca_conio_gotoxy(int x, int y)
DOS conio.h gotoxy() equivalent.
Definition: caca_conio.c:264
caca_draw_box
int caca_draw_box(caca_canvas_t *cv, int x, int y, int w, int h, uint32_t ch)
Draw a box on the canvas using the given character.
Definition: box.c:41
caca_draw_thin_triangle
__extern int caca_draw_thin_triangle(caca_canvas_t *, int, int, int, int, int, int)
Draw a thin triangle on the canvas.
Definition: triangle.c:63
caca_conio_text_info::curx
unsigned char curx
Definition: caca.h:620
CACA_EVENT_KEY_RELEASE
@ CACA_EVENT_KEY_RELEASE
Definition: caca.h:112
caca_get_event_mouse_y
__extern int caca_get_event_mouse_y(caca_event_t const *)
Return a mouse motion event's Y coordinate.
Definition: event.c:308
caca_draw_triangle
__extern int caca_draw_triangle(caca_canvas_t *, int, int, int, int, int, int, uint32_t)
Draw a triangle on the canvas using the given character.
Definition: triangle.c:40
caca_get_canvas_height
__extern int caca_get_canvas_height(caca_canvas_t const *)
Get the canvas height.
Definition: canvas.c:253
caca_conio_text_info::winleft
unsigned char winleft
Definition: caca.h:610
CACA_KEY_F5
@ CACA_KEY_F5
Definition: caca.h:212
CACA_EVENT_RESIZE
@ CACA_EVENT_RESIZE
Definition: caca.h:116
caca_charfont_t
struct caca_charfont caca_charfont_t
Definition: caca.h:53
caca_conio_text_info::attribute
unsigned char attribute
Definition: caca.h:614
caca_set_mouse
__extern int caca_set_mouse(caca_display_t *, int)
Show or hide the mouse pointer.
Definition: graphics.c:243
caca_get_event_key_utf32
__extern uint32_t caca_get_event_key_utf32(caca_event_t const *)
Return a key press or key release event's Unicode value.
Definition: event.c:236
caca_get_event_mouse_button
__extern int caca_get_event_mouse_button(caca_event_t const *)
Return a mouse press or mouse release event's button.
Definition: event.c:276
caca_get_dither_algorithm_list
__extern char const *const * caca_get_dither_algorithm_list(caca_dither_t const *)
Get dithering algorithms.
Definition: dither.c:894
CACA_EVENT_MOUSE_RELEASE
@ CACA_EVENT_MOUSE_RELEASE
Definition: caca.h:114
CACA_KEY_CTRL_D
@ CACA_KEY_CTRL_D
Definition: caca.h:169
CACA_EVENT_MOUSE_MOTION
@ CACA_EVENT_MOUSE_MOTION
Definition: caca.h:115
CACA_CYAN
@ CACA_CYAN
Definition: caca.h:74
caca_draw_thin_box
int caca_draw_thin_box(caca_canvas_t *cv, int x, int y, int w, int h)
Draw a thin box on the canvas.
Definition: box.c:65
caca_conio_kbhit
__extern int caca_conio_kbhit(void)
DOS conio.h kbhit() equivalent.
Definition: caca_conio.c:290
caca_get_display_driver
char const * caca_get_display_driver(caca_display_t *dp)
Return a caca graphical context's current output driver.
Definition: caca/caca.c:196
caca_file_close
__extern int caca_file_close(caca_file_t *)
Close a file handle.
Definition: file.c:151
caca_get_frame_name
__extern char const * caca_get_frame_name(caca_canvas_t const *)
Get the current frame's name.
Definition: frame.c:90
caca_set_color_ansi
int caca_set_color_ansi(caca_canvas_t *cv, uint8_t fg, uint8_t bg)
Set the default colour pair for text (ANSI version).
Definition: attr.c:234
caca_conio_text_info::screenwidth
unsigned char screenwidth
Definition: caca.h:619
CACA_KEY_F8
@ CACA_KEY_F8
Definition: caca.h:215
caca_conio_text_info::normattr
unsigned char normattr
Definition: caca.h:615
CACA_ITALICS
@ CACA_ITALICS
Definition: caca.h:95
caca_set_dither_algorithm
__extern int caca_set_dither_algorithm(caca_dither_t *, char const *)
Set dithering algorithm.
Definition: dither.c:828
caca_blit
__extern int caca_blit(caca_canvas_t *, int, int, caca_canvas_t const *, caca_canvas_t const *)
Blit a canvas onto another one.
Definition: string.c:455
caca_file_t
struct caca_file caca_file_t
Definition: caca.h:57
caca_option
Option parsing.
Definition: caca.h:149
CACA_KEY_F6
@ CACA_KEY_F6
Definition: caca.h:213
CACA_EVENT_NONE
@ CACA_EVENT_NONE
Definition: caca.h:109
CACA_KEY_F4
@ CACA_KEY_F4
Definition: caca.h:211
caca_conio_lowvideo
__extern void caca_conio_lowvideo(void)
DOS conio.h lowvideo() equivalent.
Definition: caca_conio.c:324
CACA_KEY_CTRL_U
@ CACA_KEY_CTRL_U
Definition: caca.h:186
caca_cp437_to_utf32
__extern uint32_t caca_cp437_to_utf32(uint8_t)
Convert a CP437 character to UTF-32.
Definition: charset.c:223
caca_file_gets
__extern char * caca_file_gets(caca_file_t *, char *, int)
Read a line from a file handle.
Definition: file.c:255
caca_event
Handling of user events.
Definition: caca.h:130
caca_set_dither_contrast
__extern int caca_set_dither_contrast(caca_dither_t *, float)
Set the contrast of a dither object.
Definition: dither.c:506
caca_rotate_180
__extern int caca_rotate_180(caca_canvas_t *)
Rotate a canvas.
Definition: transform.c:184
caca_fill_ellipse
__extern int caca_fill_ellipse(caca_canvas_t *, int, int, int, int, uint32_t)
Fill an ellipse on the canvas using the given character.
Definition: conic.c:68
caca_file_tell
__extern uint64_t caca_file_tell(caca_file_t *)
Return the position in a file handle.
Definition: file.c:176
CACA_KEY_CTRL_L
@ CACA_KEY_CTRL_L
Definition: caca.h:177
caca_create_canvas
__extern caca_canvas_t * caca_create_canvas(int, int)
Initialise a libcaca canvas.
Definition: canvas.c:54
caca_set_canvas_boundaries
__extern int caca_set_canvas_boundaries(caca_canvas_t *, int, int, int, int)
Set a canvas' new boundaries.
Definition: string.c:561
caca_free_font
__extern int caca_free_font(caca_font_t *)
Free a font structure.
Definition: font.c:381
CACA_KEY_CTRL_Y
@ CACA_KEY_CTRL_Y
Definition: caca.h:190
caca_conio_puttext
__extern int caca_conio_puttext(int left, int top, int right, int bottom, void *destin)
DOS conio.h puttext() equivalent.
Definition: caca_conio.c:402
CACA_CONIO_MODE
CACA_CONIO_MODE
DOS video modes.
Definition: caca.h:593
CACA_KEY_CTRL_V
@ CACA_KEY_CTRL_V
Definition: caca.h:187
CACA_KEY_DELETE
@ CACA_KEY_DELETE
Definition: caca.h:193
caca_conio_text_info
DOS text area information.
Definition: caca.h:609
CACA_CONIO_CURSOR
CACA_CONIO_CURSOR
DOS cursor modes.
Definition: caca.h:581
CACA_EVENT_QUIT
@ CACA_EVENT_QUIT
Definition: caca.h:117
CACA_KEY_F14
@ CACA_KEY_F14
Definition: caca.h:221
caca_set_frame
__extern int caca_set_frame(caca_canvas_t *, int)
Activate a given canvas frame.
Definition: frame.c:57
CACA_KEY_F13
@ CACA_KEY_F13
Definition: caca.h:220
caca_import_canvas_from_memory
__extern ssize_t caca_import_canvas_from_memory(caca_canvas_t *, void const *, size_t, char const *)
Import a memory buffer into a canvas.
Definition: import.c:73
CACA_KEY_CTRL_G
@ CACA_KEY_CTRL_G
Definition: caca.h:172
caca_get_canvas
caca_canvas_t * caca_get_canvas(caca_display_t *dp)
Get the canvas attached to a caca graphical context.
Definition: caca/caca.c:259
caca_style
caca_style
Definition: caca.h:93
caca_clear_dirty_rect_list
__extern int caca_clear_dirty_rect_list(caca_canvas_t *)
Clear a canvas's dirty rectangle list.
Definition: dirty.c:256
caca_conio_clreol
__extern void caca_conio_clreol(void)
DOS conio.h clreol() equivalent.
Definition: caca_conio.c:75
caca_conio_insline
__extern void caca_conio_insline(void)
DOS conio.h insline() equivalent.
Definition: caca_conio.c:282
caca_get_canvas_attrs
__extern uint32_t const * caca_get_canvas_attrs(caca_canvas_t const *)
Get the canvas attribute array.
Definition: canvas.c:291
caca_get_char
__extern uint32_t caca_get_char(caca_canvas_t const *, int, int)
Get the Unicode character at the given coordinates.
Definition: string.c:224
caca_import_area_from_file
__extern ssize_t caca_import_area_from_file(caca_canvas_t *, int, int, char const *, char const *)
Import a file into a canvas area.
Definition: import.c:248
caca_get_dither_color_list
__extern char const *const * caca_get_dither_color_list(caca_dither_t const *)
Get available colour modes.
Definition: dither.c:688
caca_get_canvas_width
__extern int caca_get_canvas_width(caca_canvas_t const *)
Get the canvas width.
Definition: canvas.c:239
caca_conio_getche
__extern int caca_conio_getche(void)
DOS conio.h getche() equivalent.
Definition: caca_conio.c:212
caca_draw_thin_line
__extern int caca_draw_thin_line(caca_canvas_t *, int, int, int, int)
Draw a thin line on the canvas, using ASCII art.
Definition: line.c:116
caca_get_export_list
__extern char const *const * caca_get_export_list(void)
Get available export formats.
Definition: export.c:180
CACA_KEY_CTRL_P
@ CACA_KEY_CTRL_P
Definition: caca.h:181
caca_printf
__extern int caca_printf(caca_canvas_t *, int, int, char const *,...)
Print a formated string.
Definition: string.c:304
caca_refresh_display
__extern int caca_refresh_display(caca_display_t *)
Flush pending changes and redraw the screen.
Definition: graphics.c:146
caca_conio_sleep
__extern void caca_conio_sleep(unsigned int)
DOS dos.h sleep() equivalent.
Definition: caca_conio.c:431
CACA_LIGHTBLUE
@ CACA_LIGHTBLUE
Definition: caca.h:80
CACA_EVENT_MOUSE_PRESS
@ CACA_EVENT_MOUSE_PRESS
Definition: caca.h:113
caca_export_canvas_to_memory
__extern void * caca_export_canvas_to_memory(caca_canvas_t const *, char const *, size_t *)
Export a canvas into a foreign format.
Definition: export.c:83
caca_free_display
int caca_free_display(caca_display_t *dp)
Detach a caca graphical context from a caca backend context.
Definition: caca/caca.c:238
CACA_BLINK
@ CACA_BLINK
Definition: caca.h:97
CACA_KEY_INSERT
@ CACA_KEY_INSERT
Definition: caca.h:202
caca_import_area_from_memory
__extern ssize_t caca_import_area_from_memory(caca_canvas_t *, int, int, void const *, size_t, char const *)
Import a memory buffer into a canvas area.
Definition: import.c:209
CACA_LIGHTGRAY
@ CACA_LIGHTGRAY
Definition: caca.h:78
caca_put_figchar
__extern int caca_put_figchar(caca_canvas_t *, uint32_t)
paste a character using the current figfont
Definition: figfont.c:143
caca_attr_to_argb64
void caca_attr_to_argb64(uint32_t attr, uint8_t argb[8])
Get 64-bit ARGB information from attribute.
Definition: attr.c:433
caca_get_mouse_y
__extern int caca_get_mouse_y(caca_display_t const *)
Return the Y mouse coordinate.
Definition: event.c:170
CACA_EVENT_KEY_PRESS
@ CACA_EVENT_KEY_PRESS
Definition: caca.h:111
caca_conio_delay
__extern void caca_conio_delay(unsigned int)
DOS dos.h delay() equivalent.
Definition: caca_conio.c:148
caca_conio_text_info::cury
unsigned char cury
Definition: caca.h:621
caca_set_cursor
__extern int caca_set_cursor(caca_display_t *, int)
Show or hide the cursor.
Definition: graphics.c:218
caca_file_write
__extern size_t caca_file_write(caca_file_t *, const void *, size_t)
Write data to a file handle.
Definition: file.c:222
caca_utf32_to_ascii
__extern char caca_utf32_to_ascii(uint32_t)
Convert a UTF-32 character to ASCII.
Definition: charset.c:249
caca_set_color_argb
int caca_set_color_argb(caca_canvas_t *cv, uint16_t fg, uint16_t bg)
Set the default colour pair for text (truecolor version).
Definition: attr.c:267
caca_conio_text_info::screenheight
unsigned char screenheight
Definition: caca.h:618
caca_conio_cscanf
__extern int caca_conio_cscanf(char *format,...)
DOS stdio.h cscanf() equivalent.
Definition: caca_conio.c:138
caca_import_canvas_from_file
__extern ssize_t caca_import_canvas_from_file(caca_canvas_t *, char const *, char const *)
Import a file into a canvas.
Definition: import.c:152
CACA_KEY_CTRL_A
@ CACA_KEY_CTRL_A
Definition: caca.h:166
CACA_WHITE
@ CACA_WHITE
Definition: caca.h:86
CACA_TRANSPARENT
@ CACA_TRANSPARENT
Definition: caca.h:88
caca_utf8_to_utf32
__extern uint32_t caca_utf8_to_utf32(char const *, size_t *)
Convert a UTF-8 character to UTF-32.
Definition: charset.c:112
caca_conio_textmode
__extern void caca_conio_textmode(int newmode)
DOS conio.h textmode() equivalent.
Definition: caca_conio.c:489
caca_get_font_blocks
__extern uint32_t const * caca_get_font_blocks(caca_font_t const *)
Get a font's list of supported glyphs.
Definition: font.c:364
CACA_KEY_DOWN
@ CACA_KEY_DOWN
Definition: caca.h:198
caca_canvas_t
struct caca_canvas caca_canvas_t
Definition: caca.h:49
caca_fill_triangle_textured
__extern int caca_fill_triangle_textured(caca_canvas_t *cv, int coords[6], caca_canvas_t *tex, float uv[6])
Fill a triangle on the canvas using an arbitrary-sized texture.
Definition: triangle.c:361
CACA_KEY_CTRL_C
@ CACA_KEY_CTRL_C
Definition: caca.h:168
caca_conio_textattr
__extern void caca_conio_textattr(int newattr)
DOS conio.h textattr() equivalent.
Definition: caca_conio.c:463
CACA_KEY_ESCAPE
@ CACA_KEY_ESCAPE
Definition: caca.h:192
CACA_KEY_F2
@ CACA_KEY_F2
Definition: caca.h:209
caca_conio_printf
__extern int caca_conio_printf(const char *format,...)
DOS stdio.h printf() equivalent.
Definition: caca_conio.c:371
caca_conio_cputs
__extern int caca_conio_cputs(const char *str)
DOS conio.h cputs() equivalent.
Definition: caca_conio.c:119
CACA_KEY_PAUSE
@ CACA_KEY_PAUSE
Definition: caca.h:184
caca_fill_box
int caca_fill_box(caca_canvas_t *cv, int x, int y, int w, int h, uint32_t ch)
Fill a box on the canvas using the given character.
Definition: box.c:109
caca_put_attr
int caca_put_attr(caca_canvas_t *cv, int x, int y, uint32_t attr)
Set the character attribute at the given coordinates.
Definition: attr.c:182
caca_get_frame_count
__extern int caca_get_frame_count(caca_canvas_t const *)
Get the number of frames in a canvas.
Definition: frame.c:37
CACA_KEY_BACKSPACE
@ CACA_KEY_BACKSPACE
Definition: caca.h:173
caca_conio_sound
__extern void caca_conio_sound(unsigned int)
DOS dos.h sound() equivalent.
Definition: caca_conio.c:455
caca_attr_to_rgb12_bg
uint16_t caca_attr_to_rgb12_bg(uint32_t attr)
Get 12-bit RGB background information from attribute.
Definition: attr.c:398
CACA_GREEN
@ CACA_GREEN
Definition: caca.h:73
caca_get_event_key_utf8
__extern int caca_get_event_key_utf8(caca_event_t const *, char *)
Return a key press or key release event's UTF-8 value.
Definition: event.c:256
caca_load_font
__extern caca_font_t * caca_load_font(void const *, size_t)
Load a font from memory for future use.
Definition: font.c:111
CACA_BROWN
@ CACA_BROWN
Definition: caca.h:77
CACA_KEY_CTRL_X
@ CACA_KEY_CTRL_X
Definition: caca.h:189
caca_set_display_time
__extern int caca_set_display_time(caca_display_t *, int)
Set the refresh delay.
Definition: graphics.c:100
caca_attr_to_ansi
uint8_t caca_attr_to_ansi(uint32_t attr)
Get DOS ANSI information from attribute.
Definition: attr.c:303
caca_get_font_width
__extern int caca_get_font_width(caca_font_t const *)
Get a font's standard glyph width.
Definition: font.c:324
caca_get_dirty_rect_count
__extern int caca_get_dirty_rect_count(caca_canvas_t *)
Get the number of dirty rectangles in the canvas.
Definition: dirty.c:98
CACA_KEY_CTRL_O
@ CACA_KEY_CTRL_O
Definition: caca.h:180
caca_conio_getpass
__extern char * caca_conio_getpass(const char *prompt)
DOS conio.h getpass() equivalent.
Definition: caca_conio.c:223
caca_get_event
__extern int caca_get_event(caca_display_t *, int, caca_event_t *, int)
Get the next mouse or keyboard input event.
Definition: event.c:63
caca_conio_putch
__extern int caca_conio_putch(int ch)
DOS conio.h putch() equivalent.
Definition: caca_conio.c:390
caca_get_dither_charset
__extern char const * caca_get_dither_charset(caca_dither_t const *)
Get current character set.
Definition: dither.c:803
caca_conio_cprintf
__extern int caca_conio_cprintf(const char *format,...)
DOS conio.h cprintf() equivalent.
Definition: caca_conio.c:99
CACA_RED
@ CACA_RED
Definition: caca.h:75
caca_flip
__extern int caca_flip(caca_canvas_t *)
Flip a canvas horizontally.
Definition: transform.c:73
caca_get_dither_contrast
__extern float caca_get_dither_contrast(caca_dither_t const *)
Get the contrast of a dither object.
Definition: dither.c:523
caca_invert
__extern int caca_invert(caca_canvas_t *)
Invert a canvas' colours.
Definition: transform.c:44
CACA_KEY_RETURN
@ CACA_KEY_RETURN
Definition: caca.h:178
caca_rotate_left
__extern int caca_rotate_left(caca_canvas_t *)
Rotate a canvas, 90 degrees counterclockwise.
Definition: transform.c:255
caca_put_str
__extern int caca_put_str(caca_canvas_t *, int, int, char const *)
Print a string.
Definition: string.c:254
caca_conio_text_info::winright
unsigned char winright
Definition: caca.h:612
caca_display_t
struct caca_display caca_display_t
Definition: caca.h:59
caca_color
caca_color
Definition: caca.h:70
caca_conio_highvideo
__extern void caca_conio_highvideo(void)
DOS conio.h highvideo() equivalent.
Definition: caca_conio.c:274
caca_set_display_driver
int caca_set_display_driver(caca_display_t *dp, char const *driver)
Set the output driver.
Definition: caca/caca.c:212
caca_conio_delline
__extern void caca_conio_delline(void)
DOS conio.h delline() equivalent.
Definition: caca_conio.c:172
CACA_KEY_CTRL_T
@ CACA_KEY_CTRL_T
Definition: caca.h:185
CACA_DEFAULT
@ CACA_DEFAULT
Definition: caca.h:87
CACA_KEY_F15
@ CACA_KEY_F15
Definition: caca.h:222
caca_conio_normvideo
__extern void caca_conio_normvideo(void)
DOS conio.h normvideo() equivalent.
Definition: caca_conio.c:355
CACA_KEY_END
@ CACA_KEY_END
Definition: caca.h:204
CACA_UNDERLINE
@ CACA_UNDERLINE
Definition: caca.h:96
CACA_LIGHTCYAN
@ CACA_LIGHTCYAN
Definition: caca.h:82
caca_conio__setcursortype
__extern void caca_conio__setcursortype(int cur_t)
DOS conio.h _setcursortype() equivalent.
Definition: caca_conio.c:412
caca_utf32_to_utf8
__extern size_t caca_utf32_to_utf8(char *, uint32_t)
Convert a UTF-32 character to UTF-8.
Definition: charset.c:151
caca_get_display_time
__extern int caca_get_display_time(caca_display_t const *)
Get the display's average rendering time.
Definition: graphics.c:125
caca_font_t
struct caca_font caca_font_t
Definition: caca.h:55
caca_get_dither_color
__extern char const * caca_get_dither_color(caca_dither_t const *)
Get current colour mode.
Definition: dither.c:714
CACA_KEY_TAB
@ CACA_KEY_TAB
Definition: caca.h:174
caca_create_dither
__extern caca_dither_t * caca_create_dither(int, int, int, int, uint32_t, uint32_t, uint32_t, uint32_t)
Create an internal dither object.
Definition: dither.c:261
caca_get_dither_antialias
__extern char const * caca_get_dither_antialias(caca_dither_t const *)
Get current antialiasing method.
Definition: dither.c:600
caca_get_display_height
__extern int caca_get_display_height(caca_display_t const *)
Get the display height.
Definition: graphics.c:79
caca_set_figfont_smush
__extern int caca_set_figfont_smush(caca_canvas_t *, char const *)
set the smushing mode of the figfont rendering
Definition: figfont.c:117
caca_get_canvas_handle_x
__extern int caca_get_canvas_handle_x(caca_canvas_t const *)
Get X handle position.
Definition: string.c:420
caca_utf32_is_fullwidth
__extern int caca_utf32_is_fullwidth(uint32_t)
Tell whether a UTF-32 character is fullwidth.
Definition: charset.c:388
caca_conio_window
__extern void caca_conio_window(int left, int top, int right, int bottom)
DOS conio.h window() equivalent.
Definition: caca_conio.c:526
caca_get_display_width
__extern int caca_get_display_width(caca_display_t const *)
Get the display width.
Definition: graphics.c:62
CACA_KEY_UNKNOWN
@ CACA_KEY_UNKNOWN
Definition: caca.h:163
caca_conio_textcolor
__extern void caca_conio_textcolor(int newcolor)
DOS conio.h textcolor() equivalent.
Definition: caca_conio.c:480
CACA_BLUE
@ CACA_BLUE
Definition: caca.h:72
CACA_KEY_F7
@ CACA_KEY_F7
Definition: caca.h:214
caca_key
caca_key
Special key values.
Definition: caca.h:162
CACA_KEY_F10
@ CACA_KEY_F10
Definition: caca.h:217
CACA_KEY_CTRL_R
@ CACA_KEY_CTRL_R
Definition: caca.h:183
caca_get_mouse_x
__extern int caca_get_mouse_x(caca_display_t const *)
Return the X mouse coordinate.
Definition: event.c:148
CACA_KEY_CTRL_B
@ CACA_KEY_CTRL_B
Definition: caca.h:167
caca_manage_canvas
__extern int caca_manage_canvas(caca_canvas_t *, int(*)(void *), void *)
Manage a canvas.
Definition: canvas.c:133
caca_conio_text_info::winbottom
unsigned char winbottom
Definition: caca.h:613
caca_disable_dirty_rect
__extern int caca_disable_dirty_rect(caca_canvas_t *)
Disable dirty rectangles.
Definition: dirty.c:51
CACA_BLACK
@ CACA_BLACK
Definition: caca.h:71
CACA_KEY_CTRL_N
@ CACA_KEY_CTRL_N
Definition: caca.h:179
caca_conio_directvideo
__extern int caca_conio_directvideo
DOS direct video control.
Definition: caca.h:625
caca_dither_t
struct caca_dither caca_dither_t
Definition: caca.h:51
caca_conio__wscroll
__extern int caca_conio__wscroll
DOS scrolling control.
Definition: caca.h:628
CACA_DARKGRAY
@ CACA_DARKGRAY
Definition: caca.h:79
caca_get_font_list
__extern char const *const * caca_get_font_list(void)
Get available builtin fonts.
Definition: font.c:302
caca_attr_to_ansi_fg
uint8_t caca_attr_to_ansi_fg(uint32_t attr)
Get ANSI foreground information from attribute.
Definition: attr.c:327
caca_conio_nosound
__extern void caca_conio_nosound(void)
DOS dos.h nosound() equivalent.
Definition: caca_conio.c:363
caca_draw_ellipse
__extern int caca_draw_ellipse(caca_canvas_t *, int, int, int, int, uint32_t)
Draw an ellipse on the canvas using the given character.
Definition: conic.c:128
caca_set_attr
int caca_set_attr(caca_canvas_t *cv, uint32_t attr)
Set the default character attribute.
Definition: attr.c:97
caca_free_canvas
__extern int caca_free_canvas(caca_canvas_t *)
Free a libcaca canvas.
Definition: canvas.c:308
caca_set_canvas_handle
__extern int caca_set_canvas_handle(caca_canvas_t *, int, int)
Set cursor handle.
Definition: string.c:403
CACA_KEY_F9
@ CACA_KEY_F9
Definition: caca.h:216
caca_set_dither_color
__extern int caca_set_dither_color(caca_dither_t *, char const *)
Choose colours used for dithering.
Definition: dither.c:628
caca_get_attr
uint32_t caca_get_attr(caca_canvas_t const *cv, int x, int y)
Get the text attribute at the given coordinates.
Definition: attr.c:66
caca_unmanage_canvas
__extern int caca_unmanage_canvas(caca_canvas_t *, int(*)(void *), void *)
unmanage a canvas.
Definition: canvas.c:167
caca_get_dirty_rect
__extern int caca_get_dirty_rect(caca_canvas_t *, int, int *, int *, int *, int *)
Get a canvas's dirty rectangle.
Definition: dirty.c:125
CACA_EVENT_ANY
@ CACA_EVENT_ANY
Definition: caca.h:119
CACA_KEY_F1
@ CACA_KEY_F1
Definition: caca.h:208
caca_get_dither_gamma
__extern float caca_get_dither_gamma(caca_dither_t const *)
Get the gamma of a dither object.
Definition: dither.c:490
caca_conio_movetext
__extern int caca_conio_movetext(int left, int top, int right, int bottom, int destleft, int desttop)
DOS conio.h movetext() equivalent.
Definition: caca_conio.c:332
caca_file_open
__extern caca_file_t * caca_file_open(char const *, const char *)
Open a file for reading or writing.
Definition: file.c:64
CACA_KEY_CTRL_Q
@ CACA_KEY_CTRL_Q
Definition: caca.h:182
CACA_KEY_CTRL_K
@ CACA_KEY_CTRL_K
Definition: caca.h:176
CACA_LIGHTMAGENTA
@ CACA_LIGHTMAGENTA
Definition: caca.h:84
caca_conio_textbackground
__extern void caca_conio_textbackground(int newcolor)
DOS conio.h textbackground() equivalent.
Definition: caca_conio.c:471
caca_dither_bitmap
__extern int caca_dither_bitmap(caca_canvas_t *, int, int, int, int, caca_dither_t const *, void const *)
Dither a bitmap on the canvas.
Definition: dither.c:940
CACA_KEY_CTRL_E
@ CACA_KEY_CTRL_E
Definition: caca.h:170
caca_get_dither_brightness
__extern float caca_get_dither_brightness(caca_dither_t const *)
Get the brightness of a dither object.
Definition: dither.c:438
caca_draw_circle
__extern int caca_draw_circle(caca_canvas_t *, int, int, int, uint32_t)
Draw a circle on the canvas using the given character.
Definition: conic.c:40
caca_wherey
__extern int caca_wherey(caca_canvas_t const *)
Get Y cursor position.
Definition: string.c:89
caca_draw_cp437_box
int caca_draw_cp437_box(caca_canvas_t *cv, int x, int y, int w, int h)
Draw a box on the canvas using CP437 characters.
Definition: box.c:86
caca_get_version
char const * caca_get_version(void)
Return the libcaca version.
Definition: caca/caca.c:272
caca.h
The libcaca public header.
caca_conio_text_info::wintop
unsigned char wintop
Definition: caca.h:611
caca_get_event_type
__extern enum caca_event_type caca_get_event_type(caca_event_t const *)
Return an event's type.
Definition: event.c:202
caca_get_dither_antialias_list
__extern char const *const * caca_get_dither_antialias_list(caca_dither_t const *)
Get available antialiasing methods.
Definition: dither.c:579
caca_add_dirty_rect
__extern int caca_add_dirty_rect(caca_canvas_t *, int, int, int, int)
Add an area to the canvas's dirty rectangle list.
Definition: dirty.c:164
caca_conio_wherex
__extern int caca_conio_wherex(void)
DOS conio.h wherex() equivalent.
Definition: caca_conio.c:510
caca_free_dither
__extern int caca_free_dither(caca_dither_t *)
Free the memory associated with a dither.
Definition: dither.c:1209
caca_conio_gettext
__extern int caca_conio_gettext(int left, int top, int right, int bottom, void *destin)
DOS conio.h gettext() equivalent.
Definition: caca_conio.c:246
caca_conio_gettextinfo
__extern void caca_conio_gettextinfo(struct caca_conio_text_info *r)
DOS conio.h gettextinfo() equivalent.
Definition: caca_conio.c:256
caca_conio_wherey
__extern int caca_conio_wherey(void)
DOS conio.h wherey() equivalent.
Definition: caca_conio.c:518
CACA_KEY_CTRL_W
@ CACA_KEY_CTRL_W
Definition: caca.h:188
CACA_KEY_CTRL_J
@ CACA_KEY_CTRL_J
Definition: caca.h:175
caca_create_display_with_driver
caca_display_t * caca_create_display_with_driver(caca_canvas_t *cv, char const *driver)
Attach a specific caca graphical context to a caca canvas.
Definition: caca/caca.c:98
caca_enable_dirty_rect
__extern int caca_enable_dirty_rect(caca_canvas_t *)
Enable dirty rectangles.
Definition: dirty.c:69
caca_free_frame
__extern int caca_free_frame(caca_canvas_t *, int)
Remove a frame from a canvas.
Definition: frame.c:205
CACA_KEY_F12
@ CACA_KEY_F12
Definition: caca.h:219
caca_set_frame_name
__extern int caca_set_frame_name(caca_canvas_t *, char const *)
Set the current frame's name.
Definition: frame.c:108
caca_conio_cgets
__extern char * caca_conio_cgets(char *str)
DOS conio.h cgets() equivalent.
Definition: caca_conio.c:47
caca_toggle_attr
int caca_toggle_attr(caca_canvas_t *cv, uint32_t attr)
Toggle flags in the default character attribute.
Definition: attr.c:154
caca_export_area_to_memory
__extern void * caca_export_area_to_memory(caca_canvas_t const *, int, int, int, int, char const *, size_t *)
Export a canvas portion into a foreign format.
Definition: export.c:145
CACA_KEY_HOME
@ CACA_KEY_HOME
Definition: caca.h:203
caca_canvas_set_figfont
__extern int caca_canvas_set_figfont(caca_canvas_t *, char const *)
load a figfont and attach it to a canvas
Definition: figfont.c:60
caca_set_figfont_width
__extern int caca_set_figfont_width(caca_canvas_t *, int)
set the width of the figfont rendering
Definition: figfont.c:102
CACA_MAGIC_FULLWIDTH
#define CACA_MAGIC_FULLWIDTH
Definition: caca.h:250
caca_set_display_title
__extern int caca_set_display_title(caca_display_t *, char const *)
Set the display title.
Definition: graphics.c:40
CACA_KEY_PAGEDOWN
@ CACA_KEY_PAGEDOWN
Definition: caca.h:206
caca_draw_line
__extern int caca_draw_line(caca_canvas_t *, int, int, int, int, uint32_t)
Draw a line on the canvas using the given character.
Definition: line.c:54
caca_gotoxy
__extern int caca_gotoxy(caca_canvas_t *, int, int)
Set cursor position.
Definition: string.c:58
caca_get_dither_algorithm
__extern char const * caca_get_dither_algorithm(caca_dither_t const *)
Get current dithering algorithm.
Definition: dither.c:919
caca_set_canvas_size
__extern int caca_set_canvas_size(caca_canvas_t *, int, int)
Resize a canvas.
Definition: canvas.c:212
CACA_KEY_RIGHT
@ CACA_KEY_RIGHT
Definition: caca.h:200
CACA_KEY_UP
@ CACA_KEY_UP
Definition: caca.h:197
CACA_CONIO_COLORS
CACA_CONIO_COLORS
DOS colours.
Definition: caca.h:555
caca_set_dither_gamma
__extern int caca_set_dither_gamma(caca_dither_t *, float)
Set the gamma of a dither object.
Definition: dither.c:455
caca_put_char
__extern int caca_put_char(caca_canvas_t *, int, int, uint32_t)
Print an ASCII or Unicode character.
Definition: string.c:120
caca_get_event_key_ch
__extern int caca_get_event_key_ch(caca_event_t const *)
Return a key press or key release event's value.
Definition: event.c:219
caca_stretch_left
__extern int caca_stretch_left(caca_canvas_t *)
Rotate and stretch a canvas, 90 degrees counterclockwise.
Definition: transform.c:493
caca_attr_to_rgb12_fg
uint16_t caca_attr_to_rgb12_fg(uint32_t attr)
Get 12-bit RGB foreground information from attribute.
Definition: attr.c:367
caca_create_frame
__extern int caca_create_frame(caca_canvas_t *, int)
Add a frame to a canvas.
Definition: frame.c:145
CACA_KEY_PAGEUP
@ CACA_KEY_PAGEUP
Definition: caca.h:205
caca_draw_thin_polyline
__extern int caca_draw_thin_polyline(caca_canvas_t *, int const x[], int const y[], int)
Draw an ASCII art thin polyline.
Definition: line.c:144
caca_conio_text_info::currmode
unsigned char currmode
Definition: caca.h:616
caca_vprintf
__extern int caca_vprintf(caca_canvas_t *, int, int, char const *, va_list)
Print a formated string (va_list version).
Definition: string.c:335
caca_event::data
union caca_event::@0 data
caca_get_canvas_handle_y
__extern int caca_get_canvas_handle_y(caca_canvas_t const *)
Get Y handle position.
Definition: string.c:434
CACA_BOLD
@ CACA_BOLD
Definition: caca.h:94
caca_rotate_right
__extern int caca_rotate_right(caca_canvas_t *)
Rotate a canvas, 90 degrees counterclockwise.
Definition: transform.c:375
CACA_KEY_CTRL_F
@ CACA_KEY_CTRL_F
Definition: caca.h:171
caca_draw_polyline
__extern int caca_draw_polyline(caca_canvas_t *, int const x[], int const y[], int, uint32_t)
Draw a polyline.
Definition: line.c:85
caca_conio_getch
__extern int caca_conio_getch(void)
DOS conio.h getch() equivalent.
Definition: caca_conio.c:180
caca_get_font_height
__extern int caca_get_font_height(caca_font_t const *)
Get a font's standard glyph height.
Definition: font.c:339
CACA_LIGHTRED
@ CACA_LIGHTRED
Definition: caca.h:83
caca_set_dither_palette
__extern int caca_set_dither_palette(caca_dither_t *, uint32_t r[], uint32_t g[], uint32_t b[], uint32_t a[])
Set the palette of an 8bpp dither object.
Definition: dither.c:372
caca_set_dither_charset
__extern int caca_set_dither_charset(caca_dither_t *, char const *)
Choose characters used for dithering.
Definition: dither.c:739
CACA_YELLOW
@ CACA_YELLOW
Definition: caca.h:85
caca_stretch_right
__extern int caca_stretch_right(caca_canvas_t *)
Rotate and stretch a canvas, 90 degrees clockwise.
Definition: transform.c:586
caca_event::type
enum caca_event_type type
Definition: caca.h:131
CACA_MAGENTA
@ CACA_MAGENTA
Definition: caca.h:76
CACA_KEY_LEFT
@ CACA_KEY_LEFT
Definition: caca.h:199
CACA_KEY_F3
@ CACA_KEY_F3
Definition: caca.h:210
caca_clear_canvas
__extern int caca_clear_canvas(caca_canvas_t *)
Clear the canvas.
Definition: string.c:374
caca_set_dither_antialias
__extern int caca_set_dither_antialias(caca_dither_t *, char const *)
Set dither antialiasing.
Definition: dither.c:544
caca_attr_to_ansi_bg
uint8_t caca_attr_to_ansi_bg(uint32_t attr)
Get ANSI background information from attribute.
Definition: attr.c:347
caca_get_import_list
__extern char const *const * caca_get_import_list(void)
Get available import formats.
Definition: import.c:276
caca_get_event_resize_width
__extern int caca_get_event_resize_width(caca_event_t const *)
Return a resize event's display width value.
Definition: event.c:324
caca_get_display_driver_list
char const *const * caca_get_display_driver_list(void)
Get available display drivers.
Definition: caca/caca.c:149
caca_draw_thin_ellipse
__extern int caca_draw_thin_ellipse(caca_canvas_t *, int, int, int, int)
Draw a thin ellipse on the canvas.
Definition: conic.c:184
caca_flush_figlet
__extern int caca_flush_figlet(caca_canvas_t *)
flush the figlet context
Definition: figfont.c:267
caca_remove_dirty_rect
__extern int caca_remove_dirty_rect(caca_canvas_t *, int, int, int, int)
Remove an area from the dirty rectangle list.
Definition: dirty.c:219
CACA_KEY_CTRL_Z
@ CACA_KEY_CTRL_Z
Definition: caca.h:191
CACA_KEY_F11
@ CACA_KEY_F11
Definition: caca.h:218
caca_file_read
__extern size_t caca_file_read(caca_file_t *, void *, size_t)
Read data from a file handle.
Definition: file.c:199