Functions | |
__extern caca_canvas_t * | caca_create_canvas (int, int) |
Initialise a libcaca canvas. | |
__extern int | caca_manage_canvas (caca_canvas_t *, int(*)(void *), void *) |
Manage a canvas. | |
__extern int | caca_unmanage_canvas (caca_canvas_t *, int(*)(void *), void *) |
unmanage a canvas. | |
__extern int | caca_set_canvas_size (caca_canvas_t *, int, int) |
Resize a canvas. | |
__extern int | caca_get_canvas_width (caca_canvas_t const *) |
Get the canvas width. | |
__extern int | caca_get_canvas_height (caca_canvas_t const *) |
Get the canvas height. | |
__extern uint32_t const * | caca_get_canvas_chars (caca_canvas_t const *) |
Get the canvas character array. | |
__extern uint32_t const * | caca_get_canvas_attrs (caca_canvas_t const *) |
Get the canvas attribute array. | |
__extern int | caca_free_canvas (caca_canvas_t *) |
Free a libcaca canvas. | |
__extern int | caca_rand (int, int) |
Generate a random integer within a range. | |
__extern char const * | caca_get_version (void) |
Return the libcaca version. |
|
Initialise internal libcaca structures and the backend that will be used for subsequent graphical operations. It must be the first libcaca function to be called in a function. caca_free_canvas() should be called at the end of the program to free all allocated resources. Both the cursor and the canvas' handle are initialised at the top-left corner. If an error occurs, NULL is returned and errno is set accordingly:
|
|
Lock a canvas to prevent it from being resized. If non-NULL, the callback function pointer will be called upon each caca_set_canvas_size call and if the returned value is zero, the canvas resize request will be denied. This function is only useful for display drivers such as the libcaca library. If an error occurs, -1 is returned and errno is set accordingly:
|
|
unlock a canvas previously locked by caca_manage_canvas(). for safety reasons, the callback and callback data arguments must be the same as for the caca_manage_canvas() call. this function is only useful for display drivers such as the libcaca library. if an error occurs, -1 is returned and errno is set accordingly:
|
|
Set the canvas' width and height, in character cells. The contents of the canvas are preserved to the extent of the new canvas size. Newly allocated character cells at the right and/or at the bottom of the canvas are filled with spaces. If as a result of the resize the cursor coordinates fall outside the new canvas boundaries, they are readjusted. For instance, if the current X cursor coordinate is 11 and the requested width is 10, the new X cursor coordinate will be 10. It is an error to try to resize the canvas if an output driver has been attached to the canvas using caca_create_display(). You need to remove the output driver using caca_free_display() before you can change the canvas size again. However, the caca output driver can cause a canvas resize through user interaction. See the caca_event() documentation for more about this. If an error occurs, -1 is returned and errno is set accordingly:
|
|
Return the current canvas' width, in character cells. This function never fails.
|
|
Returns the current canvas' height, in character cells. This function never fails.
|
|
Return the current canvas' internal character array. The array elements consist in native endian 32-bit Unicode values as returned by caca_get_char(). This function is probably only useful for libcaca 's internal display drivers. This function never fails.
|
|
Returns the current canvas' internal attribute array. The array elements consist in native endian 32-bit attribute values as returned by caca_get_attr(). This function is probably only useful for libcaca 's internal display drivers. This function never fails.
|
|
Free all resources allocated by caca_create_canvas(). The canvas pointer becomes invalid and must no longer be used unless a new call to caca_create_canvas() is made. If an error occurs, -1 is returned and errno is set accordingly:
|
|
Generate a random integer within the given range. This function never fails.
|
|
Return a read-only string with the libcaca version information. This function never fails.
|