Clutter.Effect

Subclasses:

Clutter.OffscreenEffect

Methods

Inherited:

Clutter.ActorMeta (5), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

queue_repaint ()

Virtual Methods

Inherited:

Clutter.ActorMeta (1), GObject.Object (7)

	do_get_paint_volume (volume)
	do_paint (flags)
	do_pick (flags)
	do_post_paint ()
	do_pre_paint ()

Properties

Inherited:

Clutter.ActorMeta (3)

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent_instance	Clutter.ActorMeta	r

Class Details

class Clutter.Effect(**kwargs)

Bases:

Clutter.ActorMeta

Abstract:

Yes

Structure:

Clutter.EffectClass

The Clutter.Effect structure contains only private data and should be accessed using the provided API

New in version 1.4.

queue_repaint()

Queues a repaint of the effect. The effect can detect when the ‘paint’ method is called as a result of this function because it will not have the Clutter.EffectPaintFlags.ACTOR_DIRTY flag set. In that case the effect is free to assume that the actor has not changed its appearance since the last time it was painted so it doesn’t need to call Clutter.Actor.continue_paint() if it can draw a cached image. This is mostly intended for effects that are using a Cogl.Offscreen to redirect the actor (such as Clutter.OffscreenEffect). In that case the effect can save a bit of rendering time by painting the cached texture without causing the entire actor to be painted.

This function can be used by effects that have their own animatable parameters. For example, an effect which adds a varying degree of a red tint to an actor by redirecting it through a Cogl.Offscreen might have a property to specify the level of tint. When this value changes, the underlying actor doesn’t need to be redrawn so the effect can call Clutter.Effect.queue_repaint() to make sure the effect is repainted.

Note however that modifying the position of the parent of an actor may change the appearance of the actor because its transformation matrix would change. In this case a redraw wouldn’t be queued on the actor itself so the Clutter.EffectPaintFlags.ACTOR_DIRTY would still not be set. The effect can detect this case by keeping track of the last modelview matrix that was used to render the actor and veryifying that it remains the same in the next paint.

Any other effects that are layered on top of the passed in effect will still be passed the Clutter.EffectPaintFlags.ACTOR_DIRTY flag. If anything queues a redraw on the actor without specifying an effect or with an effect that is lower in the chain of effects than this one then that will override this call. In that case this effect will instead be called with the Clutter.EffectPaintFlags.ACTOR_DIRTY flag set.

New in version 1.8.

do_get_paint_volume(volume) virtual

Parameters:

volume (Clutter.PaintVolume) –

Return type:

bool

do_paint(flags) virtual

Parameters:

flags (Clutter.EffectPaintFlags) –

do_pick(flags) virtual

Parameters:

flags (Clutter.EffectPaintFlags) –

do_post_paint() virtual

do_pre_paint() virtual

Return type:

bool