GI.Clutter.Objects.BrightnessContrastEffect

BrightnessContrastEffect is an opaque structure whose members cannot be directly accessed

Since: 1.10

Exported types

newtype BrightnessContrastEffect

Memory-managed wrapper type.

Constructors

BrightnessContrastEffect (ManagedPtr BrightnessContrastEffect)

Instances

Eq BrightnessContrastEffect

Defined in GI.Clutter.Objects.BrightnessContrastEffect

Methods

(==) :: BrightnessContrastEffect -> BrightnessContrastEffect -> Bool

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

GObject BrightnessContrastEffect

Defined in GI.Clutter.Objects.BrightnessContrastEffect

ManagedPtrNewtype BrightnessContrastEffect

Defined in GI.Clutter.Objects.BrightnessContrastEffect

Methods

toManagedPtr :: BrightnessContrastEffect -> ManagedPtr BrightnessContrastEffect

TypedObject BrightnessContrastEffect

Defined in GI.Clutter.Objects.BrightnessContrastEffect

Methods

glibType :: IO GType

HasParentTypes BrightnessContrastEffect

Defined in GI.Clutter.Objects.BrightnessContrastEffect

IsGValue (Maybe BrightnessContrastEffect)

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

Defined in GI.Clutter.Objects.BrightnessContrastEffect

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes BrightnessContrastEffect

Defined in GI.Clutter.Objects.BrightnessContrastEffect

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

class (GObject o, IsDescendantOf BrightnessContrastEffect o) => IsBrightnessContrastEffect o

Type class for types which can be safely cast to BrightnessContrastEffect, for instance with toBrightnessContrastEffect.

Instances

(GObject o, IsDescendantOf BrightnessContrastEffect o) => IsBrightnessContrastEffect o

Defined in GI.Clutter.Objects.BrightnessContrastEffect

toBrightnessContrastEffect :: (MonadIO m, IsBrightnessContrastEffect o) => o -> m BrightnessContrastEffect

Cast to BrightnessContrastEffect, 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, getBrightness, getContrast, getData, getEnabled, getName, getProperty, getQdata, getTarget, getTargetRect, getTargetSize, getTexture.

Setters

setBrightness, setBrightnessFull, setContrast, setContrastFull, setData, setDataFull, setEnabled, setName, setProperty.

getBrightness

brightnessContrastEffectGetBrightness

Arguments

:: (HasCallStack, MonadIO m, IsBrightnessContrastEffect a)

=> a

effect: a BrightnessContrastEffect

-> m (Float, Float, Float)

Retrieves the change in brightness used by effect.

Since: 1.10

getContrast

brightnessContrastEffectGetContrast

Arguments

:: (HasCallStack, MonadIO m, IsBrightnessContrastEffect a)

=> a

effect: a BrightnessContrastEffect

-> m (Float, Float, Float)

Retrieves the contrast value used by effect.

Since: 1.10

new

brightnessContrastEffectNew

Arguments

:: (HasCallStack, MonadIO m)

=> m BrightnessContrastEffect

Returns: the newly created BrightnessContrastEffect or Nothing. Use objectUnref when done.

Creates a new BrightnessContrastEffect to be used with actorAddEffect

Since: 1.10

setBrightness

brightnessContrastEffectSetBrightness

Arguments

:: (HasCallStack, MonadIO m, IsBrightnessContrastEffect a)

=> a

effect: a BrightnessContrastEffect

-> Float

brightness: the brightness change for all three components (r, g, b)

-> m ()

The range of brightness is [-1.0, 1.0], where 0.0 designates no change; a value below 0.0 indicates a decrease in brightness; and a value above 0.0 indicates an increase of brightness.

Since: 1.10

setBrightnessFull

brightnessContrastEffectSetBrightnessFull

Arguments

:: (HasCallStack, MonadIO m, IsBrightnessContrastEffect a)

=> a

effect: a BrightnessContrastEffect

-> Float

red: red component of the change in brightness

-> Float

green: green component of the change in brightness

-> Float

blue: blue component of the change in brightness

-> m ()

The range for each component is [-1.0, 1.0] where 0.0 designates no change, values below 0.0 mean a decrease in brightness, and values above indicate an increase.

Since: 1.10

setContrast

brightnessContrastEffectSetContrast

Arguments

:: (HasCallStack, MonadIO m, IsBrightnessContrastEffect a)

=> a

effect: a BrightnessContrastEffect

-> Float

contrast: contrast change for all three channels

-> m ()

The range for contrast is [-1.0, 1.0], where 0.0 designates no change; a value below 0.0 indicates a decrease in contrast; and a value above 0.0 indicates an increase.

Since: 1.10

setContrastFull

brightnessContrastEffectSetContrastFull

Arguments

:: (HasCallStack, MonadIO m, IsBrightnessContrastEffect a)

=> a

effect: a BrightnessContrastEffect

-> Float

red: red component of the change in contrast

-> Float

green: green component of the change in contrast

-> Float

blue: blue component of the change in contrast

-> m ()

The range for each component is [-1.0, 1.0] where 0.0 designates no change, values below 0.0 mean a decrease in contrast, and values above indicate an increase.

Since: 1.10

Properties

brightness

The brightness change to apply to the effect.

This property uses a Color to represent the changes to each color channel. The range is [ 0, 255 ], with 127 as the value used to indicate no change; values smaller than 127 indicate a decrease in brightness, and values larger than 127 indicate an increase in brightness.

Since: 1.10

clearBrightnessContrastEffectBrightness :: (MonadIO m, IsBrightnessContrastEffect o) => o -> m ()

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

clear #brightness

constructBrightnessContrastEffectBrightness :: (IsBrightnessContrastEffect o, MonadIO m) => Color -> m (GValueConstruct o)

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

getBrightnessContrastEffectBrightness :: (MonadIO m, IsBrightnessContrastEffect o) => o -> m (Maybe Color)

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

get brightnessContrastEffect #brightness

setBrightnessContrastEffectBrightness :: (MonadIO m, IsBrightnessContrastEffect o) => o -> Color -> m ()

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

set brightnessContrastEffect [ #brightness := value ]

contrast

The contrast change to apply to the effect.

This property uses a Color to represent the changes to each color channel. The range is [ 0, 255 ], with 127 as the value used to indicate no change; values smaller than 127 indicate a decrease in contrast, and values larger than 127 indicate an increase in contrast.

Since: 1.10

clearBrightnessContrastEffectContrast :: (MonadIO m, IsBrightnessContrastEffect o) => o -> m ()

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

clear #contrast

constructBrightnessContrastEffectContrast :: (IsBrightnessContrastEffect o, MonadIO m) => Color -> m (GValueConstruct o)

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

getBrightnessContrastEffectContrast :: (MonadIO m, IsBrightnessContrastEffect o) => o -> m (Maybe Color)

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

get brightnessContrastEffect #contrast

setBrightnessContrastEffectContrast :: (MonadIO m, IsBrightnessContrastEffect o) => o -> Color -> m ()

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

set brightnessContrastEffect [ #contrast := value ]