Inheritance diagram for Clutter::Effect:

Collaboration diagram for Clutter::Effect:

Public Member Functions
virtual	~Effect ()
ClutterEffect*	gobj ()
	Provides access to the underlying C GObject. More...
const ClutterEffect*	gobj () const
	Provides access to the underlying C GObject. More...
ClutterEffect*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
void	queue_repaint ()
	Queues a repaint of the effect. More...
Public Member Functions inherited from Clutter::ActorMeta
virtual	~ActorMeta ()
ClutterActorMeta*	gobj ()
	Provides access to the underlying C GObject. More...
const ClutterActorMeta*	gobj () const
	Provides access to the underlying C GObject. More...
ClutterActorMeta*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
void	set_name (const Glib::ustring& name)
	Sets the name of meta. More...
Glib::ustring	get_name () const
	Retrieves the name set using set_name() More...
void	set_enabled (bool is_enabled=true)
	Sets whether meta should be enabled or not. More...
bool	get_enabled () const
	Retrieves whether meta is enabled. More...
Glib::RefPtr< Actor >	get_actor ()
	Retrieves a pointer to the Clutter::Actor that owns meta. More...
Glib::RefPtr< const Actor >	get_actor () const
	Retrieves a pointer to the Clutter::Actor that owns meta. More...

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...
Static Public Member Functions inherited from Clutter::ActorMeta
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

Protected Member Functions
	Effect ()
Protected Member Functions inherited from Clutter::ActorMeta
	ActorMeta ()
virtual void	set_actor_vfunc (const Glib::RefPtr< const Actor >& actor)
Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Actor > >	property_actor () const
	The actor attached to the meta. More...
Glib::PropertyProxy< bool >	property_enabled ()
	Whether the meta is enabled. More...
Glib::PropertyProxy_ReadOnly < bool >	property_enabled () const
	Whether the meta is enabled. More...
Glib::PropertyProxy < Glib::ustring >	property_name ()
	The name of the meta. More...
Glib::PropertyProxy_ReadOnly < Glib::ustring >	property_name () const
	The name of the meta. More...

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Clutter::Effect >	wrap (ClutterEffect* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...
Related Functions inherited from Clutter::ActorMeta
Glib::RefPtr< Clutter::ActorMeta >	wrap (ClutterActorMeta* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Constructor & Destructor Documentation

virtual Clutter::Effect::~Effect ( )

virtual

Clutter::Effect::Effect ( )

protected

Member Function Documentation

static GType Clutter::Effect::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

ClutterEffect* Clutter::Effect::gobj ( )

inline

Provides access to the underlying C GObject.

const ClutterEffect* Clutter::Effect::gobj ( ) const

inline

Provides access to the underlying C GObject.

ClutterEffect* Clutter::Effect::gobj_copy

(

)

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

void Clutter::Effect::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::EFFECT_PAINT_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 CoglOffscreen 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 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::EFFECT_PAINT_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::EFFECT_PAINT_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::EFFECT_PAINT_ACTOR_DIRTY flag set.

Since cluttermm 1.8:

Friends And Related Function Documentation

Glib::RefPtr< Clutter::Effect > wrap ( ClutterEffect *  object, bool  take_copy = false  )

related

A Glib::wrap() method for this object.

Parameters

object	The C instance.
take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns

A C++ instance that wraps this C instance.

---

The documentation for this class was generated from the following file:

• cluttermm/effect.h