cluttermm: Clutter::ShaderEffect Class Reference

Inheritance diagram for Clutter::ShaderEffect:

Collaboration diagram for Clutter::ShaderEffect:

Public Member Functions
virtual	~ShaderEffect ()

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

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

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

bool	set_shader_source (const Glib::ustring& source)
	Sets the source of the GLSL shader used by effect. More...

CoglHandle	get_program ()
	Retrieves a pointer to the program's handle. More...

CoglHandle	get_shader ()
	Retrieves a pointer to the shader's handle. 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< ShaderEffect >	create (ShaderType shader_type)

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
	ShaderEffect (ShaderType shader_type)

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::ShaderEffect >	wrap (ClutterShaderEffect* 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::ShaderEffect::~ShaderEffect ( )

virtual

Clutter::ShaderEffect::ShaderEffect ( ShaderType shader_type)

explicitprotected

Member Function Documentation

static Glib::RefPtr<ShaderEffect> Clutter::ShaderEffect::create ( ShaderType shader_type)

static

CoglHandle Clutter::ShaderEffect::get_program ( )

Retrieves a pointer to the program's handle.

Since cluttermm 1.4:

Returns: A pointer to the program's handle, or Cogl::INVALID_HANDLE.

CoglHandle Clutter::ShaderEffect::get_shader ( )

Retrieves a pointer to the shader's handle.

Since cluttermm 1.4:

Returns: A pointer to the shader's handle, or Cogl::INVALID_HANDLE.

static GType Clutter::ShaderEffect::get_type ( )

static

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

ClutterShaderEffect* Clutter::ShaderEffect::gobj ( )

inline

Provides access to the underlying C GObject.

const ClutterShaderEffect* Clutter::ShaderEffect::gobj ( ) const

inline

Provides access to the underlying C GObject.

ClutterShaderEffect* Clutter::ShaderEffect::gobj_copy ( )

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

bool Clutter::ShaderEffect::set_shader_source ( const Glib::ustring & source)

Sets the source of the GLSL shader used by effect.

This function should only be called by implementations of the Clutter::ShaderEffect class, and not by application code.

This function can only be called once; subsequent calls will yield no result.

Since cluttermm 1.4:

Parameters

source The source of a GLSL shader.

Returns: true if the source was set.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::ShaderEffect > wrap	(	ClutterShaderEffect *	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/shader-effect.h

cluttermm: Clutter::ShaderEffect 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