caca_attr

Section: libcaca (3caca)
Updated: Tue Jan 26 2021
Page Index

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

CACA_BLACK: The colour index for black.
CACA_BLUE: The colour index for blue.
CACA_GREEN: The colour index for green.
CACA_CYAN: The colour index for cyan.
CACA_RED: The colour index for red.
CACA_MAGENTA: The colour index for magenta.
CACA_BROWN: The colour index for brown.
CACA_LIGHTGRAY: The colour index for light gray.
CACA_DARKGRAY: The colour index for dark gray.
CACA_LIGHTBLUE: The colour index for blue.
CACA_LIGHTGREEN: The colour index for light green.
CACA_LIGHTCYAN: The colour index for light cyan.
CACA_LIGHTRED: The colour index for light red.
CACA_LIGHTMAGENTA: The colour index for light magenta.
CACA_YELLOW: The colour index for yellow.
CACA_WHITE: The colour index for white.
CACA_DEFAULT: The output driver's default colour.
CACA_TRANSPARENT: The transparent colour.

enum caca_style

libcaca style keyword

Enumerator

CACA_BOLD: The style mask for bold.
CACA_ITALICS: The style mask for italics.
CACA_UNDERLINE: The style mask for underline.
CACA_BLINK: 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

CACA_EVENT_NONE: No event.
CACA_EVENT_KEY_PRESS: A key was pressed.
CACA_EVENT_KEY_RELEASE: A key was released.
CACA_EVENT_MOUSE_PRESS: A mouse button was pressed.
CACA_EVENT_MOUSE_RELEASE: A mouse button was released.
CACA_EVENT_MOUSE_MOTION: The mouse was moved.
CACA_EVENT_RESIZE: The window was resized.
CACA_EVENT_QUIT: The user requested to quit.
CACA_EVENT_ANY: Bitmask for any event.

enum caca_key

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

Enumerator

CACA_KEY_UNKNOWN: Unknown key.
CACA_KEY_CTRL_A: The Ctrl-A key.
CACA_KEY_CTRL_B: The Ctrl-B key.
CACA_KEY_CTRL_C: The Ctrl-C key.
CACA_KEY_CTRL_D: The Ctrl-D key.
CACA_KEY_CTRL_E: The Ctrl-E key.
CACA_KEY_CTRL_F: The Ctrl-F key.
CACA_KEY_CTRL_G: The Ctrl-G key.
CACA_KEY_BACKSPACE: The backspace key.
CACA_KEY_TAB: The tabulation key.
CACA_KEY_CTRL_J: The Ctrl-J key.
CACA_KEY_CTRL_K: The Ctrl-K key.
CACA_KEY_CTRL_L: The Ctrl-L key.
CACA_KEY_RETURN: The return key.
CACA_KEY_CTRL_N: The Ctrl-N key.
CACA_KEY_CTRL_O: The Ctrl-O key.
CACA_KEY_CTRL_P: The Ctrl-P key.
CACA_KEY_CTRL_Q: The Ctrl-Q key.
CACA_KEY_CTRL_R: The Ctrl-R key.
CACA_KEY_PAUSE: The pause key.
CACA_KEY_CTRL_T: The Ctrl-T key.
CACA_KEY_CTRL_U: The Ctrl-U key.
CACA_KEY_CTRL_V: The Ctrl-V key.
CACA_KEY_CTRL_W: The Ctrl-W key.
CACA_KEY_CTRL_X: The Ctrl-X key.
CACA_KEY_CTRL_Y: The Ctrl-Y key.
CACA_KEY_CTRL_Z: The Ctrl-Z 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.

Author

Generated automatically by Doxygen for libcaca from the source code.