Scroll to navigation

caca_attr(3caca) libcaca caca_attr(3caca)

NAME

caca_attr - libcaca attribute definitions

SYNOPSIS

Modules


libcaca basic functions

Data Structures


struct caca_event
Handling of user events. struct caca_option
Option parsing.

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

Detailed Description

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

Enumeration Type Documentation

enum caca_color

libcaca colour keyword

Enumerator

The colour index for black.
The colour index for blue.
The colour index for green.
The colour index for cyan.
The colour index for red.
The colour index for magenta.
The colour index for brown.
The colour index for light gray.
The colour index for dark gray.
The colour index for blue.
The colour index for light green.
The colour index for light cyan.
The colour index for light red.
The colour index for light magenta.
The colour index for yellow.
The colour index for white.
The output driver's default colour.
The transparent colour.

enum caca_style

libcaca style keyword

Enumerator

The style mask for bold.
The style mask for italics.
The style mask for underline.
The style mask for blink.

enum caca_event_type

This enum serves two purposes:

  • Build listening masks for caca_get_event().
  • Define the type of a caca_event_t.

Enumerator

No event.
A key was pressed.
A key was released.
A mouse button was pressed.
A mouse button was released.
The mouse was moved.
The window was resized.
The user requested to quit.
Bitmask for any event.

enum caca_key

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

Enumerator

Unknown key.
The Ctrl-A key.
The Ctrl-B key.
The Ctrl-C key.
The Ctrl-D key.
The Ctrl-E key.
The Ctrl-F key.
The Ctrl-G key.
The backspace key.
The tabulation key.
The Ctrl-J key.
The Ctrl-K key.
The Ctrl-L key.
The return key.
The Ctrl-N key.
The Ctrl-O key.
The Ctrl-P key.
The Ctrl-Q key.
The Ctrl-R key.
The pause key.
The Ctrl-T key.
The Ctrl-U key.
The Ctrl-V key.
The Ctrl-W key.
The Ctrl-X key.
The Ctrl-Y key.
The Ctrl-Z key.
The escape key.
The delete key.
The up arrow key.
The down arrow key.
The left arrow key.
The right arrow key.
The insert key.
The home key.
The end key.
The page up key.
The page down key.
The F1 key.
The F2 key.
The F3 key.
The F4 key.
The F5 key.
The F6 key.
The F7 key.
The F8 key.
The F9 key.
The F10 key.
The F11 key.
The F12 key.
The F13 key.
The F14 key.
The F15 key.

Author

Generated automatically by Doxygen for libcaca from the source code.

Tue Jul 12 2022 Version 0.99.beta20