clutter_cairo_texture_new ()

ClutterActor *
clutter_cairo_texture_new (guint width,
                           guint height);

Creates a new ClutterCairoTexture actor, with a surface of width by height pixels.

Since: 1.0

clutter_cairo_texture_set_surface_size ()

void
clutter_cairo_texture_set_surface_size
                               (ClutterCairoTexture *self,
                                guint width,
                                guint height);

Resizes the Cairo surface used by self to width and height .

This function will not invalidate the contents of the Cairo texture: you will have to explicitly call either clutter_cairo_texture_invalidate_rectangle() or clutter_cairo_texture_invalidate().

Since: 1.0

clutter_cairo_texture_get_surface_size ()

void
clutter_cairo_texture_get_surface_size
                               (ClutterCairoTexture *self,
                                guint *width,
                                guint *height);

Retrieves the surface width and height for self .

Since: 1.0

clutter_cairo_texture_set_auto_resize ()

void
clutter_cairo_texture_set_auto_resize (ClutterCairoTexture *self,
                                       gboolean value);

Sets whether the ClutterCairoTexture should ensure that the backing Cairo surface used matches the allocation assigned to the actor. If the allocation changes, the contents of the ClutterCairoTexture will also be invalidated automatically.

Since: 1.8

clutter_cairo_texture_get_auto_resize ()

gboolean
clutter_cairo_texture_get_auto_resize (ClutterCairoTexture *self);

Retrieves the value set using clutter_cairo_texture_set_auto_resize().

Since: 1.8

clutter_cairo_texture_create ()

cairo_t *
clutter_cairo_texture_create (ClutterCairoTexture *self);

Creates a new Cairo context for the cairo texture. It is similar to using clutter_cairo_texture_create_region() with x_offset and y_offset of 0, width equal to the cairo texture surface width and height equal to the cairo texture surface height.

Do not call this function within the paint virtual function or from a callback to the “paint” signal.

Since: 1.0

clutter_cairo_texture_create_region ()

cairo_t *
clutter_cairo_texture_create_region (ClutterCairoTexture *self,
                                     gint x_offset,
                                     gint y_offset,
                                     gint width,
                                     gint height);

Creates a new Cairo context that will updat the region defined by x_offset , y_offset , width and height .

Do not call this function within the paint virtual function or from a callback to the “paint” signal.

Since: 1.0

clutter_cairo_texture_invalidate_rectangle ()

void
clutter_cairo_texture_invalidate_rectangle
                               (ClutterCairoTexture *self,
                                cairo_rectangle_int_t *rect);

Invalidates a rectangular region of a ClutterCairoTexture.

The invalidation will cause the “draw” signal to be emitted.

See also: clutter_cairo_texture_invalidate()

Since: 1.8

clutter_cairo_texture_invalidate ()

void
clutter_cairo_texture_invalidate (ClutterCairoTexture *self);

Invalidates the whole surface of a ClutterCairoTexture.

This function will cause the “draw” signal to be emitted.

See also: clutter_cairo_texture_invalidate_rectangle()

Since: 1.8

clutter_cairo_texture_clear ()

void
clutter_cairo_texture_clear (ClutterCairoTexture *self);

Clears self 's internal drawing surface, so that the next upload will replace the previous contents of the ClutterCairoTexture rather than adding to it.

Calling this function from within a “draw” signal handler will clear the invalidated area.

Since: 1.0

struct ClutterCairoTexture

struct ClutterCairoTexture;

The ClutterCairoTexture struct contains only private data.

Since: 1.0

struct ClutterCairoTextureClass

struct ClutterCairoTextureClass {
  cairo_surface_t *(* create_surface) (ClutterCairoTexture *texture,
                                       guint                width,
                                       guint                height);

  gboolean         (* draw)           (ClutterCairoTexture *texture,
                                       cairo_t             *cr);
};

The ClutterCairoTextureClass struct contains only private data.

Since: 1.0

The “auto-resize” property

  “auto-resize”              gboolean

Controls whether the ClutterCairoTexture should automatically resize the Cairo surface whenever the actor's allocation changes. If :auto-resize is set to TRUE the surface contents will also be invalidated automatically.

Flags: Read / Write

Default value: FALSE

Since: 1.8

The “surface-height” property

  “surface-height”           guint

The height of the Cairo surface used by the ClutterCairoTexture actor, in pixels.

Flags: Read / Write

Default value: 0

Since: 1.0

The “surface-width” property

  “surface-width”            guint

The width of the Cairo surface used by the ClutterCairoTexture actor, in pixels.

Flags: Read / Write

Default value: 0

Since: 1.0

The “create-surface” signal

CairoSurface*
user_function (ClutterCairoTexture *texture,
               guint                width,
               guint                height,
               gpointer             user_data)

The ::create-surface signal is emitted when a ClutterCairoTexture news its surface (re)created, which happens either when the Cairo context is created with clutter_cairo_texture_create() or clutter_cairo_texture_create_region(), or when the surface is resized through clutter_cairo_texture_set_surface_size().

The first signal handler that returns a non-NULL, valid surface will stop any further signal emission, and the returned surface will be the one used.

Flags: No Recursion

Since: 1.6

The “draw” signal

gboolean
user_function (ClutterCairoTexture *texture,
               CairoContext        *cr,
               gpointer             user_data)

The ::draw signal is emitted each time a ClutterCairoTexture has been invalidated.

The passed Cairo context passed will be clipped to the invalidated area.

It is safe to connect multiple callbacks to this signals; the state of the Cairo context passed to each callback is automatically saved and restored, so it's not necessary to call cairo_save() and cairo_restore().

Flags: No Recursion

Since: 1.8