cluttermm: Clutter::OffscreenEffect Class Reference
Public Member Functions | |
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 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 | |
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::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
CoglHandle Clutter::OffscreenEffect::create_texture | ( | float | width, |
float | height | ||
) |
Calls the create_texture() virtual function of the effect.
- Parameters
-
width The minimum width of the target texture. height The minimum height of the target texture.
- Returns
- A handle to a Cogl texture, or Cogl::INVALID_HANDLE. The returned handle has its reference count increased.
CoglHandle Clutter::OffscreenEffect::get_texture | ( | ) |
Retrieves the texture used as a render target for the offscreen buffer created by effect.
You should only use the returned texture when painting. The texture may change after ClutterEffect::pre_paint is called so the effect implementation should update any references to the texture after chaining-up to the parent's pre_paint implementation. This can be used instead of get_target() when the effect subclass wants to paint using its own material.
- Returns
- A Cogl::Handle or Cogl::INVALID_HANDLE. The returned texture is owned by Clutter and it should not be modified or freed.
|
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.
ClutterOffscreenEffect* Clutter::OffscreenEffect::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::OffscreenEffect::paint_target | ( | ) |
Calls the paint_target() virtual function of the effect.
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/offscreen-effect.h