cluttermm: Clutter::BrightnessContrastEffect Class Reference

Inheritance diagram for Clutter::BrightnessContrastEffect:

Collaboration diagram for Clutter::BrightnessContrastEffect:

Public Member Functions
virtual	~BrightnessContrastEffect ()

ClutterBrightnessContrastEffect*	gobj ()
	Provides access to the underlying C GObject. More...

const ClutterBrightnessContrastEffect*	gobj () const
	Provides access to the underlying C GObject. More...

ClutterBrightnessContrastEffect*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

void	set_brightness (float brightness)
	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. More...

void	set_brightness (float red, float green, float blue)
	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. More...

void	get_brightness (float& red, float& green, float& blue) const
	Retrieves the change in brightness used by effect. More...

void	set_contrast (float contrast)
	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. More...

void	set_contrast (float red, float green, float blue)
	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. More...

void	get_contrast (float& red, float& green, float& blue) const
	Retrieves the contrast value used by effect. More...

Glib::PropertyProxy< Color >	property_brightness ()
	The brightness change to apply. More...

Glib::PropertyProxy_ReadOnly < Color >	property_brightness () const
	The brightness change to apply. More...

Glib::PropertyProxy< Color >	property_contrast ()
	The contrast change to apply. More...

Glib::PropertyProxy_ReadOnly < Color >	property_contrast () const
	The contrast change to apply. More...

Public Member Functions inherited from Clutter::OffscreenEffect
virtual	~OffscreenEffect ()

ClutterOffscreenEffect*	gobj ()
	Provides access to the underlying C GObject. More...

const ClutterOffscreenEffect*	gobj () const
	Provides access to the underlying C GObject. More...

ClutterOffscreenEffect*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

CoglHandle	get_texture ()
	Retrieves the texture used as a render target for the offscreen buffer created by effect. More...

CoglHandle	create_texture (float width, float height)
	Calls the create_texture() virtual function of the effect. More...

void	paint_target ()
	Calls the paint_target() virtual function of the effect. More...

Public Member Functions inherited from Clutter::Effect
virtual	~Effect ()

ClutterEffect*	gobj ()
	Provides access to the underlying C GObject. More...

const ClutterEffect*	gobj () const
	Provides access to the underlying C GObject. More...

ClutterEffect*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

void	queue_repaint ()
	Queues a repaint of the effect. More...

Public Member Functions inherited from Clutter::ActorMeta
virtual	~ActorMeta ()

ClutterActorMeta*	gobj ()
	Provides access to the underlying C GObject. More...

const ClutterActorMeta*	gobj () const
	Provides access to the underlying C GObject. More...

ClutterActorMeta*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

void	set_name (const Glib::ustring& name)
	Sets the name of meta. More...

Glib::ustring	get_name () const
	Retrieves the name set using set_name() More...

void	set_enabled (bool is_enabled=true)
	Sets whether meta should be enabled or not. More...

bool	get_enabled () const
	Retrieves whether meta is enabled. More...

Glib::RefPtr< Actor >	get_actor ()
	Retrieves a pointer to the Clutter::Actor that owns meta. More...

Glib::RefPtr< const Actor >	get_actor () const
	Retrieves a pointer to the Clutter::Actor that owns meta. More...

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

static Glib::RefPtr < BrightnessContrastEffect >	create ()

Static Public Member Functions inherited from Clutter::OffscreenEffect
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

Static Public Member Functions inherited from Clutter::Effect
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

Static Public Member Functions inherited from Clutter::ActorMeta
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

Protected Member Functions
	BrightnessContrastEffect ()

Protected Member Functions inherited from Clutter::OffscreenEffect
	OffscreenEffect ()

Protected Member Functions inherited from Clutter::Effect
	Effect ()

Protected Member Functions inherited from Clutter::ActorMeta
	ActorMeta ()

virtual void	set_actor_vfunc (const Glib::RefPtr< const Actor >& actor)

Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Actor > >	property_actor () const
	The actor attached to the meta. More...

Glib::PropertyProxy< bool >	property_enabled ()
	Whether the meta is enabled. More...

Glib::PropertyProxy_ReadOnly < bool >	property_enabled () const
	Whether the meta is enabled. More...

Glib::PropertyProxy < Glib::ustring >	property_name ()
	The name of the meta. More...

Glib::PropertyProxy_ReadOnly < Glib::ustring >	property_name () const
	The name of the meta. More...

Related Functions
(Note that these are not member functions.)
Glib::RefPtr < Clutter::BrightnessContrastEffect >	wrap (ClutterBrightnessContrastEffect* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Clutter::OffscreenEffect
Glib::RefPtr < Clutter::OffscreenEffect >	wrap (ClutterOffscreenEffect* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Clutter::Effect
Glib::RefPtr< Clutter::Effect >	wrap (ClutterEffect* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Clutter::ActorMeta
Glib::RefPtr< Clutter::ActorMeta >	wrap (ClutterActorMeta* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Constructor & Destructor Documentation

virtual Clutter::BrightnessContrastEffect::~BrightnessContrastEffect ( )

virtual

Clutter::BrightnessContrastEffect::BrightnessContrastEffect ( )

protected

Member Function Documentation

static Glib::RefPtr<BrightnessContrastEffect> Clutter::BrightnessContrastEffect::create ( )

static

void Clutter::BrightnessContrastEffect::get_brightness	(	float &	red,
		float &	green,
		float &	blue
	)		const

Retrieves the change in brightness used by effect.

Since cluttermm 1.10:

Parameters

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.

void Clutter::BrightnessContrastEffect::get_contrast	(	float &	red,
		float &	green,
		float &	blue
	)		const

Retrieves the contrast value used by effect.

Since cluttermm 1.10:

Parameters

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.

static GType Clutter::BrightnessContrastEffect::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

ClutterBrightnessContrastEffect* Clutter::BrightnessContrastEffect::gobj ( )

inline

Provides access to the underlying C GObject.

const ClutterBrightnessContrastEffect* Clutter::BrightnessContrastEffect::gobj ( ) const

inline

Provides access to the underlying C GObject.

ClutterBrightnessContrastEffect* Clutter::BrightnessContrastEffect::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

Glib::PropertyProxy< Color > Clutter::BrightnessContrastEffect::property_brightness ( )

The brightness change to apply.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns: A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly< Color > Clutter::BrightnessContrastEffect::property_brightness ( ) const

The brightness change to apply.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

Glib::PropertyProxy< Color > Clutter::BrightnessContrastEffect::property_contrast ( )

The contrast change to apply.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns: A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly< Color > Clutter::BrightnessContrastEffect::property_contrast ( ) const

The contrast change to apply.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

void Clutter::BrightnessContrastEffect::set_brightness ( float brightness)

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 cluttermm 1.10:

Parameters

brightness The brightness change for all three components (r, g, b).

void Clutter::BrightnessContrastEffect::set_brightness	(	float	red,
		float	green,
		float	blue
	)

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 cluttermm 1.10:

Parameters

red	Red component of the change in brightness.
green	Green component of the change in brightness.
blue	Blue component of the change in brightness.

void Clutter::BrightnessContrastEffect::set_contrast ( float contrast)

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 cluttermm 1.10:

Parameters

contrast Contrast change for all three channels.

void Clutter::BrightnessContrastEffect::set_contrast	(	float	red,
		float	green,
		float	blue
	)

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 cluttermm 1.10:

Parameters

red	Red component of the change in contrast.
green	Green component of the change in contrast.
blue	Blue component of the change in contrast.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::BrightnessContrastEffect > wrap	(	ClutterBrightnessContrastEffect *	object,
		bool	take_copy = `false`
	)

A Glib::wrap() method for this object.

Parameters

object	The C instance.
take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns: A C++ instance that wraps this C instance.

The documentation for this class was generated from the following file:

cluttermm/brightness-contrast-effect.h

cluttermm: Clutter::BrightnessContrastEffect Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation