isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-11-26 01:50:42 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix Effect subclassing section

Browse Source 
It still mentions the long since removed "prepare" function.
This commit is contained in:
Emmanuele Bassi 2010-06-10 17:34:48 +01:00
parent dc09fca264
commit 8d22fea31c
1 changed files with 5 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
clutter/clutter-effect.c
View File

@ -39,29 +39,17 @@
* <refsect2 id="ClutterEffect-implementation"> * <refsect2 id="ClutterEffect-implementation">
* <title>Implementing a ClutterEffect</title> * <title>Implementing a ClutterEffect</title>
* <para>Creating a sub-class of #ClutterEffect requires the implementation * <para>Creating a sub-class of #ClutterEffect requires the implementation
* of three virtual functions:</para> * of two virtual functions:</para>
* <itemizedlist> * <itemizedlist>
* <listitem><simpara><function>prepare()</function>, which is called when
* attaching the #ClutterEffect to a #ClutterActor through the
* clutter_actor_add_effect() function or when the actor is being
* painted;</simpara></listitem>
* <listitem><simpara><function>pre_paint()</function>, which is called * <listitem><simpara><function>pre_paint()</function>, which is called
* before painting the #ClutterActor.</simpara></listitem> * before painting the #ClutterActor.</simpara></listitem>
* <listitem><simpara><function>post_paint()</function>, which is called * <listitem><simpara><function>post_paint()</function>, which is called
* after painting the #ClutterActor.</simpara></listitem> * after painting the #ClutterActor.</simpara></listitem>
* </itemizedlist> * </itemizedlist>
* <para>The <function>prepare()</function> function receives the
* #ClutterActor to which the effect has been attached to, and it should be
* used to set up the initial state of the effect, for instance depending on
* the actor that has been passed. The function returns a boolean value,
* which is used to determine whether the #ClutterEffect has been prepared or
* not. An unprepared shader will be asked to prepare itself again during the
* actor's paint sequence, and if it fails again it will be ignored.</para>
* <para>The <function>pre_paint()</function> function should be used to set * <para>The <function>pre_paint()</function> function should be used to set
* up the #ClutterEffect right before the #ClutterActor's paint * up the #ClutterEffect right before the #ClutterActor's paint
* sequence. This function, like <function>prepare()</function> can fail, and * sequence. This function can fail, and return %FALSE; in that case, no
* return %FALSE; in that case, no <function>post_paint()</function> * <function>post_paint()</function> invocation will follow.</para>
* invocation will follow.</para>
* <para>The <function>post_paint()</function> function is called after the * <para>The <function>post_paint()</function> function is called after the
* #ClutterActor's paint sequence.</para> * #ClutterActor's paint sequence.</para>
* <para>The <function>pre_paint()</function> phase could be seen as a custom * <para>The <function>pre_paint()</function> phase could be seen as a custom
@ -73,8 +61,8 @@
* <title>A simple ClutterEffect implementation</title> * <title>A simple ClutterEffect implementation</title>
* <para>The example below creates two rectangles: one will be painted * <para>The example below creates two rectangles: one will be painted
* "behind" the actor, while another will be painted "on top" of the actor. * "behind" the actor, while another will be painted "on top" of the actor.
* The <function>prepare()</function> phase will create the two materials * The <function>set_actor()</function> implementation will create the two
* used for the two different rectangles; the * materials used for the two different rectangles; the
* <function>pre_paint()</function> function will paint the first material * <function>pre_paint()</function> function will paint the first material
* using cogl_rectangle(), while the <function>post_paint()</function> * using cogl_rectangle(), while the <function>post_paint()</function>
* phase will paint the second material.</para> * phase will paint the second material.</para>