[gtpd-cvs] SF.net SVN: gtkpod:[2071] libgpod/trunk/src/itdb_thumb.c

[<te...@us...>]

Revision: 2071
          http://gtkpod.svn.sourceforge.net/gtkpod/?rev=2071&view=rev
Author:   teuf
Date:     2008-07-29 20:12:07 +0000 (Tue, 29 Jul 2008)

Log Message:
-----------
itdb_thumb_to_pixbufs API doc

Modified Paths:
--------------
    libgpod/trunk/src/itdb_thumb.c

Modified: libgpod/trunk/src/itdb_thumb.c
===================================================================
--- libgpod/trunk/src/itdb_thumb.c	2008-07-29 20:11:37 UTC (rev 2070)
+++ libgpod/trunk/src/itdb_thumb.c	2008-07-29 20:12:07 UTC (rev 2071)
@@ -525,6 +525,23 @@
         return pixbufs;
 }
 
+/**
+ * itdb_thumb_to_pixbufs:
+ * @device: an #Itdb_Device
+ * @thumb: an #Itdb_Thumb
+ * 
+ * Return value: a #GList of #GdkPixbuf which are associated with @thumb, NULL
+ * if the pixbuf was invalid or if libgpod is compiled without gdk-pixbuf
+ * support. The #GdkPixbuf must be unreffed with gdk_pixbuf_unref() after use 
+ * and the #GList must be freed with g_list_free().
+ *
+ * Converts @thumb to a #GList of #GdkPixbuf. The returned #GList will
+ * generally contain only 1 element, the full-size pixbuf associated with
+ * @thumb, but when the artwork has been read from the ipod and hasn't been
+ * modified from the library, then the returned #GList will contain several
+ * #GdkPixbuf corresponding to the various thumbnail sizes that were
+ * written to the iPod database.
+ **/
 GList *itdb_thumb_to_pixbufs (Itdb_Device *dev, Itdb_Thumb *thumb)
 {
     GList *pixbufs = NULL;


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.