GI.Clutter.Objects.DesaturateEffect

DesaturateEffect is an opaque structure whose members cannot be directly accessed

Since: 1.4

Exported types

newtype DesaturateEffect

Memory-managed wrapper type.

Constructors

DesaturateEffect (ManagedPtr DesaturateEffect)

Instances

Eq DesaturateEffect

Defined in GI.Clutter.Objects.DesaturateEffect

Methods

(==) :: DesaturateEffect -> DesaturateEffect -> Bool

(/=) :: DesaturateEffect -> DesaturateEffect -> Bool

GObject DesaturateEffect

Defined in GI.Clutter.Objects.DesaturateEffect

ManagedPtrNewtype DesaturateEffect

Defined in GI.Clutter.Objects.DesaturateEffect

Methods

toManagedPtr :: DesaturateEffect -> ManagedPtr DesaturateEffect

TypedObject DesaturateEffect

Defined in GI.Clutter.Objects.DesaturateEffect

Methods

glibType :: IO GType

HasParentTypes DesaturateEffect

Defined in GI.Clutter.Objects.DesaturateEffect

IsGValue (Maybe DesaturateEffect)

Convert DesaturateEffect to and from GValue. See toGValue and fromGValue.

Defined in GI.Clutter.Objects.DesaturateEffect

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe DesaturateEffect -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe DesaturateEffect)

type ParentTypes DesaturateEffect

Defined in GI.Clutter.Objects.DesaturateEffect

type ParentTypes DesaturateEffect = '[OffscreenEffect, Effect, ActorMeta, Object]

class (GObject o, IsDescendantOf DesaturateEffect o) => IsDesaturateEffect o

Type class for types which can be safely cast to DesaturateEffect, for instance with toDesaturateEffect.

Instances

(GObject o, IsDescendantOf DesaturateEffect o) => IsDesaturateEffect o

Defined in GI.Clutter.Objects.DesaturateEffect

toDesaturateEffect :: (MonadIO m, IsDesaturateEffect o) => o -> m DesaturateEffect

Cast to DesaturateEffect, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, createTexture, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, paintTarget, queueRepaint, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getActor, getData, getEnabled, getFactor, getName, getProperty, getQdata, getTarget, getTargetRect, getTargetSize, getTexture.

Setters

setData, setDataFull, setEnabled, setFactor, setName, setProperty.

getFactor

desaturateEffectGetFactor

Arguments

:: (HasCallStack, MonadIO m, IsDesaturateEffect a)

=> a

effect: a DesaturateEffect

-> m Double

Returns: the desaturation factor

Retrieves the desaturation factor of effect

Since: 1.4

new

desaturateEffectNew

Arguments

:: (HasCallStack, MonadIO m)

=> Double

factor: the desaturation factor, between 0.0 and 1.0

-> m DesaturateEffect

Returns: the newly created DesaturateEffect or Nothing

Creates a new DesaturateEffect to be used with actorAddEffect

Since: 1.4

setFactor

desaturateEffectSetFactor

Arguments

:: (HasCallStack, MonadIO m, IsDesaturateEffect a)

=> a

effect: a DesaturateEffect

-> Double

factor: the desaturation factor, between 0.0 and 1.0

-> m ()

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

Since: 1.4

Properties

factor

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

Since: 1.4

constructDesaturateEffectFactor :: (IsDesaturateEffect o, MonadIO m) => Double -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “factor” property. This is rarely needed directly, but it is used by new.

getDesaturateEffectFactor :: (MonadIO m, IsDesaturateEffect o) => o -> m Double

Get the value of the “factor” property. When overloading is enabled, this is equivalent to

get desaturateEffect #factor

setDesaturateEffectFactor :: (MonadIO m, IsDesaturateEffect o) => o -> Double -> m ()

Set the value of the “factor” property. When overloading is enabled, this is equivalent to

set desaturateEffect [ #factor := value ]