Clutter.DesaturateEffect¶

Subclasses:: None

Methods¶

Inherited:: Clutter.OffscreenEffect (6), Clutter.Effect (1), Clutter.ActorMeta (5), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (factor)
	`get_factor` ()
	`set_factor` (factor)

Virtual Methods¶

Inherited:: Clutter.OffscreenEffect (2), Clutter.Effect (5), Clutter.ActorMeta (1), GObject.Object (7)

Properties¶

Inherited:: Clutter.ActorMeta (3)

Name	Type	Flags	Short Description
`factor`	`float`	r/w	The desaturation factor

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Clutter.DesaturateEffect(**kwargs)¶

Bases:: Clutter.OffscreenEffect
Abstract:: No
Structure:: Clutter.DesaturateEffectClass

Clutter.DesaturateEffect is an opaque structure whose members cannot be directly accessed

New in version 1.4.

classmethod new(factor)¶

Parameters:: factor (float) – the desaturation factor, between 0.0 and 1.0
Returns:: the newly created Clutter.DesaturateEffect or None
Return type:: Clutter.Effect

Creates a new Clutter.DesaturateEffect to be used with Clutter.Actor.add_effect()

New in version 1.4.

get_factor()¶

Returns:: the desaturation factor
Return type:: float

Retrieves the desaturation factor of self

New in version 1.4.

set_factor(factor)¶

Parameters:: factor (float) – the desaturation factor, between 0.0 and 1.0

Sets the desaturation factor for self, with 0.0 being “do not desaturate” and 1.0 being “fully desaturate”

New in version 1.4.

Property Details¶

Clutter.DesaturateEffect.props.factor¶

Name:: factor
Type:: float
Default Value:: 1.0
Flags:: READABLE, WRITABLE

The desaturation factor, between 0.0 (no desaturation) and 1.0 (full desaturation).

New in version 1.4.