Clutter.BrightnessContrastEffect

g Clutter.ActorMeta Clutter.ActorMeta Clutter.Effect Clutter.Effect Clutter.ActorMeta->Clutter.Effect Clutter.BrightnessContrastEffect Clutter.BrightnessContrastEffect Clutter.OffscreenEffect Clutter.OffscreenEffect Clutter.Effect->Clutter.OffscreenEffect Clutter.OffscreenEffect->Clutter.BrightnessContrastEffect GObject.InitiallyUnowned GObject.InitiallyUnowned GObject.InitiallyUnowned->Clutter.ActorMeta GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned

Subclasses:None

Methods

Inherited:Clutter.OffscreenEffect (6), Clutter.Effect (1), Clutter.ActorMeta (5), GObject.Object (37)
Structs:GObject.ObjectClass (5)
class new ()
  get_brightness ()
  get_contrast ()
  set_brightness (brightness)
  set_brightness_full (red, green, blue)
  set_contrast (contrast)
  set_contrast_full (red, green, blue)

Properties

Inherited:Clutter.ActorMeta (3)
Name Type Flags Short Description
brightness Clutter.Color r/w The brightness change to apply
contrast Clutter.Color r/w The contrast change to apply

Signals

Inherited:GObject.Object (1)

Fields

Inherited:GObject.Object (1)

Class Details

class Clutter.BrightnessContrastEffect(**kwargs)
Bases:Clutter.OffscreenEffect
Abstract:No
Structure:Clutter.BrightnessContrastEffectClass

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

New in version 1.10.

classmethod new()
Returns:the newly created Clutter.BrightnessContrastEffect or None. Use GObject.Object.unref() when done.
Return type:Clutter.Effect

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

New in version 1.10.

get_brightness()
Returns:
red:return location for red component of the change in brightness
green:return location for green component of the change in brightness
blue:return location for blue component of the change in brightness
Return type:(red: float, green: float, blue: float)

Retrieves the change in brightness used by self.

New in version 1.10.

get_contrast()
Returns:
red:return location for red component of the change in contrast
green:return location for green component of the change in contrast
blue:return location for blue component of the change in contrast
Return type:(red: float, green: float, blue: float)

Retrieves the contrast value used by self.

New in version 1.10.

set_brightness(brightness)
Parameters:brightness (float) – the brightness change for all three components (r, g, b)

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.

New in version 1.10.

set_brightness_full(red, green, blue)
Parameters:
  • red (float) – red component of the change in brightness
  • green (float) – green component of the change in brightness
  • blue (float) – blue component of the change in brightness

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.

New in version 1.10.

set_contrast(contrast)
Parameters:contrast (float) – contrast change for all three channels

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.

New in version 1.10.

set_contrast_full(red, green, blue)
Parameters:
  • red (float) – red component of the change in contrast
  • green (float) – green component of the change in contrast
  • blue (float) – blue component of the change in contrast

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.

New in version 1.10.

Property Details

Clutter.BrightnessContrastEffect.props.brightness
Name:brightness
Type:Clutter.Color
Default Value:<Color structure at 0x000000000000 (ClutterColor at 0x0000000)>
Flags:READABLE, WRITABLE

The brightness change to apply to the effect.

This property uses a Clutter.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.

New in version 1.10.

Clutter.BrightnessContrastEffect.props.contrast
Name:contrast
Type:Clutter.Color
Default Value:<Color structure at 0x000000000000 (ClutterColor at 0x0000000)>
Flags:READABLE, WRITABLE

The contrast change to apply to the effect.

This property uses a Clutter.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.

New in version 1.10.