Commit 0255b5a1 authored by Emmanuele Bassi's avatar Emmanuele Bassi

docs: Add an explicit example of image loading

Using GdkPixbuf, which is what we expect people to use anyway.
parent 10ff9a46
......@@ -209,6 +209,28 @@ clutter_image_new (void)
*
* The image data is copied in texture memory.
*
* The image data is expected to be a linear array of RGBA or RGB pixel data;
* how to retrieve that data is left to platform specific image loaders. For
* instance, if you use the GdkPixbuf library:
*
* |[<!-- language="C" -->
* ClutterContent *image = clutter_image_new ();
*
* GdkPixbuf *pixbuf = gdk_pixbuf_new_from_file (filename, NULL);
*
* clutter_image_set_data (CLUTTER_IMAGE (image),
* gdk_pixbuf_get_pixels (pixbuf),
* gdk_pixbuf_has_alpha (pixbuf)
* ? COGL_PIXEL_FORMAT_RGBA_8888
* : COGL_PIXEL_FORMAT_RGB_888,
* gdk_pixbuf_get_width (pixbuf),
* gdk_pixbuf_get_height (pixbuf),
* gdk_pixbuf_get_rowstride (pixbuf),
* &error);
*
* g_object_unref (pixbuf);
* ]|
*
* Return value: %TRUE if the image data was successfully loaded,
* and %FALSE otherwise.
*
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment