Documentation fixes

This commit is contained in:
Emmanuele Bassi 2012-03-09 17:11:19 +00:00
parent 1b4bfb04e5
commit b6403b01a1
4 changed files with 83 additions and 8 deletions

View File

@ -17793,10 +17793,15 @@ clutter_actor_get_content_box (ClutterActor *self,
/** /**
* clutter_actor_set_content_scaling_filters: * clutter_actor_set_content_scaling_filters:
* @self: a #ClutterActor * @self: a #ClutterActor
* @min_filter: FIXME * @min_filter: the minification filter for the content
* @mag_filter: FIXME * @mag_filter: the magnification filter for the content
* *
* FIXME * Sets the minification and magnification filter to be applied when
* scaling the #ClutterActor:content of a #ClutterActor.
*
* The #ClutterActor:minification-filter will be used when reducing
* the size of the content; the #ClutterActor:magnification-filter
* will be used when increasing the size of the content.
* *
* Since: 1.10 * Since: 1.10
*/ */
@ -17843,10 +17848,12 @@ clutter_actor_set_content_scaling_filters (ClutterActor *self,
/** /**
* clutter_actor_get_content_scaling_filters: * clutter_actor_get_content_scaling_filters:
* @self: a #ClutterActor * @self: a #ClutterActor
* @min_filter: (out): FIXME * @min_filter: (out) (allow-none): return location for the minification
* @mag_filter: (out): FIXME * filter, or %NULL
* @mag_filter: (out) (allow-none): return location for the magnification
* filter, or %NULL
* *
* FIXME * Retrieves the values set using clutter_actor_set_content_scaling_filters().
* *
* Since: 1.10 * Since: 1.10
*/ */

View File

@ -1149,6 +1149,18 @@ typedef enum {
CLUTTER_CONTENT_GRAVITY_RESIZE_ASPECT CLUTTER_CONTENT_GRAVITY_RESIZE_ASPECT
} ClutterContentGravity; } ClutterContentGravity;
/**
* ClutterScalingFilter:
* @CLUTTER_SCALING_FILTER_LINEAR: Linear interpolation filter
* @CLUTTER_SCALING_FILTER_NEAREST: Nearest neighbor interpolation filter
* @CLUTTER_SCALING_FILTER_BILINEAR: Bilinear minification filter; this
* filter enables mipmap generation.
*
* The scaling filters to be used with the #ClutterActor:minification-filter
* and #ClutterActor:magnification-filter properties.
*
* Since: 1.10
*/
typedef enum { typedef enum {
CLUTTER_SCALING_FILTER_LINEAR, CLUTTER_SCALING_FILTER_LINEAR,
CLUTTER_SCALING_FILTER_NEAREST, CLUTTER_SCALING_FILTER_NEAREST,

View File

@ -22,6 +22,17 @@
* Emmanuele Bassi <ebassi@linux.intel.com> * Emmanuele Bassi <ebassi@linux.intel.com>
*/ */
/**
* SECTION:clutter-image
* @Title: ClutterImage
* @Short_Description: Image data content
*
* #ClutterImage is a #ClutterContent implementation that displays
* image data.
*
* #ClutterImage is available since Clutter 1.10.
*/
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H
#include "config.h" #include "config.h"
#endif #endif
@ -141,9 +152,10 @@ clutter_content_iface_init (ClutterContentIface *iface)
/** /**
* clutter_image_new: * clutter_image_new:
* *
* FIXME * Creates a new #ClutterImage instance.
* *
* Return value: (transfer full): FIXME * Return value: (transfer full): the newly created #ClutterImage instance.
* Use g_object_unref() when done.
* *
* Since: 1.10 * Since: 1.10
*/ */
@ -153,6 +165,30 @@ clutter_image_new (void)
return g_object_new (CLUTTER_TYPE_IMAGE, NULL); return g_object_new (CLUTTER_TYPE_IMAGE, NULL);
} }
/**
* clutter_image_set_data:
* @image: a #ClutterImage
* @data: (array): the image data, as an array of bytes
* @pixel_format: the Cogl pixel format of the image data
* @width: the width of the image data
* @height: the height of the image data
* @row_stride: the length of each row inside @data
* @error: return location for a #GError, or %NULL
*
* Sets the image data to be display by @image.
*
* If the image data was successfully loaded, the @image will be invalidated.
*
* In case of error, the @error value will be set, and this function will
* return %FALSE.
*
* The image data is copied in texture memory.
*
* Return value: %TRUE if the image data was successfully loaded,
* and %FALSE otherwise.
*
* Since: 1.10
*/
gboolean gboolean
clutter_image_set_data (ClutterImage *image, clutter_image_set_data (ClutterImage *image,
const guint8 *data, const guint8 *data,

View File

@ -3149,3 +3149,23 @@ CLUTTER_IS_CANVAS_CLASS
ClutterCanvasPrivate ClutterCanvasPrivate
clutter_canvas_get_type clutter_canvas_get_type
</SECTION> </SECTION>
<SECTION>
<FILE>clutter-image</FILE>
ClutterImage
ClutterImageClass
ClutterImageError
clutter_image_new
clutter_image_set_data
<SUBSECTION Standard>
CLUTTER_TYPE_IMAGE
CLUTTER_IMAGE
CLUTTER_IMAGE_CLASS
CLUTTER_IS_IMAGE
CLUTTER_IS_IMAGE_CLASS
CLUTTER_IMAGE_ERROR
<SUBSECTION Private>
ClutterImagePrivate
clutter_image_get_type
clutter_image_error_quark
</SECTION>