Changeset 1016


Ignore:
Timestamp:
Sep 9, 2006, 7:02:30 PM (14 years ago)
Author:
Sam Hocevar
Message:
  • Updated the migration documentation so that it mentions the <caca0.h> compatibility layer.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • libcaca/trunk/doc/migrating.dox

    r849 r1016  
    7878   drawing and text handling functions start with \b cucul_ .
    7979
    80  \section foo2 Function equivalence list
     80 \section foo2 Migration strategy
     81
     82 You have two ways to migrate your application to use \e libcaca 1.x:
     83
     84 - Port your code using the function equivalence list. This is the preferred
     85   way because new functions are thread safe and offer much more features
     86   to both the programmer and the end user.
     87 - Use the legacy compatibility layer.
     88
     89 Using the compatibility layer is as easy as adding the following three lines:
     90
     91<table border="0"><tr><td valign="top">
     92\code
     93#include <caca.h>
     94
     95/* libcaca program - 0.x API */
     96...
     97\endcode
     98</td><td>
     99\code
     100#include <caca.h>
     101#ifndef CACA_API_VERSION_1
     102#   include <caca0.h>
     103#endif
     104
     105/* libcaca program - 0.x API */
     106...
     107\endcode
     108</td></tr></table>
     109
     110 \section foo3 Function equivalence list
    81111
    82112 \subsection bar1 Basic functions
     
    84114 - \b caca_init(): use cucul_create_canvas() to create a \e libcucul canvas,
    85115   followed by caca_create_display() to attach a \e libcaca display to it.
    86  - \b caca_set_delay(): unchanged.
     116 - \b caca_set_delay(): use caca_set_display_time().
    87117 - \b caca_get_feature(): deprecated.
    88118 - \b caca_set_feature(): deprecated, see cucul_set_dither_antialias(),
     
    91121   cucul_get_dither_antialias_list() and cucul_get_dither_color_list()
    92122   instead.
    93  - \b caca_get_rendertime(): unchanged.
     123 - \b caca_get_rendertime(): use caca_get_display_time().
    94124 - \b caca_get_width(): use cucul_get_canvas_width().
    95125 - \b caca_get_height(): use cucul_get_canvas_height().
     
    175205 - \b caca_free_bitmap(): use cucul_free_dither().
    176206
    177  \section foo3 Compilation
     207 \section foo4 Compilation
    178208
    179209 The \c caca-config utility is deprecated in favour of the standard
Note: See TracChangeset for help on using the changeset viewer.