diff options
author | Emmanuele Bassi <ebassi@gnome.org> | 2014-03-17 23:07:58 +0000 |
---|---|---|
committer | Emmanuele Bassi <ebassi@gnome.org> | 2014-03-17 23:07:58 +0000 |
commit | 12370bd4f8246f72abe75fae90fdee452c7a8f58 (patch) | |
tree | 86b66fda33584a6cc67362d653a96bf31108bbc8 /clutter/clutter-offscreen-effect.c | |
parent | 115104db8cec7defb010802186430695f0cac77b (diff) | |
download | clutter-12370bd4f8246f72abe75fae90fdee452c7a8f58.tar.gz |
docs: Move to markdown
We're removing docbook tags in favour of the markdown syntax.
Diffstat (limited to 'clutter/clutter-offscreen-effect.c')
-rw-r--r-- | clutter/clutter-offscreen-effect.c | 41 |
1 files changed, 21 insertions, 20 deletions
diff --git a/clutter/clutter-offscreen-effect.c b/clutter/clutter-offscreen-effect.c index de7191294..c30811339 100644 --- a/clutter/clutter-offscreen-effect.c +++ b/clutter/clutter-offscreen-effect.c @@ -40,25 +40,26 @@ * offscreen framebuffer, the redirection and the final paint of the texture on * the desired stage. * - * <refsect2 id="ClutterOffscreenEffect-implementing"> - * <title>Implementing a ClutterOffscreenEffect</title> - * <para>Creating a sub-class of #ClutterOffscreenEffect requires, in case - * of overriding the #ClutterEffect virtual functions, to chain up to the - * #ClutterOffscreenEffect's implementation.</para> - * <para>On top of the #ClutterEffect's virtual functions, - * #ClutterOffscreenEffect also provides a #ClutterOffscreenEffectClass.paint_target() - * function, which encapsulates the effective painting of the texture that - * contains the result of the offscreen redirection.</para> - * <para>The size of the target material is defined to be as big as the - * transformed size of the #ClutterActor using the offscreen effect. - * Sub-classes of #ClutterOffscreenEffect can change the texture creation - * code to provide bigger textures by overriding the - * #ClutterOffscreenEffectClass.create_texture() virtual function; no chain up - * to the #ClutterOffscreenEffect implementation is required in this - * case.</para> - * </refsect2> - * * #ClutterOffscreenEffect is available since Clutter 1.4 + * + * ## Implementing a ClutterOffscreenEffect + * + * Creating a sub-class of #ClutterOffscreenEffect requires, in case + * of overriding the #ClutterEffect virtual functions, to chain up to the + * #ClutterOffscreenEffect's implementation. + * + * On top of the #ClutterEffect's virtual functions, + * #ClutterOffscreenEffect also provides a #ClutterOffscreenEffectClass.paint_target() + * function, which encapsulates the effective painting of the texture that + * contains the result of the offscreen redirection. + * + * The size of the target material is defined to be as big as the + * transformed size of the #ClutterActor using the offscreen effect. + * Sub-classes of #ClutterOffscreenEffect can change the texture creation + * code to provide bigger textures by overriding the + * #ClutterOffscreenEffectClass.create_texture() virtual function; no chain up + * to the #ClutterOffscreenEffect implementation is required in this + * case. */ #ifdef HAVE_CONFIG_H @@ -596,7 +597,7 @@ clutter_offscreen_effect_create_texture (ClutterOffscreenEffect *effect, * paint the actor to which it has been applied. * * This function should only be called by #ClutterOffscreenEffect - * implementations, from within the <function>paint_target()</function> + * implementations, from within the #ClutterOffscreenEffectClass.paint_target() * virtual function. * * Return value: %TRUE if the offscreen buffer has a valid size, @@ -638,7 +639,7 @@ clutter_offscreen_effect_get_target_size (ClutterOffscreenEffect *effect, * paint the actor to which it has been applied. * * This function should only be called by #ClutterOffscreenEffect - * implementations, from within the <function>paint_target()</function> + * implementations, from within the #ClutterOffscreenEffectClass.paint_target() * virtual function. * * Return value: %TRUE if the offscreen buffer has a valid rectangle, |