| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Clutter.Objects.DesaturateEffect
Description
DesaturateEffect is an opaque structure
whose members cannot be directly accessed
Since: 1.4
Synopsis
- newtype DesaturateEffect = DesaturateEffect (ManagedPtr DesaturateEffect)
- class (GObject o, IsDescendantOf DesaturateEffect o) => IsDesaturateEffect o
- toDesaturateEffect :: (MonadIO m, IsDesaturateEffect o) => o -> m DesaturateEffect
- desaturateEffectGetFactor :: (HasCallStack, MonadIO m, IsDesaturateEffect a) => a -> m Double
- desaturateEffectNew :: (HasCallStack, MonadIO m) => Double -> m DesaturateEffect
- desaturateEffectSetFactor :: (HasCallStack, MonadIO m, IsDesaturateEffect a) => a -> Double -> m ()
- constructDesaturateEffectFactor :: (IsDesaturateEffect o, MonadIO m) => Double -> m (GValueConstruct o)
- getDesaturateEffectFactor :: (MonadIO m, IsDesaturateEffect o) => o -> m Double
- setDesaturateEffectFactor :: (MonadIO m, IsDesaturateEffect o) => o -> Double -> m ()
Exported types
newtype DesaturateEffect Source #
Memory-managed wrapper type.
Constructors
| DesaturateEffect (ManagedPtr DesaturateEffect) |
Instances
class (GObject o, IsDescendantOf DesaturateEffect o) => IsDesaturateEffect o Source #
Type class for types which can be safely cast to DesaturateEffect, for instance with toDesaturateEffect.
Instances
| (GObject o, IsDescendantOf DesaturateEffect o) => IsDesaturateEffect o Source # | |
Defined in GI.Clutter.Objects.DesaturateEffect | |
toDesaturateEffect :: (MonadIO m, IsDesaturateEffect o) => o -> m DesaturateEffect Source #
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 Source #
Arguments
| :: (HasCallStack, MonadIO m, IsDesaturateEffect a) | |
| => a |
|
| -> m Double | Returns: the desaturation factor |
Retrieves the desaturation factor of effect
Since: 1.4
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Double |
|
| -> m DesaturateEffect | Returns: the newly created |
Creates a new DesaturateEffect to be used with
actorAddEffect
Since: 1.4
setFactor
desaturateEffectSetFactor Source #
Arguments
| :: (HasCallStack, MonadIO m, IsDesaturateEffect a) | |
| => a |
|
| -> Double |
|
| -> 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) Source #
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 Source #
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 () Source #
Set the value of the “factor” property.
When overloading is enabled, this is equivalent to
setdesaturateEffect [ #factor:=value ]