libcaca-migrating.3caca - Man Page

• caca_init(): use caca_create_canvas() to create a libcaca canvas, followed by caca_create_display() to attach a libcaca display to it. Alternatively, caca_create_display() with a NULL argument will create a canvas automatically.
• caca_set_delay(): use caca_set_display_time().
• caca_get_feature(): deprecated.
• caca_set_feature(): deprecated, see caca_set_dither_antialias(), caca_set_dither_color() and caca_set_dither_mode() instead.
• caca_get_feature_name(): deprecated, see caca_get_dither_mode_list(), caca_get_dither_antialias_list() and caca_get_dither_color_list() instead.
• caca_get_rendertime(): use caca_get_display_time().
• caca_get_width(): use caca_get_canvas_width().
• caca_get_height(): use caca_get_canvas_height().
• caca_set_window_title(): use caca_set_display_title().
• caca_get_window_width(): use caca_get_display_width().
• caca_get_window_height(): use caca_get_display_height().
• caca_refresh(): use caca_refresh_display().
• caca_end(): use caca_free_display() to detach the libcaca display, followed by caca_free_canvas() to free the underlying libcaca canvas. Alternatively, if the canvas was created by caca_create_display(), it will be automatically destroyed by caca_free_display().

• caca_get_event(): unchanged, but the event information retrieval changed a lot.
• caca_wait_event(): use caca_get_event() with a timeout argument of -1.
• caca_get_mouse_x(): unchanged.
• caca_get_mouse_y(): unchanged.

• caca_set_color(): use caca_set_color_ansi() or caca_set_color_argb().
• caca_get_fg_color(): use caca_get_attr().
• caca_get_bg_color(): use caca_get_attr().
• caca_get_color_name(): this function is now deprecated due to major uselessness.
• caca_putchar(): use caca_put_char().
• caca_putstr(): use caca_put_str().
• caca_printf(): unchanged.
• caca_clear(): use caca_clear_canvas().

These functions are almost unchanged, except for Unicode support and the fact that they now act on a given canvas.

• caca_draw_line(): unchanged.
• caca_draw_polyline(): unchanged.
• caca_draw_thin_line(): unchanged.
• caca_draw_thin_polyline(): unchanged.
• caca_draw_circle(): unchanged.
• caca_draw_ellipse(): unchanged.
• caca_draw_thin_ellipse(): unchanged.
• caca_fill_ellipse(): unchanged.
• caca_draw_box(): unchanged, but the argument meaning changed (width and height instead of corner coordinates).
• caca_draw_thin_box(): use caca_draw_thin_box() or caca_draw_cp437_box(), also the argument meaning changed (width and height instead of corner coordinates).
• caca_fill_box(): unchanged, but the argument meaning changed (width and height instead of corner coordinates).
• caca_draw_triangle(): unchanged.
• caca_draw_thin_triangle(): unchanged.
• caca_fill_triangle(): unchanged.

• caca_rand(): unchanged, but the second argument is different, make sure you take that into account.
• caca_sqrt(): this function is now deprecated, use your system's sqrt() call instead.

The newly introduced canvases can have several frames. Sprites are hence completely deprecated.

• caca_load_sprite(): use caca_import_file().
• caca_get_sprite_frames(): use caca_get_frame_count().
• caca_get_sprite_width(): use caca_get_canvas_width().
• caca_get_sprite_height(): use caca_get_canvas_height().
• caca_get_sprite_dx(): use caca_get_canvas_handle_x().
• caca_get_sprite_dy(): use caca_get_canvas_handle_y().
• caca_draw_sprite(): use caca_set_frame() and caca_blit().
• caca_free_sprite(): use caca_free_canvas().

Bitmaps have been renamed to dithers, because these objects do not in fact store any pixels, they just have information on how bitmaps will be dithered.

• caca_create_bitmap(): use caca_create_dither().
• caca_set_bitmap_palette(): use caca_set_dither_palette().
• caca_draw_bitmap(): use caca_dither_bitmap().
• caca_free_bitmap(): use caca_free_dither().