Clutter.DeformEffect

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

Subclasses:Clutter.PageTurnEffect

Properties

Inherited:Clutter.ActorMeta (3)
Name Type Flags Short Description
x-tiles int r/w The number of horizontal tiles
y-tiles int r/w The number of vertical tiles

Signals

Inherited:GObject.Object (1)

Fields

Inherited:GObject.Object (1)
Name Type Access Description
parent_instance Clutter.OffscreenEffect r  

Class Details

class Clutter.DeformEffect(**kwargs)
Bases:Clutter.OffscreenEffect
Abstract:Yes
Structure:Clutter.DeformEffectClass

The Clutter.DeformEffect structure contains only private data and should be accessed using the provided API

New in version 1.4.

get_back_material()
Returns:a handle for the material, or None. The returned material is owned by the Clutter.DeformEffect and it should not be freed directly
Return type:object

Retrieves the handle to the back face material used by self

New in version 1.4.

get_n_tiles()
Returns:
x_tiles:return location for the number of horizontal tiles, or None
y_tiles:return location for the number of vertical tiles, or None
Return type:(x_tiles: int, y_tiles: int)

Retrieves the number of horizontal and vertical tiles used to sub-divide the actor’s geometry during the effect

New in version 1.4.

invalidate()

Invalidates the self ‘s vertices and, if it is associated to an actor, it will queue a redraw

New in version 1.4.

set_back_material(material)
Parameters:material (object or None) – a handle to a Cogl 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

New in version 1.4.

set_n_tiles(x_tiles, y_tiles)
Parameters:
  • x_tiles (int) – number of horizontal tiles
  • y_tiles (int) – number of vertical 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

New in version 1.4.

do_deform_vertex(width, height, vertex) virtual
Parameters:

Property Details

Clutter.DeformEffect.props.x_tiles
Name:x-tiles
Type:int
Default Value:32
Flags:READABLE, WRITABLE

The number of horizontal tiles. The bigger the number, the smaller the tiles

New in version 1.4.

Clutter.DeformEffect.props.y_tiles
Name:y-tiles
Type:int
Default Value:32
Flags:READABLE, WRITABLE

The number of vertical tiles. The bigger the number, the smaller the tiles

New in version 1.4.