Defines | |
#define | CUCUL_MAGIC_FULLWIDTH 0x000ffffe |
Functions | |
int | cucul_gotoxy (cucul_canvas_t *, int, int) |
Set cursor position. | |
int | cucul_get_cursor_x (cucul_canvas_t *) |
Get X cursor position. | |
int | cucul_get_cursor_y (cucul_canvas_t *) |
Get Y cursor position. | |
int | cucul_put_char (cucul_canvas_t *, int, int, unsigned long int) |
Print an ASCII or Unicode character. | |
unsigned long int | cucul_get_char (cucul_canvas_t *, int, int) |
Get the Unicode character at the given coordinates. | |
int | cucul_put_str (cucul_canvas_t *, int, int, char const *) |
Print a string. | |
unsigned long int | cucul_get_attr (cucul_canvas_t *, int, int) |
Get the text attribute at the given coordinates. | |
int | cucul_set_attr (cucul_canvas_t *, unsigned long int) |
Set the default character attribute. | |
int | cucul_put_attr (cucul_canvas_t *, int, int, unsigned long int) |
Set the character attribute at the given coordinates. | |
int | cucul_set_color_ansi (cucul_canvas_t *, unsigned char, unsigned char) |
Set the default colour pair for text (ANSI version). | |
int | cucul_set_color_argb (cucul_canvas_t *, unsigned int, unsigned int) |
Set the default colour pair for text (truecolor version). | |
int | cucul_printf (cucul_canvas_t *, int, int, char const *,...) |
Print a formated string. | |
int | cucul_clear_canvas (cucul_canvas_t *) |
Clear the canvas. | |
int | cucul_set_canvas_handle (cucul_canvas_t *, int, int) |
Set cursor handle. | |
int | cucul_get_canvas_handle_x (cucul_canvas_t *) |
Get X handle position. | |
int | cucul_get_canvas_handle_y (cucul_canvas_t *) |
Get Y handle position. | |
int | cucul_blit (cucul_canvas_t *, int, int, cucul_canvas_t const *, cucul_canvas_t const *) |
Blit a canvas onto another one. | |
int | cucul_set_canvas_boundaries (cucul_canvas_t *, int, int, unsigned int, unsigned int) |
Set a canvas' new boundaries. |
|
Used to indicate that the previous character was a fullwidth glyph. |
|
Put the cursor at the given coordinates. Functions making use of the cursor will use the new values. Setting the cursor position outside the canvas is legal but the cursor will not be shown. This function never fails.
|
|
Retrieve the X coordinate of the cursor's position. This function never fails.
|
|
Retrieve the Y coordinate of the cursor's position. This function never fails.
|
|
Print an ASCII or Unicode character at the given coordinates, using the default foreground and background colour values. If the coordinates are outside the canvas boundaries, nothing is printed. If a fullwidth Unicode character gets overwritten, its remaining visible parts are replaced with spaces. If the canvas' boundaries would split the fullwidth character in two, a space is printed instead. The behaviour when printing non-printable characters or invalid UTF-32 characters is undefined. To print a sequence of bytes forming an UTF-8 character instead of an UTF-32 character, use the cucul_put_str() function. This function never fails.
|
|
Get the ASCII or Unicode value of the character at the given coordinates. If the value is less or equal to 127 (0x7f), the character can be printed as ASCII. Otherise, it must be handled as a UTF-32 value. If the coordinates are outside the canvas boundaries, a space (0x20) is returned. A special exception is when CUCUL_MAGIC_FULLWIDTH is returned. This value is guaranteed not to be a valid Unicode character, and indicates that the character at the left of the requested one is a fullwidth character. This function never fails.
|
|
Print an UTF-8 string at the given coordinates, using the default foreground and background values. The coordinates may be outside the canvas boundaries (eg. a negative Y coordinate) and the string will be cropped accordingly if it is too long. See cucul_put_char() for more information on how fullwidth characters are handled when overwriting each other or at the canvas' boundaries. This function never fails.
|
|
Get the internal libcucul attribute value of the character at the given coordinates. The attribute value has 32 significant bits, organised as follows from MSB to LSB:
If the coordinates are outside the canvas boundaries, the current attribute is returned. This function never fails.
|
|
Set the default character attribute for drawing. Attributes define foreground and background colour, transparency, bold, italics and underline styles, as well as blink. String functions such as caca_printf() and graphical primitive functions such as caca_draw_line() will use this attribute. The value of attr is either:
To retrieve the current attribute value, use cucul_get_attr(-1,-1). If an error occurs, -1 is returned and errno is set accordingly:
|
|
Set the character attribute, without changing the character's value. If the character at the given coordinates is a fullwidth character, both cells' attributes are replaced. The value of attr is either:
If an error occurs, -1 is returned and errno is set accordingly:
|
|
Set the default ANSI colour pair for text drawing. String functions such as caca_printf() and graphical primitive functions such as caca_draw_line() will use these attributes. Color values are those defined in cucul.h, such as CUCUL_RED or CUCUL_TRANSPARENT. If an error occurs, 0 is returned and errno is set accordingly:
|
|
Set the default ARGB colour pair for text drawing. String functions such as caca_printf() and graphical primitive functions such as caca_draw_line() will use these attributes. Colors are 16-bit ARGB values, each component being coded on 4 bits. For instance, 0xf088 is solid dark cyan (A=15 R=0 G=8 B=8), and 0x8fff is white with 50% alpha (A=8 R=15 G=15 B=15). If an error occurs, 0 is returned and errno is set accordingly:
|
|
Format a string at the given coordinates, using the default foreground and background values. The coordinates may be outside the canvas boundaries (eg. a negative Y coordinate) and the string will be cropped accordingly if it is too long. The syntax of the format string is the same as for the C printf() function. This function never fails.
|
|
Clear the canvas using the current foreground and background colours. This function never fails.
|
|
Set the canvas' handle. Blitting functions will use the handle value to put the canvas at the proper coordinates. This function never fails.
|
|
Retrieve the X coordinate of the canvas' handle. This function never fails.
|
|
Retrieve the Y coordinate of the canvas' handle. This function never fails.
|
|
Blit a canvas onto another one at the given coordinates. An optional mask canvas can be used. If an error occurs, -1 is returned and errno is set accordingly:
|
|
Set new boundaries for a canvas. This function can be used to crop a canvas, to expand it or for combinations of both actions. All frames are affected by this function. If an error occurs, -1 is returned and errno is set accordingly:
|