Method

ClutterImageset_area

Declaration [src]

gboolean
clutter_image_set_area (
  ClutterImage* image,
  const guint8* data,
  CoglPixelFormat pixel_format,
  const cairo_rectangle_int_t* rect,
  guint row_stride,
  GError** error
)

Description [src]

Sets the image data to be display by image, using rect to indicate the position and size of the image data to be set.

If the image does not have any image data set when this function is called, a new texture will be created with the size of the width and height of the rectangle, i.e. calling this function on a newly created ClutterImage will be the equivalent of calling clutter_image_set_data().

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.

Available since:1.10

Parameters

data An array of guint8
 

The image data, as an array of bytes.

 The data is owned by the caller of the function.
pixel_format CoglPixelFormat
 

The Cogl pixel format of the image data.

rect cairo_rectangle_int_t
 

A rectangle indicating the area that should be set.

 The data is owned by the caller of the function.
row_stride guint
 

The length of each row inside data.

error GError **
  The return location for a GError*, or NULL.

Return value

Returns: gboolean
 

TRUE if the image data was successfully loaded, and FALSE otherwise.