cluttermm: Clutter::DesaturateEffect Class Reference

Inheritance diagram for Clutter::DesaturateEffect:
Collaboration diagram for Clutter::DesaturateEffect:

Public Member Functions

virtual ~DesaturateEffect ()
 
ClutterDesaturateEffect* gobj ()
 Provides access to the underlying C GObject. More...

 
const ClutterDesaturateEffect* gobj () const
 Provides access to the underlying C GObject. More...

 
ClutterDesaturateEffect* 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_factor (double factor)
 Sets the desaturation factor for effect, with 0.0 being "do not desaturate" and 1.0 being "fully desaturate". More...

 
double get_factor () const
 Retrieves the desaturation factor of effect. More...

 
- Public Member Functions inherited from Clutter::OffscreenEffect
virtual ~OffscreenEffect ()
 
ClutterOffscreenEffect* gobj ()
 Provides access to the underlying C GObject. More...

 
const ClutterOffscreenEffect* gobj () const
 Provides access to the underlying C GObject. More...

 
ClutterOffscreenEffect* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

 
CoglHandle get_texture ()
 Retrieves the texture used as a render target for the offscreen buffer created by effect. More...

 
CoglHandle create_texture (float width, float height)
 Calls the create_texture() virtual function of the effect. More...

 
void paint_target ()
 Calls the paint_target() virtual function of the effect. More...

 
- Public Member Functions inherited from Clutter::Effect
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< Actorget_actor ()
 Retrieves a pointer to the Clutter::Actor that owns meta. More...

 
Glib::RefPtr< const Actorget_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 Glib::RefPtr

< DesaturateEffect
create (double factor)
 
- Static Public Member Functions inherited from Clutter::OffscreenEffect
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::Effect
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

 DesaturateEffect (double factor)
 
Glib::PropertyProxy< double > property_factor ()
 The desaturation factor. More...

 
Glib::PropertyProxy_ReadOnly

< double > 
property_factor () const
 The desaturation factor. More...

 
- Protected Member Functions inherited from Clutter::OffscreenEffect
 OffscreenEffect ()
 
- Protected Member Functions inherited from Clutter::Effect
 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::DesaturateEffect
wrap (ClutterDesaturateEffect* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...

 

Constructor & Destructor Documentation

virtual Clutter::DesaturateEffect::~DesaturateEffect ( )
virtual
Clutter::DesaturateEffect::DesaturateEffect ( double  factor)
explicitprotected

Member Function Documentation

static Glib::RefPtr<DesaturateEffect> Clutter::DesaturateEffect::create ( double  factor)
static
double Clutter::DesaturateEffect::get_factor ( ) const

Retrieves the desaturation factor of effect.

Since cluttermm 1.4:
Returns
The desaturation factor.
static GType Clutter::DesaturateEffect::get_type ( )
static

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

ClutterDesaturateEffect* Clutter::DesaturateEffect::gobj ( )
inline

Provides access to the underlying C GObject.

const ClutterDesaturateEffect* Clutter::DesaturateEffect::gobj ( ) const
inline

Provides access to the underlying C GObject.

ClutterDesaturateEffect* Clutter::DesaturateEffect::gobj_copy ( )

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

Glib::PropertyProxy< double > Clutter::DesaturateEffect::property_factor ( )
protected

The desaturation factor.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< double > Clutter::DesaturateEffect::property_factor ( ) const
protected

The desaturation factor.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Clutter::DesaturateEffect::set_factor ( double  factor)

Sets the desaturation factor for effect, with 0.0 being "do not desaturate" and 1.0 being "fully desaturate".

Since cluttermm 1.4:
Parameters
factorThe desaturation factor, between 0.0 and 1.0.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::DesaturateEffect > wrap ( ClutterDesaturateEffect *  object,
bool  take_copy = false 
)
related

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

Parameters
objectThe C instance.
take_copyFalse 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/desaturate-effect.h