cluttermm: Clutter::DeformEffect Class Reference
Inheritance diagram for Clutter::DeformEffect:
Collaboration diagram for Clutter::DeformEffect:
Public Member Functions | |
| virtual | ~DeformEffect () |
| ClutterDeformEffect* | gobj () |
| Provides access to the underlying C GObject. More... | |
| const ClutterDeformEffect* | gobj () const |
| Provides access to the underlying C GObject. More... | |
| ClutterDeformEffect* | 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_back_material (CoglHandle material) |
| Sets the material that should be used when drawing the back face of the actor during a deformation. More... | |
| CoglHandle | get_back_material () |
| Retrieves the handle to the back face material used by effect. More... | |
| void | set_n_tiles (guint x_tiles, guint y_tiles) |
| Sets the number of horizontal and vertical tiles to be used when applying the effect. More... | |
| void | get_n_tiles (guint& x_tiles, guint& y_tiles) const |
| Retrieves the number of horizontal and vertical tiles used to sub-divide the actor's geometry during the effect. More... | |
| void | invalidate () |
| Invalidates the effect's vertices and, if it is associated to an actor, it will queue a redraw. More... | |
| Glib::PropertyProxy< CoglHandle* > | property_back_material () |
| The material to be used when painting the back of the actor. More... | |
| Glib::PropertyProxy_ReadOnly < CoglHandle* > | property_back_material () const |
| The material to be used when painting the back of the actor. More... | |
| Glib::PropertyProxy< guint > | property_x_tiles () |
| The number of horizontal tiles. More... | |
| Glib::PropertyProxy_ReadOnly < guint > | property_x_tiles () const |
| The number of horizontal tiles. More... | |
| Glib::PropertyProxy< guint > | property_y_tiles () |
| The number of vertical tiles. More... | |
| Glib::PropertyProxy_ReadOnly < guint > | property_y_tiles () const |
| The number of vertical tiles. 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< DeformEffect > | 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 | |
| DeformEffect () | |
| 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::DeformEffect > | wrap (ClutterDeformEffect* 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 |
|
protected |
Member Function Documentation
|
static |
| CoglHandle Clutter::DeformEffect::get_back_material | ( | ) |
Retrieves the handle to the back face material used by effect.
- Returns
- A handle for the material, or
0. The returned material is owned by the Clutter::DeformEffect and it should not be freed directly.
| void Clutter::DeformEffect::get_n_tiles | ( | guint & | x_tiles, |
| guint & | y_tiles | ||
| ) | const |
Retrieves the number of horizontal and vertical tiles used to sub-divide the actor's geometry during the effect.
- Parameters
-
x_tiles Return location for the number of horizontal tiles, or 0.y_tiles Return location for the number of vertical tiles, or 0.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
| ClutterDeformEffect* Clutter::DeformEffect::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
| void Clutter::DeformEffect::invalidate | ( | ) |
Invalidates the effect's vertices and, if it is associated to an actor, it will queue a redraw.
| Glib::PropertyProxy< CoglHandle* > Clutter::DeformEffect::property_back_material | ( | ) |
The material to be used when painting the back of the actor.
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< CoglHandle* > Clutter::DeformEffect::property_back_material | ( | ) | const |
The material to be used when painting the back of the actor.
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< guint > Clutter::DeformEffect::property_x_tiles | ( | ) |
The number of horizontal tiles.
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< guint > Clutter::DeformEffect::property_x_tiles | ( | ) | const |
The number of horizontal tiles.
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< guint > Clutter::DeformEffect::property_y_tiles | ( | ) |
The number of vertical tiles.
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< guint > Clutter::DeformEffect::property_y_tiles | ( | ) | const |
The number of vertical tiles.
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::DeformEffect::set_back_material | ( | CoglHandle | material) |
Sets the material that should be used when drawing the back face of the actor during a deformation.
The Clutter::DeformEffect will take a reference on the material's handle
- Parameters
-
material A handle to a Cogl material.
| void Clutter::DeformEffect::set_n_tiles | ( | guint | x_tiles, |
| guint | y_tiles | ||
| ) |
Sets the number of horizontal and vertical tiles to be used when applying the effect.
More tiles allow a finer grained deformation at the expenses of computation
- Parameters
-
x_tiles Number of horizontal tiles. y_tiles Number of vertical tiles.
Friends And Related Function Documentation
|
related |
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/deform-effect.h