From 239593a0700e158d2242fe3c454be1d67c583d1f Mon Sep 17 00:00:00 2001 From: Sam Hocevar Date: Sun, 2 Aug 2009 11:09:29 +0000 Subject: [PATCH] Add a note about autoreleased canvases in the documentation. --- doc/migrating.dox | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/migrating.dox b/doc/migrating.dox index ad53b2f..87b3776 100644 --- a/doc/migrating.dox +++ b/doc/migrating.dox @@ -112,6 +112,8 @@ int main(void) - \b caca_init(): use caca_create_canvas() to create a \e libcaca canvas, followed by caca_create_display() to attach a \e libcaca display to it. + Alternatively, caca_create_display() with a NULL argument will create a + canvas automatically. - \b caca_set_delay(): use caca_set_display_time(). - \b caca_get_feature(): deprecated. - \b caca_set_feature(): deprecated, see caca_set_dither_antialias(), @@ -128,6 +130,8 @@ int main(void) - \b caca_refresh(): use caca_refresh_display(). - \b caca_end(): use caca_free_display() to detach the \e libcaca display, followed by caca_free_canvas() to free the underlying \e libcaca canvas. + Alternatively, if the canvas was created by caca_create_display(), it + will be automatically destroyed by caca_free_display(). \subsection bar2 Event handling