doc/reference/clutter/html/ClutterStage.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>ClutterStage</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="Clutter Reference Manual">
   8 <link rel="up" href="ch02.html" title="Base actors">
   9 <link rel="prev" href="ch02.html" title="Base actors">
  10 <link rel="next" href="ClutterTexture.html" title="ClutterTexture">
  11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="ch02.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">Clutter Reference Manual</th>
  21 <td><a accesskey="n" href="ClutterTexture.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#ClutterStage.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterStage.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterStage.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterStage.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#ClutterStage.properties" class="shortcut">Properties</a>
  33                    |
  34                   <a href="#ClutterStage.signals" class="shortcut">Signals</a>
  35 </td></tr>
  36 </table>
  37 <div class="refentry">
  38 <a name="ClutterStage"></a><div class="titlepage"></div>
  39 <div class="refnamediv"><table width="100%"><tr>
  40 <td valign="top">
  41 <h2><span class="refentrytitle"><a name="ClutterStage.top_of_page"></a>ClutterStage</span></h2>
  42 <p>ClutterStage — Top level visual element to which actors are placed.</p>
  43 </td>
  44 <td valign="top" align="right"></td>
  45 </tr></table></div>
  46 <div class="refsynopsisdiv">
  47 <a name="ClutterStage.synopsis"></a><h2>Synopsis</h2>
  48 <pre class="synopsis">                    <a class="link" href="ClutterStage.html#ClutterStage-struct" title="ClutterStage">ClutterStage</a>;
  49 struct              <a class="link" href="ClutterStage.html#ClutterStageClass" title="struct ClutterStageClass">ClutterStageClass</a>;
  50 #define             <a class="link" href="ClutterStage.html#CLUTTER-STAGE-WIDTH:CAPS" title="CLUTTER_STAGE_WIDTH">CLUTTER_STAGE_WIDTH</a>
  51 #define             <a class="link" href="ClutterStage.html#CLUTTER-STAGE-HEIGHT:CAPS" title="CLUTTER_STAGE_HEIGHT">CLUTTER_STAGE_HEIGHT</a>
  52 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="ClutterStage.html#clutter-stage-get-default" title="clutter_stage_get_default ()">clutter_stage_get_default</a>           (<em class="parameter"><code><span class="type">void</span></code></em>);
  53 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="ClutterStage.html#clutter-stage-new" title="clutter_stage_new ()">clutter_stage_new</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
  54 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ClutterStage.html#clutter-stage-is-default" title="clutter_stage_is_default ()">clutter_stage_is_default</a>            (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
  55
  56 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-set-color" title="clutter_stage_set_color ()">clutter_stage_set_color</a>             (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
  57                                                          <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
  58 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-get-color" title="clutter_stage_get_color ()">clutter_stage_get_color</a>             (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
  59                                                          <em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
  60 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-set-fullscreen" title="clutter_stage_set_fullscreen ()">clutter_stage_set_fullscreen</a>        (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
  61                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> fullscreen</code></em>);
  62 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ClutterStage.html#clutter-stage-get-fullscreen" title="clutter_stage_get_fullscreen ()">clutter_stage_get_fullscreen</a>        (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
  63 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-show-cursor" title="clutter_stage_show_cursor ()">clutter_stage_show_cursor</a>           (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
  64 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-hide-cursor" title="clutter_stage_hide_cursor ()">clutter_stage_hide_cursor</a>           (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
  65 enum                <a class="link" href="ClutterStage.html#ClutterPickMode" title="enum ClutterPickMode">ClutterPickMode</a>;
  66 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="ClutterStage.html#clutter-stage-get-actor-at-pos" title="clutter_stage_get_actor_at_pos ()">clutter_stage_get_actor_at_pos</a>      (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
  67                                                          <em class="parameter"><code><a class="link" href="ClutterStage.html#ClutterPickMode" title="enum ClutterPickMode"><span class="type">ClutterPickMode</span></a> pick_mode</code></em>,
  68                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
  69                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>);
  70 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-ensure-current" title="clutter_stage_ensure_current ()">clutter_stage_ensure_current</a>        (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
  71 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-ensure-viewport" title="clutter_stage_ensure_viewport ()">clutter_stage_ensure_viewport</a>       (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
  72 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-ensure-redraw" title="clutter_stage_ensure_redraw ()">clutter_stage_ensure_redraw</a>         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
  73 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-queue-redraw" title="clutter_stage_queue_redraw ()">clutter_stage_queue_redraw</a>          (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
  74 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-actor-queue-redraw-with-clip" title="clutter_actor_queue_redraw_with_clip ()">clutter_actor_queue_redraw_with_clip</a>
  75                                                         (<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *self</code></em>,
  76                                                          <em class="parameter"><code>const <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/cairo/cairo-Types.html#cairo-rectangle-int-t"><span class="type">cairo_rectangle_int_t</span></a> *clip</code></em>);
  77 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ClutterStage.html#clutter-stage-event" title="clutter_stage_event ()">clutter_stage_event</a>                 (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
  78                                                          <em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);
  79 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-set-key-focus" title="clutter_stage_set_key_focus ()">clutter_stage_set_key_focus</a>         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
  80                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);
  81 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="ClutterStage.html#clutter-stage-get-key-focus" title="clutter_stage_get_key_focus ()">clutter_stage_get_key_focus</a>         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
  82 <a href="../glib/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> *            <a class="link" href="ClutterStage.html#clutter-stage-read-pixels" title="clutter_stage_read_pixels ()">clutter_stage_read_pixels</a>           (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
  83                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
  84                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
  85                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
  86                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>);
  87 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-set-throttle-motion-events" title="clutter_stage_set_throttle_motion_events ()">clutter_stage_set_throttle_motion_events</a>
  88                                                         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
  89                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> throttle</code></em>);
  90 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ClutterStage.html#clutter-stage-get-throttle-motion-events" title="clutter_stage_get_throttle_motion_events ()">clutter_stage_get_throttle_motion_events</a>
  91                                                         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
  92 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-set-use-alpha" title="clutter_stage_set_use_alpha ()">clutter_stage_set_use_alpha</a>         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
  93                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> use_alpha</code></em>);
  94 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ClutterStage.html#clutter-stage-get-use-alpha" title="clutter_stage_get_use_alpha ()">clutter_stage_get_use_alpha</a>         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
  95 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-set-minimum-size" title="clutter_stage_set_minimum_size ()">clutter_stage_set_minimum_size</a>      (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
  96                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> width</code></em>,
  97                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> height</code></em>);
  98 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-get-minimum-size" title="clutter_stage_get_minimum_size ()">clutter_stage_get_minimum_size</a>      (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
  99                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *width</code></em>,
 100                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *height</code></em>);
 101 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-set-no-clear-hint" title="clutter_stage_set_no_clear_hint ()">clutter_stage_set_no_clear_hint</a>     (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 102                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> no_clear</code></em>);
 103 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ClutterStage.html#clutter-stage-get-no-clear-hint" title="clutter_stage_get_no_clear_hint ()">clutter_stage_get_no_clear_hint</a>     (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
 104 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-get-redraw-clip-bounds" title="clutter_stage_get_redraw_clip_bounds ()">clutter_stage_get_redraw_clip_bounds</a>
 105                                                         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 106                                                          <em class="parameter"><code><a href="/home/ebassi/gnome3/install/share/gtk-doc/html/cairo/cairo-Types.html#cairo-rectangle-int-t"><span class="type">cairo_rectangle_int_t</span></a> *clip</code></em>);
 107 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-set-accept-focus" title="clutter_stage_set_accept_focus ()">clutter_stage_set_accept_focus</a>      (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 108                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> accept_focus</code></em>);
 109 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ClutterStage.html#clutter-stage-get-accept-focus" title="clutter_stage_get_accept_focus ()">clutter_stage_get_accept_focus</a>      (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
 110 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ClutterStage.html#clutter-stage-get-motion-events-enabled" title="clutter_stage_get_motion_events_enabled ()">clutter_stage_get_motion_events_enabled</a>
 111                                                         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
 112 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-set-motion-events-enabled" title="clutter_stage_set_motion_events_enabled ()">clutter_stage_set_motion_events_enabled</a>
 113                                                         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 114                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enabled</code></em>);
 115
 116                     <a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective">ClutterPerspective</a>;
 117 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-set-perspective" title="clutter_stage_set_perspective ()">clutter_stage_set_perspective</a>       (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 118                                                          <em class="parameter"><code><a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective"><span class="type">ClutterPerspective</span></a> *perspective</code></em>);
 119 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-get-perspective" title="clutter_stage_get_perspective ()">clutter_stage_get_perspective</a>       (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 120                                                          <em class="parameter"><code><a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective"><span class="type">ClutterPerspective</span></a> *perspective</code></em>);
 121
 122 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-set-title" title="clutter_stage_set_title ()">clutter_stage_set_title</a>             (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 123                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>);
 124 const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="ClutterStage.html#clutter-stage-get-title" title="clutter_stage_get_title ()">clutter_stage_get_title</a>             (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
 125 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-set-user-resizable" title="clutter_stage_set_user_resizable ()">clutter_stage_set_user_resizable</a>    (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 126                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> resizable</code></em>);
 127 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ClutterStage.html#clutter-stage-get-user-resizable" title="clutter_stage_get_user_resizable ()">clutter_stage_get_user_resizable</a>    (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
 128
 129                     <a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog">ClutterFog</a>;
 130 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-set-use-fog" title="clutter_stage_set_use_fog ()">clutter_stage_set_use_fog</a>           (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 131                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> fog</code></em>);
 132 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ClutterStage.html#clutter-stage-get-use-fog" title="clutter_stage_get_use_fog ()">clutter_stage_get_use_fog</a>           (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
 133 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-set-fog" title="clutter_stage_set_fog ()">clutter_stage_set_fog</a>               (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 134                                                          <em class="parameter"><code><a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog"><span class="type">ClutterFog</span></a> *fog</code></em>);
 135 <span class="returnvalue">void</span>                <a class="link" href="ClutterStage.html#clutter-stage-get-fog" title="clutter_stage_get_fog ()">clutter_stage_get_fog</a>               (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 136                                                          <em class="parameter"><code><a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog"><span class="type">ClutterFog</span></a> *fog</code></em>);
 137 </pre>
 138 </div>
 139 <div class="refsect1">
 140 <a name="ClutterStage.object-hierarchy"></a><h2>Object Hierarchy</h2>
 141 <pre class="synopsis">
 142   <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 143    +----<a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 144          +----<a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
 145                +----<a class="link" href="ClutterGroup.html" title="ClutterGroup">ClutterGroup</a>
 146                      +----ClutterStage
 147 </pre>
 148 </div>
 149 <div class="refsect1">
 150 <a name="ClutterStage.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 151 <p>
 152 ClutterStage implements
 153  <a class="link" href="ClutterContainer.html" title="ClutterContainer">ClutterContainer</a>,  <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>,  <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable">ClutterAnimatable</a> and  AtkImplementorIface.</p>
 154 </div>
 155 <div class="refsect1">
 156 <a name="ClutterStage.properties"></a><h2>Properties</h2>
 157 <pre class="synopsis">
 158   "<a class="link" href="ClutterStage.html#ClutterStage--accept-focus" title='The "accept-focus" property'>accept-focus</a>"             <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 159   "<a class="link" href="ClutterStage.html#ClutterStage--color" title='The "color" property'>color</a>"                    <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>*         : Read / Write
 160   "<a class="link" href="ClutterStage.html#ClutterStage--cursor-visible" title='The "cursor-visible" property'>cursor-visible</a>"           <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 161   "<a class="link" href="ClutterStage.html#ClutterStage--fog" title='The "fog" property'>fog</a>"                      <a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog"><span class="type">ClutterFog</span></a>*           : Read / Write
 162   "<a class="link" href="ClutterStage.html#ClutterStage--fullscreen-set" title='The "fullscreen-set" property'>fullscreen-set</a>"           <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read
 163   "<a class="link" href="ClutterStage.html#ClutterStage--key-focus" title='The "key-focus" property'>key-focus</a>"                <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>*         : Read / Write
 164   "<a class="link" href="ClutterStage.html#ClutterStage--no-clear-hint" title='The "no-clear-hint" property'>no-clear-hint</a>"            <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 165   "<a class="link" href="ClutterStage.html#ClutterStage--offscreen" title='The "offscreen" property'>offscreen</a>"                <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 166   "<a class="link" href="ClutterStage.html#ClutterStage--perspective" title='The "perspective" property'>perspective</a>"              <a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective"><span class="type">ClutterPerspective</span></a>*   : Read / Write
 167   "<a class="link" href="ClutterStage.html#ClutterStage--title" title='The "title" property'>title</a>"                    <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
 168   "<a class="link" href="ClutterStage.html#ClutterStage--use-alpha" title='The "use-alpha" property'>use-alpha</a>"                <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 169   "<a class="link" href="ClutterStage.html#ClutterStage--use-fog" title='The "use-fog" property'>use-fog</a>"                  <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 170   "<a class="link" href="ClutterStage.html#ClutterStage--user-resizable" title='The "user-resizable" property'>user-resizable</a>"           <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 171 </pre>
 172 </div>
 173 <div class="refsect1">
 174 <a name="ClutterStage.signals"></a><h2>Signals</h2>
 175 <pre class="synopsis">
 176   "<a class="link" href="ClutterStage.html#ClutterStage-activate" title='The "activate" signal'>activate</a>"                                       : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 177   "<a class="link" href="ClutterStage.html#ClutterStage-deactivate" title='The "deactivate" signal'>deactivate</a>"                                     : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 178   "<a class="link" href="ClutterStage.html#ClutterStage-delete-event" title='The "delete-event" signal'>delete-event</a>"                                   : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 179   "<a class="link" href="ClutterStage.html#ClutterStage-fullscreen" title='The "fullscreen" signal'>fullscreen</a>"                                     : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
 180   "<a class="link" href="ClutterStage.html#ClutterStage-unfullscreen" title='The "unfullscreen" signal'>unfullscreen</a>"                                   : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 181 </pre>
 182 </div>
 183 <div class="refsect1">
 184 <a name="ClutterStage.description"></a><h2>Description</h2>
 185 <p>
 186 <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> is a top level 'window' on which child actors are placed
 187 and manipulated.
 188 </p>
 189 <p>
 190 Backends might provide support for multiple stages. The support for this
 191 feature can be checked at run-time using the <a class="link" href="clutter-Features.html#clutter-feature-available" title="clutter_feature_available ()"><code class="function">clutter_feature_available()</code></a>
 192 function and the <a class="link" href="clutter-Features.html#CLUTTER-FEATURE-STAGE-MULTIPLE:CAPS"><code class="literal">CLUTTER_FEATURE_STAGE_MULTIPLE</code></a> flag. If the backend used
 193 supports multiple stages, new <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> instances can be created
 194 using <a class="link" href="ClutterStage.html#clutter-stage-new" title="clutter_stage_new ()"><code class="function">clutter_stage_new()</code></a>. These stages must be managed by the developer
 195 using <a class="link" href="ClutterActor.html#clutter-actor-destroy" title="clutter_actor_destroy ()"><code class="function">clutter_actor_destroy()</code></a>, which will take care of destroying all the
 196 actors contained inside them.
 197 </p>
 198 <p>
 199 <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> is a proxy actor, wrapping the backend-specific
 200 implementation of the windowing system. It is possible to subclass
 201 <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>, as long as every overridden virtual function chains up to
 202 the parent class corresponding function.
 203 </p>
 204 </div>
 205 <div class="refsect1">
 206 <a name="ClutterStage.details"></a><h2>Details</h2>
 207 <div class="refsect2">
 208 <a name="ClutterStage-struct"></a><h3>ClutterStage</h3>
 209 <pre class="programlisting">typedef struct _ClutterStage ClutterStage;</pre>
 210 <p>
 211 The <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> structure contains only private data
 212 and should be accessed using the provided API
 213 </p>
 214 <p class="since">Since 0.1</p>
 215 </div>
 216 <hr>
 217 <div class="refsect2">
 218 <a name="ClutterStageClass"></a><h3>struct ClutterStageClass</h3>
 219 <pre class="programlisting">struct ClutterStageClass {
 220   /* signals */
 221   void (* fullscreen)   (ClutterStage *stage);
 222   void (* unfullscreen) (ClutterStage *stage);
 223   void (* activate)     (ClutterStage *stage);
 224   void (* deactivate)   (ClutterStage *stage);
 225
 226   gboolean (* delete_event) (ClutterStage *stage,
 227                              ClutterEvent *event);
 228 };
 229 </pre>
 230 <p>
 231 The <a class="link" href="ClutterStage.html#ClutterStageClass" title="struct ClutterStageClass"><span class="type">ClutterStageClass</span></a> structure contains only private data
 232 </p>
 233 <div class="variablelist"><table border="0">
 234 <col align="left" valign="top">
 235 <tbody>
 236 <tr>
 237 <td><p><span class="term"><em class="structfield"><code><a name="ClutterStageClass.fullscreen"></a>fullscreen</code></em> ()</span></p></td>
 238 <td>handler for the <a class="link" href="ClutterStage.html#ClutterStage-fullscreen" title='The "fullscreen" signal'><span class="type">"fullscreen"</span></a> signal</td>
 239 </tr>
 240 <tr>
 241 <td><p><span class="term"><em class="structfield"><code><a name="ClutterStageClass.unfullscreen"></a>unfullscreen</code></em> ()</span></p></td>
 242 <td>handler for the <a class="link" href="ClutterStage.html#ClutterStage-unfullscreen" title='The "unfullscreen" signal'><span class="type">"unfullscreen"</span></a> signal</td>
 243 </tr>
 244 <tr>
 245 <td><p><span class="term"><em class="structfield"><code><a name="ClutterStageClass.activate"></a>activate</code></em> ()</span></p></td>
 246 <td>handler for the <a class="link" href="ClutterStage.html#ClutterStage-activate" title='The "activate" signal'><span class="type">"activate"</span></a> signal</td>
 247 </tr>
 248 <tr>
 249 <td><p><span class="term"><em class="structfield"><code><a name="ClutterStageClass.deactivate"></a>deactivate</code></em> ()</span></p></td>
 250 <td>handler for the <a class="link" href="ClutterStage.html#ClutterStage-deactivate" title='The "deactivate" signal'><span class="type">"deactivate"</span></a> signal</td>
 251 </tr>
 252 <tr>
 253 <td><p><span class="term"><em class="structfield"><code><a name="ClutterStageClass.delete-event"></a>delete_event</code></em> ()</span></p></td>
 254 <td>handler for the <a class="link" href="ClutterStage.html#ClutterStage-delete-event" title='The "delete-event" signal'><span class="type">"delete-event"</span></a> signal</td>
 255 </tr>
 256 </tbody>
 257 </table></div>
 258 <p class="since">Since 0.1</p>
 259 </div>
 260 <hr>
 261 <div class="refsect2">
 262 <a name="CLUTTER-STAGE-WIDTH:CAPS"></a><h3>CLUTTER_STAGE_WIDTH</h3>
 263 <pre class="programlisting">#define CLUTTER_STAGE_WIDTH()           (clutter_actor_get_width (clutter_stage_get_default ()))
 264 </pre>
 265 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 266 <h3 class="title">Warning</h3>
 267 <p><code class="literal">CLUTTER_STAGE_WIDTH</code> has been deprecated since version 1.2 and should not be used in newly-written code. Use <a class="link" href="ClutterActor.html#clutter-actor-get-width" title="clutter_actor_get_width ()"><code class="function">clutter_actor_get_width()</code></a> instead</p>
 268 </div>
 269 <p>
 270 Macro that evaluates to the width of the default stage
 271 </p>
 272 <p class="since">Since 0.2</p>
 273 </div>
 274 <hr>
 275 <div class="refsect2">
 276 <a name="CLUTTER-STAGE-HEIGHT:CAPS"></a><h3>CLUTTER_STAGE_HEIGHT</h3>
 277 <pre class="programlisting">#define CLUTTER_STAGE_HEIGHT()          (clutter_actor_get_height (clutter_stage_get_default ()))
 278 </pre>
 279 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 280 <h3 class="title">Warning</h3>
 281 <p><code class="literal">CLUTTER_STAGE_HEIGHT</code> has been deprecated since version 1.2 and should not be used in newly-written code. use <a class="link" href="ClutterActor.html#clutter-actor-get-height" title="clutter_actor_get_height ()"><code class="function">clutter_actor_get_height()</code></a> instead</p>
 282 </div>
 283 <p>
 284 Macro that evaluates to the height of the default stage
 285 </p>
 286 <p class="since">Since 0.2</p>
 287 </div>
 288 <hr>
 289 <div class="refsect2">
 290 <a name="clutter-stage-get-default"></a><h3>clutter_stage_get_default ()</h3>
 291 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_stage_get_default           (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 292 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 293 <h3 class="title">Warning</h3>
 294 <p><code class="literal">clutter_stage_get_default</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use <a class="link" href="ClutterStage.html#clutter-stage-new" title="clutter_stage_new ()"><code class="function">clutter_stage_new()</code></a> instead.</p>
 295 </div>
 296 <p>
 297 Retrieves a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> singleton.
 298 </p>
 299 <p>
 300 This function is not as useful as it sounds, and will most likely
 301 by deprecated in the future. Application code should only create
 302 a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> instance using <a class="link" href="ClutterStage.html#clutter-stage-new" title="clutter_stage_new ()"><code class="function">clutter_stage_new()</code></a>, and manage the
 303 lifetime of the stage manually.
 304 </p>
 305 <p>
 306 The default stage singleton has a platform-specific behaviour: on
 307 platforms without the <a class="link" href="clutter-Features.html#CLUTTER-FEATURE-STAGE-MULTIPLE:CAPS"><code class="literal">CLUTTER_FEATURE_STAGE_MULTIPLE</code></a> feature flag
 308 set, the first <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> instance will also be set to be the
 309 default stage instance, and this function will always return a
 310 pointer to it.
 311 </p>
 312 <p>
 313 On platforms with the <a class="link" href="clutter-Features.html#CLUTTER-FEATURE-STAGE-MULTIPLE:CAPS"><code class="literal">CLUTTER_FEATURE_STAGE_MULTIPLE</code></a> feature flag
 314 set, the default stage will be created by the first call to this
 315 function, and every following call will return the same pointer to
 316 it.
 317 </p>
 318 <div class="variablelist"><table border="0">
 319 <col align="left" valign="top">
 320 <tbody><tr>
 321 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 322 <td>the main
 323 <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>. You should never destroy or unref the returned
 324 actor. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Clutter.Stage]</span>
 325 </td>
 326 </tr></tbody>
 327 </table></div>
 328 </div>
 329 <hr>
 330 <div class="refsect2">
 331 <a name="clutter-stage-new"></a><h3>clutter_stage_new ()</h3>
 332 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_stage_new                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 333 <p>
 334 Creates a new, non-default stage. A non-default stage is a new
 335 top-level actor which can be used as another container. It works
 336 exactly like the default stage, but while <a class="link" href="ClutterStage.html#clutter-stage-get-default" title="clutter_stage_get_default ()"><code class="function">clutter_stage_get_default()</code></a>
 337 will always return the same instance, you will have to keep a pointer
 338 to any <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> returned by <a class="link" href="ClutterStage.html#clutter-stage-new" title="clutter_stage_new ()"><code class="function">clutter_stage_new()</code></a>.
 339 </p>
 340 <p>
 341 The ability to support multiple stages depends on the current
 342 backend. Use <a class="link" href="clutter-Features.html#clutter-feature-available" title="clutter_feature_available ()"><code class="function">clutter_feature_available()</code></a> and
 343 <a class="link" href="clutter-Features.html#CLUTTER-FEATURE-STAGE-MULTIPLE:CAPS"><code class="literal">CLUTTER_FEATURE_STAGE_MULTIPLE</code></a> to check at runtime whether a
 344 backend supports multiple stages.
 345 </p>
 346 <div class="variablelist"><table border="0">
 347 <col align="left" valign="top">
 348 <tbody><tr>
 349 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 350 <td>a new stage, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if the default backend does
 351 not support multiple stages. Use <a class="link" href="ClutterActor.html#clutter-actor-destroy" title="clutter_actor_destroy ()"><code class="function">clutter_actor_destroy()</code></a> to
 352 programmatically close the returned stage.</td>
 353 </tr></tbody>
 354 </table></div>
 355 <p class="since">Since 0.8</p>
 356 </div>
 357 <hr>
 358 <div class="refsect2">
 359 <a name="clutter-stage-is-default"></a><h3>clutter_stage_is_default ()</h3>
 360 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_stage_is_default            (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
 361 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 362 <h3 class="title">Warning</h3>
 363 <p><code class="literal">clutter_stage_is_default</code> has been deprecated since version 1.10 and should not be used in newly-written code. Track the stage pointer inside your application
 364   code, or use <a class="link" href="ClutterActor.html#clutter-actor-get-stage" title="clutter_actor_get_stage ()"><code class="function">clutter_actor_get_stage()</code></a> to retrieve the stage for
 365   a given actor.</p>
 366 </div>
 367 <p>
 368 Checks if <em class="parameter"><code>stage</code></em> is the default stage, or an instance created using
 369 <a class="link" href="ClutterStage.html#clutter-stage-new" title="clutter_stage_new ()"><code class="function">clutter_stage_new()</code></a> but internally using the same implementation.
 370 </p>
 371 <div class="variablelist"><table border="0">
 372 <col align="left" valign="top">
 373 <tbody>
 374 <tr>
 375 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 376 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 377 </td>
 378 </tr>
 379 <tr>
 380 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 381 <td>
 382 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the passed stage is the default one</td>
 383 </tr>
 384 </tbody>
 385 </table></div>
 386 <p class="since">Since 0.8</p>
 387 </div>
 388 <hr>
 389 <div class="refsect2">
 390 <a name="clutter-stage-set-color"></a><h3>clutter_stage_set_color ()</h3>
 391 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_color             (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 392                                                          <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
 393 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 394 <h3 class="title">Warning</h3>
 395 <p><code class="literal">clutter_stage_set_color</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use <a class="link" href="ClutterActor.html#clutter-actor-set-background-color" title="clutter_actor_set_background_color ()"><code class="function">clutter_actor_set_background_color()</code></a> instead.</p>
 396 </div>
 397 <p>
 398 Sets the stage color.
 399 </p>
 400 <div class="variablelist"><table border="0">
 401 <col align="left" valign="top">
 402 <tbody>
 403 <tr>
 404 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 405 <td>A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 406 </td>
 407 </tr>
 408 <tr>
 409 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
 410 <td>A <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>
 411 </td>
 412 </tr>
 413 </tbody>
 414 </table></div>
 415 </div>
 416 <hr>
 417 <div class="refsect2">
 418 <a name="clutter-stage-get-color"></a><h3>clutter_stage_get_color ()</h3>
 419 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_get_color             (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 420                                                          <em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
 421 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 422 <h3 class="title">Warning</h3>
 423 <p><code class="literal">clutter_stage_get_color</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use <a class="link" href="ClutterActor.html#clutter-actor-get-background-color" title="clutter_actor_get_background_color ()"><code class="function">clutter_actor_get_background_color()</code></a> instead.</p>
 424 </div>
 425 <p>
 426 Retrieves the stage color.
 427 </p>
 428 <div class="variablelist"><table border="0">
 429 <col align="left" valign="top">
 430 <tbody>
 431 <tr>
 432 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 433 <td>A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 434 </td>
 435 </tr>
 436 <tr>
 437 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
 438 <td>return location for a <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>. <span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span>
 439 </td>
 440 </tr>
 441 </tbody>
 442 </table></div>
 443 </div>
 444 <hr>
 445 <div class="refsect2">
 446 <a name="clutter-stage-set-fullscreen"></a><h3>clutter_stage_set_fullscreen ()</h3>
 447 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_fullscreen        (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 448                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> fullscreen</code></em>);</pre>
 449 <p>
 450 Asks to place the stage window in the fullscreen or unfullscreen
 451 states.
 452 </p>
 453 <p>
 454  ( Note that you shouldn't assume the window is definitely full screen
 455 afterward, because other entities (e.g. the user or window manager)
 456 could unfullscreen it again, and not all window managers honor
 457 requests to fullscreen windows.
 458 </p>
 459 <p>
 460 If you want to receive notification of the fullscreen state you
 461 should either use the <a class="link" href="ClutterStage.html#ClutterStage-fullscreen" title='The "fullscreen" signal'><span class="type">"fullscreen"</span></a> and
 462 <a class="link" href="ClutterStage.html#ClutterStage-unfullscreen" title='The "unfullscreen" signal'><span class="type">"unfullscreen"</span></a> signals, or use the notify signal
 463 for the <a class="link" href="ClutterStage.html#ClutterStage--fullscreen-set" title='The "fullscreen-set" property'><span class="type">"fullscreen-set"</span></a> property
 464 </p>
 465 <div class="variablelist"><table border="0">
 466 <col align="left" valign="top">
 467 <tbody>
 468 <tr>
 469 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 470 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 471 </td>
 472 </tr>
 473 <tr>
 474 <td><p><span class="term"><em class="parameter"><code>fullscreen</code></em> :</span></p></td>
 475 <td>
 476 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to to set the stage fullscreen</td>
 477 </tr>
 478 </tbody>
 479 </table></div>
 480 <p class="since">Since 1.0</p>
 481 </div>
 482 <hr>
 483 <div class="refsect2">
 484 <a name="clutter-stage-get-fullscreen"></a><h3>clutter_stage_get_fullscreen ()</h3>
 485 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_stage_get_fullscreen        (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
 486 <p>
 487 Retrieves whether the stage is full screen or not
 488 </p>
 489 <div class="variablelist"><table border="0">
 490 <col align="left" valign="top">
 491 <tbody>
 492 <tr>
 493 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 494 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 495 </td>
 496 </tr>
 497 <tr>
 498 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 499 <td>
 500 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the stage is full screen</td>
 501 </tr>
 502 </tbody>
 503 </table></div>
 504 <p class="since">Since 1.0</p>
 505 </div>
 506 <hr>
 507 <div class="refsect2">
 508 <a name="clutter-stage-show-cursor"></a><h3>clutter_stage_show_cursor ()</h3>
 509 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_show_cursor           (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
 510 <p>
 511 Shows the cursor on the stage window
 512 </p>
 513 <div class="variablelist"><table border="0">
 514 <col align="left" valign="top">
 515 <tbody><tr>
 516 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 517 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 518 </td>
 519 </tr></tbody>
 520 </table></div>
 521 </div>
 522 <hr>
 523 <div class="refsect2">
 524 <a name="clutter-stage-hide-cursor"></a><h3>clutter_stage_hide_cursor ()</h3>
 525 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_hide_cursor           (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
 526 <p>
 527 Makes the cursor invisible on the stage window
 528 </p>
 529 <div class="variablelist"><table border="0">
 530 <col align="left" valign="top">
 531 <tbody><tr>
 532 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 533 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 534 </td>
 535 </tr></tbody>
 536 </table></div>
 537 <p class="since">Since 0.4</p>
 538 </div>
 539 <hr>
 540 <div class="refsect2">
 541 <a name="ClutterPickMode"></a><h3>enum ClutterPickMode</h3>
 542 <pre class="programlisting">typedef enum {
 543   CLUTTER_PICK_NONE = 0,
 544   CLUTTER_PICK_REACTIVE,
 545   CLUTTER_PICK_ALL
 546 } ClutterPickMode;
 547 </pre>
 548 <p>
 549 Controls the paint cycle of the scene graph when in pick mode
 550 </p>
 551 <div class="variablelist"><table border="0">
 552 <col align="left" valign="top">
 553 <tbody>
 554 <tr>
 555 <td><p><a name="CLUTTER-PICK-NONE:CAPS"></a><span class="term"><code class="literal">CLUTTER_PICK_NONE</code></span></p></td>
 556 <td>Do not paint any actor
 557 </td>
 558 </tr>
 559 <tr>
 560 <td><p><a name="CLUTTER-PICK-REACTIVE:CAPS"></a><span class="term"><code class="literal">CLUTTER_PICK_REACTIVE</code></span></p></td>
 561 <td>Paint only the reactive actors
 562 </td>
 563 </tr>
 564 <tr>
 565 <td><p><a name="CLUTTER-PICK-ALL:CAPS"></a><span class="term"><code class="literal">CLUTTER_PICK_ALL</code></span></p></td>
 566 <td>Paint all actors
 567 </td>
 568 </tr>
 569 </tbody>
 570 </table></div>
 571 <p class="since">Since 1.0</p>
 572 </div>
 573 <hr>
 574 <div class="refsect2">
 575 <a name="clutter-stage-get-actor-at-pos"></a><h3>clutter_stage_get_actor_at_pos ()</h3>
 576 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_stage_get_actor_at_pos      (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 577                                                          <em class="parameter"><code><a class="link" href="ClutterStage.html#ClutterPickMode" title="enum ClutterPickMode"><span class="type">ClutterPickMode</span></a> pick_mode</code></em>,
 578                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
 579                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>);</pre>
 580 <p>
 581 Checks the scene at the coordinates <em class="parameter"><code>x</code></em> and <em class="parameter"><code>y</code></em> and returns a pointer
 582 to the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> at those coordinates.
 583 </p>
 584 <p>
 585 By using <em class="parameter"><code>pick_mode</code></em> it is possible to control which actors will be
 586 painted and thus available.
 587 </p>
 588 <div class="variablelist"><table border="0">
 589 <col align="left" valign="top">
 590 <tbody>
 591 <tr>
 592 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 593 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 594 </td>
 595 </tr>
 596 <tr>
 597 <td><p><span class="term"><em class="parameter"><code>pick_mode</code></em> :</span></p></td>
 598 <td>how the scene graph should be painted</td>
 599 </tr>
 600 <tr>
 601 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
 602 <td>X coordinate to check</td>
 603 </tr>
 604 <tr>
 605 <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
 606 <td>Y coordinate to check</td>
 607 </tr>
 608 <tr>
 609 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 610 <td>the actor at the specified coordinates,
 611 if any. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 612 </td>
 613 </tr>
 614 </tbody>
 615 </table></div>
 616 </div>
 617 <hr>
 618 <div class="refsect2">
 619 <a name="clutter-stage-ensure-current"></a><h3>clutter_stage_ensure_current ()</h3>
 620 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_ensure_current        (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
 621 <p>
 622 This function essentially makes sure the right GL context is
 623 current for the passed stage. It is not intended to
 624 be used by applications.
 625 </p>
 626 <div class="variablelist"><table border="0">
 627 <col align="left" valign="top">
 628 <tbody><tr>
 629 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 630 <td>the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 631 </td>
 632 </tr></tbody>
 633 </table></div>
 634 <p class="since">Since 0.8</p>
 635 </div>
 636 <hr>
 637 <div class="refsect2">
 638 <a name="clutter-stage-ensure-viewport"></a><h3>clutter_stage_ensure_viewport ()</h3>
 639 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_ensure_viewport       (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
 640 <p>
 641 Ensures that the GL viewport is updated with the current
 642 stage window size.
 643 </p>
 644 <p>
 645 This function will queue a redraw of <em class="parameter"><code>stage</code></em>.
 646 </p>
 647 <p>
 648 This function should not be called by applications; it is used
 649 when embedding a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> into a toolkit with another
 650 windowing system, like GTK+.
 651 </p>
 652 <div class="variablelist"><table border="0">
 653 <col align="left" valign="top">
 654 <tbody><tr>
 655 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 656 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 657 </td>
 658 </tr></tbody>
 659 </table></div>
 660 <p class="since">Since 1.0</p>
 661 </div>
 662 <hr>
 663 <div class="refsect2">
 664 <a name="clutter-stage-ensure-redraw"></a><h3>clutter_stage_ensure_redraw ()</h3>
 665 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_ensure_redraw         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
 666 <p>
 667 Ensures that <em class="parameter"><code>stage</code></em> is redrawn
 668 </p>
 669 <p>
 670 This function should not be called by applications: it is
 671 used when embedding a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> into a toolkit with
 672 another windowing system, like GTK+.
 673 </p>
 674 <div class="variablelist"><table border="0">
 675 <col align="left" valign="top">
 676 <tbody><tr>
 677 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 678 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 679 </td>
 680 </tr></tbody>
 681 </table></div>
 682 <p class="since">Since 1.0</p>
 683 </div>
 684 <hr>
 685 <div class="refsect2">
 686 <a name="clutter-stage-queue-redraw"></a><h3>clutter_stage_queue_redraw ()</h3>
 687 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_queue_redraw          (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
 688 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 689 <h3 class="title">Warning</h3>
 690 <p><code class="literal">clutter_stage_queue_redraw</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use <a class="link" href="ClutterActor.html#clutter-actor-queue-redraw" title="clutter_actor_queue_redraw ()"><code class="function">clutter_actor_queue_redraw()</code></a> instead.</p>
 691 </div>
 692 <p>
 693 Queues a redraw for the passed stage.
 694 </p>
 695 <p>
 696 </p>
 697 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 698 <h3 class="title">Note</h3>Applications should call <a class="link" href="ClutterActor.html#clutter-actor-queue-redraw" title="clutter_actor_queue_redraw ()"><code class="function">clutter_actor_queue_redraw()</code></a> and not
 699 this function.</div>
 700 <p>
 701 </p>
 702 <div class="variablelist"><table border="0">
 703 <col align="left" valign="top">
 704 <tbody><tr>
 705 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 706 <td>the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 707 </td>
 708 </tr></tbody>
 709 </table></div>
 710 <p class="since">Since 0.8</p>
 711 </div>
 712 <hr>
 713 <div class="refsect2">
 714 <a name="clutter-actor-queue-redraw-with-clip"></a><h3>clutter_actor_queue_redraw_with_clip ()</h3>
 715 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_actor_queue_redraw_with_clip
 716                                                         (<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *self</code></em>,
 717                                                          <em class="parameter"><code>const <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/cairo/cairo-Types.html#cairo-rectangle-int-t"><span class="type">cairo_rectangle_int_t</span></a> *clip</code></em>);</pre>
 718 <p>
 719 Queues a redraw on <em class="parameter"><code>self</code></em> limited to a specific, actor-relative
 720 rectangular area.
 721 </p>
 722 <p>
 723 If <em class="parameter"><code>clip</code></em> is <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> this function is equivalent to
 724 <a class="link" href="ClutterActor.html#clutter-actor-queue-redraw" title="clutter_actor_queue_redraw ()"><code class="function">clutter_actor_queue_redraw()</code></a>.
 725 </p>
 726 <div class="variablelist"><table border="0">
 727 <col align="left" valign="top">
 728 <tbody>
 729 <tr>
 730 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 731 <td>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>
 732 </td>
 733 </tr>
 734 <tr>
 735 <td><p><span class="term"><em class="parameter"><code>clip</code></em> :</span></p></td>
 736 <td>a rectangular clip region, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 737 </td>
 738 </tr>
 739 </tbody>
 740 </table></div>
 741 <p class="since">Since 1.10</p>
 742 </div>
 743 <hr>
 744 <div class="refsect2">
 745 <a name="clutter-stage-event"></a><h3>clutter_stage_event ()</h3>
 746 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_stage_event                 (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 747                                                          <em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
 748 <p>
 749 This function is used to emit an event on the main stage.
 750 </p>
 751 <p>
 752 You should rarely need to use this function, except for
 753 synthetised events.
 754 </p>
 755 <div class="variablelist"><table border="0">
 756 <col align="left" valign="top">
 757 <tbody>
 758 <tr>
 759 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 760 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 761 </td>
 762 </tr>
 763 <tr>
 764 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
 765 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>
 766 </td>
 767 </tr>
 768 <tr>
 769 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 770 <td>the return value from the signal emission</td>
 771 </tr>
 772 </tbody>
 773 </table></div>
 774 <p class="since">Since 0.4</p>
 775 </div>
 776 <hr>
 777 <div class="refsect2">
 778 <a name="clutter-stage-set-key-focus"></a><h3>clutter_stage_set_key_focus ()</h3>
 779 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_key_focus         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 780                                                          <em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);</pre>
 781 <p>
 782 Sets the key focus on <em class="parameter"><code>actor</code></em>. An actor with key focus will receive
 783 all the key events. If <em class="parameter"><code>actor</code></em> is <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, the stage will receive
 784 focus.
 785 </p>
 786 <div class="variablelist"><table border="0">
 787 <col align="left" valign="top">
 788 <tbody>
 789 <tr>
 790 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 791 <td>the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 792 </td>
 793 </tr>
 794 <tr>
 795 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
 796 <td>the actor to set key focus to, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 797 </td>
 798 </tr>
 799 </tbody>
 800 </table></div>
 801 <p class="since">Since 0.6</p>
 802 </div>
 803 <hr>
 804 <div class="refsect2">
 805 <a name="clutter-stage-get-key-focus"></a><h3>clutter_stage_get_key_focus ()</h3>
 806 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_stage_get_key_focus         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
 807 <p>
 808 Retrieves the actor that is currently under key focus.
 809 </p>
 810 <div class="variablelist"><table border="0">
 811 <col align="left" valign="top">
 812 <tbody>
 813 <tr>
 814 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 815 <td>the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 816 </td>
 817 </tr>
 818 <tr>
 819 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 820 <td>the actor with key focus, or the stage. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 821 </td>
 822 </tr>
 823 </tbody>
 824 </table></div>
 825 <p class="since">Since 0.6</p>
 826 </div>
 827 <hr>
 828 <div class="refsect2">
 829 <a name="clutter-stage-read-pixels"></a><h3>clutter_stage_read_pixels ()</h3>
 830 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> *            clutter_stage_read_pixels           (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 831                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
 832                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
 833                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
 834                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>);</pre>
 835 <p>
 836 Makes a screenshot of the stage in RGBA 8bit data, returns a
 837 linear buffer with <em class="parameter"><code>width</code></em> * 4 as rowstride.
 838 </p>
 839 <p>
 840 The alpha data contained in the returned buffer is driver-dependent,
 841 and not guaranteed to hold any sensible value.
 842 </p>
 843 <div class="variablelist"><table border="0">
 844 <col align="left" valign="top">
 845 <tbody>
 846 <tr>
 847 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 848 <td>A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 849 </td>
 850 </tr>
 851 <tr>
 852 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
 853 <td>x coordinate of the first pixel that is read from stage</td>
 854 </tr>
 855 <tr>
 856 <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
 857 <td>y coordinate of the first pixel that is read from stage</td>
 858 </tr>
 859 <tr>
 860 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
 861 <td>Width dimention of pixels to be read, or -1 for the
 862 entire stage width</td>
 863 </tr>
 864 <tr>
 865 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
 866 <td>Height dimention of pixels to be read, or -1 for the
 867 entire stage height</td>
 868 </tr>
 869 <tr>
 870 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 871 <td>a pointer to newly allocated memory with the buffer
 872 or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if the read failed. Use <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> on the returned data
 873 to release the resources it has allocated. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>]</span>
 874 </td>
 875 </tr>
 876 </tbody>
 877 </table></div>
 878 </div>
 879 <hr>
 880 <div class="refsect2">
 881 <a name="clutter-stage-set-throttle-motion-events"></a><h3>clutter_stage_set_throttle_motion_events ()</h3>
 882 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_throttle_motion_events
 883                                                         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 884                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> throttle</code></em>);</pre>
 885 <p>
 886 Sets whether motion events received between redraws should
 887 be throttled or not. If motion events are throttled, those
 888 events received by the windowing system between redraws will
 889 be compressed so that only the last event will be propagated
 890 to the <em class="parameter"><code>stage</code></em> and its actors.
 891 </p>
 892 <p>
 893 This function should only be used if you want to have all
 894 the motion events delivered to your application code.
 895 </p>
 896 <div class="variablelist"><table border="0">
 897 <col align="left" valign="top">
 898 <tbody>
 899 <tr>
 900 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 901 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 902 </td>
 903 </tr>
 904 <tr>
 905 <td><p><span class="term"><em class="parameter"><code>throttle</code></em> :</span></p></td>
 906 <td>
 907 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to throttle motion events</td>
 908 </tr>
 909 </tbody>
 910 </table></div>
 911 <p class="since">Since 1.0</p>
 912 </div>
 913 <hr>
 914 <div class="refsect2">
 915 <a name="clutter-stage-get-throttle-motion-events"></a><h3>clutter_stage_get_throttle_motion_events ()</h3>
 916 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_stage_get_throttle_motion_events
 917                                                         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
 918 <p>
 919 Retrieves the value set with <a class="link" href="ClutterStage.html#clutter-stage-set-throttle-motion-events" title="clutter_stage_set_throttle_motion_events ()"><code class="function">clutter_stage_set_throttle_motion_events()</code></a>
 920 </p>
 921 <div class="variablelist"><table border="0">
 922 <col align="left" valign="top">
 923 <tbody>
 924 <tr>
 925 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 926 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 927 </td>
 928 </tr>
 929 <tr>
 930 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 931 <td>
 932 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the motion events are being throttled,
 933 and <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
 934 </tr>
 935 </tbody>
 936 </table></div>
 937 <p class="since">Since 1.0</p>
 938 </div>
 939 <hr>
 940 <div class="refsect2">
 941 <a name="clutter-stage-set-use-alpha"></a><h3>clutter_stage_set_use_alpha ()</h3>
 942 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_use_alpha         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 943                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> use_alpha</code></em>);</pre>
 944 <p>
 945 Sets whether the <em class="parameter"><code>stage</code></em> should honour the <a class="link" href="ClutterActor.html#ClutterActor--opacity" title='The "opacity" property'><span class="type">"opacity"</span></a> and
 946 the alpha channel of the <a class="link" href="ClutterStage.html#ClutterStage--color" title='The "color" property'><span class="type">"color"</span></a>
 947 </p>
 948 <div class="variablelist"><table border="0">
 949 <col align="left" valign="top">
 950 <tbody>
 951 <tr>
 952 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 953 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 954 </td>
 955 </tr>
 956 <tr>
 957 <td><p><span class="term"><em class="parameter"><code>use_alpha</code></em> :</span></p></td>
 958 <td>whether the stage should honour the opacity or the
 959 alpha channel of the stage color</td>
 960 </tr>
 961 </tbody>
 962 </table></div>
 963 <p class="since">Since 1.2</p>
 964 </div>
 965 <hr>
 966 <div class="refsect2">
 967 <a name="clutter-stage-get-use-alpha"></a><h3>clutter_stage_get_use_alpha ()</h3>
 968 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_stage_get_use_alpha         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
 969 <p>
 970 Retrieves the value set using <a class="link" href="ClutterStage.html#clutter-stage-set-use-alpha" title="clutter_stage_set_use_alpha ()"><code class="function">clutter_stage_set_use_alpha()</code></a>
 971 </p>
 972 <div class="variablelist"><table border="0">
 973 <col align="left" valign="top">
 974 <tbody>
 975 <tr>
 976 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 977 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 978 </td>
 979 </tr>
 980 <tr>
 981 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 982 <td>
 983 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the stage should honour the opacity and the
 984 alpha channel of the stage color</td>
 985 </tr>
 986 </tbody>
 987 </table></div>
 988 <p class="since">Since 1.2</p>
 989 </div>
 990 <hr>
 991 <div class="refsect2">
 992 <a name="clutter-stage-set-minimum-size"></a><h3>clutter_stage_set_minimum_size ()</h3>
 993 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_minimum_size      (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
 994                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> width</code></em>,
 995                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> height</code></em>);</pre>
 996 <p>
 997 Sets the minimum size for a stage window, if the default backend
 998 uses <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> inside a window
 999 </p>
1000 <p>
1001 This is a convenience function, and it is equivalent to setting the
1002 <a class="link" href="ClutterActor.html#ClutterActor--min-width" title='The "min-width" property'><span class="type">"min-width"</span></a> and <a class="link" href="ClutterActor.html#ClutterActor--min-height" title='The "min-height" property'><span class="type">"min-height"</span></a> on <em class="parameter"><code>stage</code></em>
1003 </p>
1004 <p>
1005 If the current size of <em class="parameter"><code>stage</code></em> is smaller than the minimum size, the
1006 <em class="parameter"><code>stage</code></em> will be resized to the new <em class="parameter"><code>width</code></em> and <em class="parameter"><code>height</code></em>
1007 </p>
1008 <p>
1009 This function has no effect if <em class="parameter"><code>stage</code></em> is fullscreen
1010 </p>
1011 <div class="variablelist"><table border="0">
1012 <col align="left" valign="top">
1013 <tbody>
1014 <tr>
1015 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1016 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
1017 </td>
1018 </tr>
1019 <tr>
1020 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1021 <td>width, in pixels</td>
1022 </tr>
1023 <tr>
1024 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1025 <td>height, in pixels</td>
1026 </tr>
1027 </tbody>
1028 </table></div>
1029 <p class="since">Since 1.2</p>
1030 </div>
1031 <hr>
1032 <div class="refsect2">
1033 <a name="clutter-stage-get-minimum-size"></a><h3>clutter_stage_get_minimum_size ()</h3>
1034 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_get_minimum_size      (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
1035                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *width</code></em>,
1036                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *height</code></em>);</pre>
1037 <p>
1038 Retrieves the minimum size for a stage window as set using
1039 <a class="link" href="ClutterStage.html#clutter-stage-set-minimum-size" title="clutter_stage_set_minimum_size ()"><code class="function">clutter_stage_set_minimum_size()</code></a>.
1040 </p>
1041 <p>
1042 The returned size may not correspond to the actual minimum size and
1043 it is specific to the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> implementation inside the
1044 Clutter backend
1045 </p>
1046 <div class="variablelist"><table border="0">
1047 <col align="left" valign="top">
1048 <tbody>
1049 <tr>
1050 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1051 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
1052 </td>
1053 </tr>
1054 <tr>
1055 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1056 <td>return location for the minimum width, in pixels,
1057 or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
1058 </td>
1059 </tr>
1060 <tr>
1061 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1062 <td>return location for the minimum height, in pixels,
1063 or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
1064 </td>
1065 </tr>
1066 </tbody>
1067 </table></div>
1068 <p class="since">Since 1.2</p>
1069 </div>
1070 <hr>
1071 <div class="refsect2">
1072 <a name="clutter-stage-set-no-clear-hint"></a><h3>clutter_stage_set_no_clear_hint ()</h3>
1073 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_no_clear_hint     (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
1074                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> no_clear</code></em>);</pre>
1075 <p>
1076 Sets whether the <em class="parameter"><code>stage</code></em> should clear itself at the beginning
1077 of each paint cycle or not.
1078 </p>
1079 <p>
1080 Clearing the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> can be a costly operation, especially
1081 if the stage is always covered - for instance, in a full-screen
1082 video player or in a game with a background texture.
1083 </p>
1084 <p>
1085 </p>
1086 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1087 <h3 class="title">Note</h3>
1088 <p>This setting is a hint; Clutter might discard this
1089 hint depending on its internal state.</p>
1090 </div>
1091 <p>
1092 </p>
1093 <p>
1094 </p>
1095 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1096 <h3 class="title">Warning</h3>
1097 <p>If parts of the stage are visible and you disable
1098 clearing you might end up with visual artifacts while painting the
1099 contents of the stage.</p>
1100 </div>
1101 <p>
1102 </p>
1103 <div class="variablelist"><table border="0">
1104 <col align="left" valign="top">
1105 <tbody>
1106 <tr>
1107 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1108 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
1109 </td>
1110 </tr>
1111 <tr>
1112 <td><p><span class="term"><em class="parameter"><code>no_clear</code></em> :</span></p></td>
1113 <td>
1114 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <em class="parameter"><code>stage</code></em> should not clear itself on every
1115 repaint cycle</td>
1116 </tr>
1117 </tbody>
1118 </table></div>
1119 <p class="since">Since 1.4</p>
1120 </div>
1121 <hr>
1122 <div class="refsect2">
1123 <a name="clutter-stage-get-no-clear-hint"></a><h3>clutter_stage_get_no_clear_hint ()</h3>
1124 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_stage_get_no_clear_hint     (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
1125 <p>
1126 Retrieves the hint set with <a class="link" href="ClutterStage.html#clutter-stage-set-no-clear-hint" title="clutter_stage_set_no_clear_hint ()"><code class="function">clutter_stage_set_no_clear_hint()</code></a>
1127 </p>
1128 <div class="variablelist"><table border="0">
1129 <col align="left" valign="top">
1130 <tbody>
1131 <tr>
1132 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1133 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
1134 </td>
1135 </tr>
1136 <tr>
1137 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1138 <td>
1139 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the stage should not clear itself on every paint
1140 cycle, and <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
1141 </tr>
1142 </tbody>
1143 </table></div>
1144 <p class="since">Since 1.4</p>
1145 </div>
1146 <hr>
1147 <div class="refsect2">
1148 <a name="clutter-stage-get-redraw-clip-bounds"></a><h3>clutter_stage_get_redraw_clip_bounds ()</h3>
1149 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_get_redraw_clip_bounds
1150                                                         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
1151                                                          <em class="parameter"><code><a href="/home/ebassi/gnome3/install/share/gtk-doc/html/cairo/cairo-Types.html#cairo-rectangle-int-t"><span class="type">cairo_rectangle_int_t</span></a> *clip</code></em>);</pre>
1152 <p>
1153 Gets the bounds of the current redraw for <em class="parameter"><code>stage</code></em> in stage pixel
1154 coordinates. E.g., if only a single actor has queued a redraw then
1155 Clutter may redraw the stage with a clip so that it doesn't have to
1156 paint every pixel in the stage. This function would then return the
1157 bounds of that clip. An application can use this information to
1158 avoid some extra work if it knows that some regions of the stage
1159 aren't going to be painted. This should only be called while the
1160 stage is being painted. If there is no current redraw clip then
1161 this function will set <em class="parameter"><code>clip</code></em> to the full extents of the stage.
1162 </p>
1163 <div class="variablelist"><table border="0">
1164 <col align="left" valign="top">
1165 <tbody>
1166 <tr>
1167 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1168 <td>A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
1169 </td>
1170 </tr>
1171 <tr>
1172 <td><p><span class="term"><em class="parameter"><code>clip</code></em> :</span></p></td>
1173 <td>Return location for the clip bounds. <span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span>
1174 </td>
1175 </tr>
1176 </tbody>
1177 </table></div>
1178 <p class="since">Since 1.8</p>
1179 </div>
1180 <hr>
1181 <div class="refsect2">
1182 <a name="clutter-stage-set-accept-focus"></a><h3>clutter_stage_set_accept_focus ()</h3>
1183 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_accept_focus      (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
1184                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> accept_focus</code></em>);</pre>
1185 <p>
1186 Sets whether the <em class="parameter"><code>stage</code></em> should accept the key focus when shown.
1187 </p>
1188 <p>
1189 This function should be called before showing <em class="parameter"><code>stage</code></em> using
1190 <a class="link" href="ClutterActor.html#clutter-actor-show" title="clutter_actor_show ()"><code class="function">clutter_actor_show()</code></a>.
1191 </p>
1192 <div class="variablelist"><table border="0">
1193 <col align="left" valign="top">
1194 <tbody>
1195 <tr>
1196 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1197 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
1198 </td>
1199 </tr>
1200 <tr>
1201 <td><p><span class="term"><em class="parameter"><code>accept_focus</code></em> :</span></p></td>
1202 <td>
1203 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to accept focus on show</td>
1204 </tr>
1205 </tbody>
1206 </table></div>
1207 <p class="since">Since 1.6</p>
1208 </div>
1209 <hr>
1210 <div class="refsect2">
1211 <a name="clutter-stage-get-accept-focus"></a><h3>clutter_stage_get_accept_focus ()</h3>
1212 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_stage_get_accept_focus      (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
1213 <p>
1214 Retrieves the value set with <a class="link" href="ClutterStage.html#clutter-stage-set-accept-focus" title="clutter_stage_set_accept_focus ()"><code class="function">clutter_stage_set_accept_focus()</code></a>.
1215 </p>
1216 <div class="variablelist"><table border="0">
1217 <col align="left" valign="top">
1218 <tbody>
1219 <tr>
1220 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1221 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
1222 </td>
1223 </tr>
1224 <tr>
1225 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1226 <td>
1227 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> should accept focus, and <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
1228 otherwise</td>
1229 </tr>
1230 </tbody>
1231 </table></div>
1232 <p class="since">Since 1.6</p>
1233 </div>
1234 <hr>
1235 <div class="refsect2">
1236 <a name="clutter-stage-get-motion-events-enabled"></a><h3>clutter_stage_get_motion_events_enabled ()</h3>
1237 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_stage_get_motion_events_enabled
1238                                                         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
1239 <p>
1240 Retrieves the value set using <a class="link" href="ClutterStage.html#clutter-stage-set-motion-events-enabled" title="clutter_stage_set_motion_events_enabled ()"><code class="function">clutter_stage_set_motion_events_enabled()</code></a>.
1241 </p>
1242 <div class="variablelist"><table border="0">
1243 <col align="left" valign="top">
1244 <tbody>
1245 <tr>
1246 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1247 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
1248 </td>
1249 </tr>
1250 <tr>
1251 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1252 <td>
1253 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the per-actor motion event delivery is enabled
1254 and <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
1255 </tr>
1256 </tbody>
1257 </table></div>
1258 <p class="since">Since 1.8</p>
1259 </div>
1260 <hr>
1261 <div class="refsect2">
1262 <a name="clutter-stage-set-motion-events-enabled"></a><h3>clutter_stage_set_motion_events_enabled ()</h3>
1263 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_motion_events_enabled
1264                                                         (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
1265                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enabled</code></em>);</pre>
1266 <p>
1267 Sets whether per-actor motion events (and relative crossing
1268 events) should be disabled or not.
1269 </p>
1270 <p>
1271 The default is <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.
1272 </p>
1273 <p>
1274 If <em class="parameter"><code>enable</code></em> is <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> the following events will not be delivered
1275 to the actors children of <em class="parameter"><code>stage</code></em>.
1276 </p>
1277 <p>
1278 </p>
1279 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
1280 <li class="listitem"><p><a class="link" href="ClutterActor.html#ClutterActor-motion-event" title='The "motion-event" signal'><span class="type">"motion-event"</span></a></p></li>
1281 <li class="listitem"><p><a class="link" href="ClutterActor.html#ClutterActor-enter-event" title='The "enter-event" signal'><span class="type">"enter-event"</span></a></p></li>
1282 <li class="listitem"><p><a class="link" href="ClutterActor.html#ClutterActor-leave-event" title='The "leave-event" signal'><span class="type">"leave-event"</span></a></p></li>
1283 </ul></div>
1284 <p>
1285 </p>
1286 <p>
1287 The events will still be delivered to the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>.
1288 </p>
1289 <p>
1290 The main side effect of this function is that disabling the motion
1291 events will disable picking to detect the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> underneath
1292 the pointer for each motion event. This is useful, for instance,
1293 when dragging a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> across the <em class="parameter"><code>stage</code></em>: the actor underneath
1294 the pointer is not going to change, so it's meaningless to perform
1295 a pick.
1296 </p>
1297 <div class="variablelist"><table border="0">
1298 <col align="left" valign="top">
1299 <tbody>
1300 <tr>
1301 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1302 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
1303 </td>
1304 </tr>
1305 <tr>
1306 <td><p><span class="term"><em class="parameter"><code>enabled</code></em> :</span></p></td>
1307 <td>
1308 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to enable the motion events delivery, and <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
1309 otherwise</td>
1310 </tr>
1311 </tbody>
1312 </table></div>
1313 <p class="since">Since 1.8</p>
1314 </div>
1315 <hr>
1316 <div class="refsect2">
1317 <a name="ClutterPerspective"></a><h3>ClutterPerspective</h3>
1318 <pre class="programlisting">typedef struct {
1319   gfloat fovy;
1320   gfloat aspect;
1321   gfloat z_near;
1322   gfloat z_far;
1323 } ClutterPerspective;
1324 </pre>
1325 <p>
1326 Stage perspective definition. <a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective"><span class="type">ClutterPerspective</span></a> is only used by
1327 the fixed point version of <a class="link" href="ClutterStage.html#clutter-stage-set-perspective" title="clutter_stage_set_perspective ()"><code class="function">clutter_stage_set_perspective()</code></a>.
1328 </p>
1329 <div class="variablelist"><table border="0">
1330 <col align="left" valign="top">
1331 <tbody>
1332 <tr>
1333 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="ClutterPerspective.fovy"></a>fovy</code></em>;</span></p></td>
1334 <td>the field of view angle, in degrees, in the y direction</td>
1335 </tr>
1336 <tr>
1337 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="ClutterPerspective.aspect"></a>aspect</code></em>;</span></p></td>
1338 <td>the aspect ratio that determines the field of view in the x
1339 direction. The aspect ratio is the ratio of x (width) to y (height)</td>
1340 </tr>
1341 <tr>
1342 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="ClutterPerspective.z-near"></a>z_near</code></em>;</span></p></td>
1343 <td>the distance from the viewer to the near clipping
1344 plane (always positive)</td>
1345 </tr>
1346 <tr>
1347 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="ClutterPerspective.z-far"></a>z_far</code></em>;</span></p></td>
1348 <td>the distance from the viewer to the far clipping
1349 plane (always positive)</td>
1350 </tr>
1351 </tbody>
1352 </table></div>
1353 <p class="since">Since 0.4</p>
1354 </div>
1355 <hr>
1356 <div class="refsect2">
1357 <a name="clutter-stage-set-perspective"></a><h3>clutter_stage_set_perspective ()</h3>
1358 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_perspective       (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
1359                                                          <em class="parameter"><code><a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective"><span class="type">ClutterPerspective</span></a> *perspective</code></em>);</pre>
1360 <p>
1361 Sets the stage perspective. Using this function is not recommended
1362 because it will disable Clutter's attempts to generate an
1363 appropriate perspective based on the size of the stage.
1364 </p>
1365 <div class="variablelist"><table border="0">
1366 <col align="left" valign="top">
1367 <tbody>
1368 <tr>
1369 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1370 <td>A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
1371 </td>
1372 </tr>
1373 <tr>
1374 <td><p><span class="term"><em class="parameter"><code>perspective</code></em> :</span></p></td>
1375 <td>A <a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective"><span class="type">ClutterPerspective</span></a>
1376 </td>
1377 </tr>
1378 </tbody>
1379 </table></div>
1380 </div>
1381 <hr>
1382 <div class="refsect2">
1383 <a name="clutter-stage-get-perspective"></a><h3>clutter_stage_get_perspective ()</h3>
1384 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_get_perspective       (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
1385                                                          <em class="parameter"><code><a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective"><span class="type">ClutterPerspective</span></a> *perspective</code></em>);</pre>
1386 <p>
1387 Retrieves the stage perspective.
1388 </p>
1389 <div class="variablelist"><table border="0">
1390 <col align="left" valign="top">
1391 <tbody>
1392 <tr>
1393 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1394 <td>A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
1395 </td>
1396 </tr>
1397 <tr>
1398 <td><p><span class="term"><em class="parameter"><code>perspective</code></em> :</span></p></td>
1399 <td>return location for a
1400 <a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective"><span class="type">ClutterPerspective</span></a>. <span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1401 </td>
1402 </tr>
1403 </tbody>
1404 </table></div>
1405 </div>
1406 <hr>
1407 <div class="refsect2">
1408 <a name="clutter-stage-set-title"></a><h3>clutter_stage_set_title ()</h3>
1409 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_title             (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
1410                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>);</pre>
1411 <p>
1412 Sets the stage title.
1413 </p>
1414 <div class="variablelist"><table border="0">
1415 <col align="left" valign="top">
1416 <tbody>
1417 <tr>
1418 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1419 <td>A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
1420 </td>
1421 </tr>
1422 <tr>
1423 <td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
1424 <td>A utf8 string for the stage windows title.</td>
1425 </tr>
1426 </tbody>
1427 </table></div>
1428 <p class="since">Since 0.4</p>
1429 </div>
1430 <hr>
1431 <div class="refsect2">
1432 <a name="clutter-stage-get-title"></a><h3>clutter_stage_get_title ()</h3>
1433 <pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       clutter_stage_get_title             (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
1434 <p>
1435 Gets the stage title.
1436 </p>
1437 <div class="variablelist"><table border="0">
1438 <col align="left" valign="top">
1439 <tbody>
1440 <tr>
1441 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1442 <td>A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
1443 </td>
1444 </tr>
1445 <tr>
1446 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1447 <td>pointer to the title string for the stage. The
1448 returned string is owned by the actor and should not
1449 be modified or freed.</td>
1450 </tr>
1451 </tbody>
1452 </table></div>
1453 <p class="since">Since 0.4</p>
1454 </div>
1455 <hr>
1456 <div class="refsect2">
1457 <a name="clutter-stage-set-user-resizable"></a><h3>clutter_stage_set_user_resizable ()</h3>
1458 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_user_resizable    (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
1459                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> resizable</code></em>);</pre>
1460 <p>
1461 Sets if the stage is resizable by user interaction (e.g. via
1462 window manager controls)
1463 </p>
1464 <div class="variablelist"><table border="0">
1465 <col align="left" valign="top">
1466 <tbody>
1467 <tr>
1468 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1469 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
1470 </td>
1471 </tr>
1472 <tr>
1473 <td><p><span class="term"><em class="parameter"><code>resizable</code></em> :</span></p></td>
1474 <td>whether the stage should be user resizable.</td>
1475 </tr>
1476 </tbody>
1477 </table></div>
1478 <p class="since">Since 0.4</p>
1479 </div>
1480 <hr>
1481 <div class="refsect2">
1482 <a name="clutter-stage-get-user-resizable"></a><h3>clutter_stage_get_user_resizable ()</h3>
1483 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_stage_get_user_resizable    (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
1484 <p>
1485 Retrieves the value set with <a class="link" href="ClutterStage.html#clutter-stage-set-user-resizable" title="clutter_stage_set_user_resizable ()"><code class="function">clutter_stage_set_user_resizable()</code></a>.
1486 </p>
1487 <div class="variablelist"><table border="0">
1488 <col align="left" valign="top">
1489 <tbody>
1490 <tr>
1491 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1492 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
1493 </td>
1494 </tr>
1495 <tr>
1496 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1497 <td>
1498 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the stage is resizable by the user.</td>
1499 </tr>
1500 </tbody>
1501 </table></div>
1502 <p class="since">Since 0.4</p>
1503 </div>
1504 <hr>
1505 <div class="refsect2">
1506 <a name="ClutterFog"></a><h3>ClutterFog</h3>
1507 <pre class="programlisting">typedef struct {
1508   gfloat z_near;
1509   gfloat z_far;
1510 } ClutterFog;
1511 </pre>
1512 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1513 <h3 class="title">Warning</h3>
1514 <p><code class="literal">ClutterFog</code> has been deprecated since version 1.10 and should not be used in newly-written code. The fog-related API in <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> has been
1515   deprecated as well.</p>
1516 </div>
1517 <p>
1518 Fog settings used to create the depth cueing effect.
1519 </p>
1520 <div class="variablelist"><table border="0">
1521 <col align="left" valign="top">
1522 <tbody>
1523 <tr>
1524 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="ClutterFog.z-near"></a>z_near</code></em>;</span></p></td>
1525 <td>starting distance from the viewer to the near clipping
1526 plane (always positive)</td>
1527 </tr>
1528 <tr>
1529 <td><p><span class="term"><a href="../glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="ClutterFog.z-far"></a>z_far</code></em>;</span></p></td>
1530 <td>final distance from the viewer to the far clipping
1531 plane (always positive)</td>
1532 </tr>
1533 </tbody>
1534 </table></div>
1535 <p class="since">Since 0.6</p>
1536 </div>
1537 <hr>
1538 <div class="refsect2">
1539 <a name="clutter-stage-set-use-fog"></a><h3>clutter_stage_set_use_fog ()</h3>
1540 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_use_fog           (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
1541                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> fog</code></em>);</pre>
1542 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1543 <h3 class="title">Warning</h3>
1544 <p><code class="literal">clutter_stage_set_use_fog</code> has been deprecated since version 1.10 and should not be used in newly-written code. Calling this function produces no visible effect</p>
1545 </div>
1546 <p>
1547 Sets whether the depth cueing effect on the stage should be enabled
1548 or not.
1549 </p>
1550 <p>
1551 Depth cueing is a 3D effect that makes actors farther away from the
1552 viewing point less opaque, by fading them with the stage color.
1553 </p>
1554 <p>
1555 The parameters of the GL fog used can be changed using the
1556 <a class="link" href="ClutterStage.html#clutter-stage-set-fog" title="clutter_stage_set_fog ()"><code class="function">clutter_stage_set_fog()</code></a> function.
1557 </p>
1558 <div class="variablelist"><table border="0">
1559 <col align="left" valign="top">
1560 <tbody>
1561 <tr>
1562 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1563 <td>the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
1564 </td>
1565 </tr>
1566 <tr>
1567 <td><p><span class="term"><em class="parameter"><code>fog</code></em> :</span></p></td>
1568 <td>
1569 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for enabling the depth cueing effect</td>
1570 </tr>
1571 </tbody>
1572 </table></div>
1573 <p class="since">Since 0.6</p>
1574 </div>
1575 <hr>
1576 <div class="refsect2">
1577 <a name="clutter-stage-get-use-fog"></a><h3>clutter_stage_get_use_fog ()</h3>
1578 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_stage_get_use_fog           (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
1579 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1580 <h3 class="title">Warning</h3>
1581 <p><code class="literal">clutter_stage_get_use_fog</code> has been deprecated since version 1.10 and should not be used in newly-written code. This function will always return <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a></p>
1582 </div>
1583 <p>
1584 Gets whether the depth cueing effect is enabled on <em class="parameter"><code>stage</code></em>.
1585 </p>
1586 <div class="variablelist"><table border="0">
1587 <col align="left" valign="top">
1588 <tbody>
1589 <tr>
1590 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1591 <td>the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
1592 </td>
1593 </tr>
1594 <tr>
1595 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1596 <td>
1597 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the depth cueing effect is enabled</td>
1598 </tr>
1599 </tbody>
1600 </table></div>
1601 <p class="since">Since 0.6</p>
1602 </div>
1603 <hr>
1604 <div class="refsect2">
1605 <a name="clutter-stage-set-fog"></a><h3>clutter_stage_set_fog ()</h3>
1606 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_fog               (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
1607                                                          <em class="parameter"><code><a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog"><span class="type">ClutterFog</span></a> *fog</code></em>);</pre>
1608 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1609 <h3 class="title">Warning</h3>
1610 <p><code class="literal">clutter_stage_set_fog</code> has been deprecated since version 1.10 and should not be used in newly-written code. Fog settings are ignored.</p>
1611 </div>
1612 <p>
1613 Sets the fog (also known as "depth cueing") settings for the <em class="parameter"><code>stage</code></em>.
1614 </p>
1615 <p>
1616 A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> will only use a linear fog progression, which
1617 depends solely on the distance from the viewer. The <code class="function">cogl_set_fog()</code>
1618 function in COGL exposes more of the underlying implementation,
1619 and allows changing the for progression function. It can be directly
1620 used by disabling the <a class="link" href="ClutterStage.html#ClutterStage--use-fog" title='The "use-fog" property'><span class="type">"use-fog"</span></a> property and connecting
1621 a signal handler to the <a class="link" href="ClutterActor.html#ClutterActor-paint" title='The "paint" signal'><span class="type">"paint"</span></a> signal on the <em class="parameter"><code>stage</code></em>,
1622 like:
1623 </p>
1624 <p>
1625 </p>
1626 <div class="informalexample">
1627   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
1628     <tbody>
1629       <tr>
1630         <td class="listing_lines" align="right"><pre>1
1631 2</pre></td>
1632         <td class="listing_code"><pre class="programlisting"><span class="function"><a href="ClutterStage.html#clutter-stage-set-use-fog">clutter_stage_set_use_fog</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">stage</span><span class="symbol">,</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS">FALSE</a></span><span class="symbol">);</span>
1633 <span class="function"><a href="../gobject/gobject-Signals.html#g-signal-connect">g_signal_connect</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">stage</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"paint"</span><span class="symbol">,</span><span class="normal"> </span><span class="function"><a href="../gobject/gobject-Closures.html#G-CALLBACK:CAPS">G_CALLBACK</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">on_stage_paint</span><span class="symbol">),</span><span class="normal"> <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span></pre></td>
1634       </tr>
1635     </tbody>
1636   </table>
1637 </div>
1638
1639 <p>
1640 </p>
1641 <p>
1642 The paint signal handler will call <code class="function">cogl_set_fog()</code> with the
1643 desired settings:
1644 </p>
1645 <p>
1646 </p>
1647 <div class="informalexample">
1648   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
1649     <tbody>
1650       <tr>
1651         <td class="listing_lines" align="right"><pre>1
1652 2
1653 3
1654 4
1655 5
1656 6
1657 7
1658 8
1659 9
1660 10
1661 11
1662 12
1663 13
1664 14
1665 15
1666 16
1667 17
1668 18
1669 19
1670 20</pre></td>
1671         <td class="listing_code"><pre class="programlisting"><span class="keyword">static</span><span class="normal"> </span><span class="type">void</span>
1672 <span class="function">on_stage_paint</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">ClutterActor</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">actor</span><span class="symbol">)</span>
1673 <span class="cbracket">{</span>
1674 <span class="normal">  </span><span class="usertype">ClutterColor</span><span class="normal"> stage_color </span><span class="symbol">=</span><span class="normal"> </span><span class="cbracket">{</span><span class="normal"> </span><span class="number">0</span><span class="symbol">,</span><span class="normal"> </span><span class="cbracket">}</span><span class="symbol">;</span>
1675 <span class="normal">  </span><span class="usertype">CoglColor</span><span class="normal"> fog_color </span><span class="symbol">=</span><span class="normal"> </span><span class="cbracket">{</span><span class="normal"> </span><span class="number">0</span><span class="symbol">,</span><span class="normal"> </span><span class="cbracket">}</span><span class="symbol">;</span>
1676
1677 <span class="normal">  </span><span class="comment">/* set the fog color to the stage background color */</span>
1678 <span class="normal">  </span><span class="function"><a href="ClutterStage.html#clutter-stage-get-color">clutter_stage_get_color</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">CLUTTER_STAGE</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">actor</span><span class="symbol">),</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">stage_color</span><span class="symbol">);</span>
1679 <span class="normal">  </span><span class="function">cogl_color_init_from_4ub</span><span class="normal"> </span><span class="symbol">(&amp;</span><span class="normal">fog_color</span><span class="symbol">,</span>
1680 <span class="normal">                            stage_color</span><span class="symbol">.</span><span class="normal">red</span><span class="symbol">,</span>
1681 <span class="normal">                            stage_color</span><span class="symbol">.</span><span class="normal">green</span><span class="symbol">,</span>
1682 <span class="normal">                            stage_color</span><span class="symbol">.</span><span class="normal">blue</span><span class="symbol">,</span>
1683 <span class="normal">                            stage_color</span><span class="symbol">.</span><span class="normal">alpha</span><span class="symbol">);</span>
1684
1685 <span class="normal">  </span><span class="comment">/* enable fog */</span>
1686 <span class="normal">  </span><span class="function">cogl_set_fog</span><span class="normal"> </span><span class="symbol">(&amp;</span><span class="normal">fog_color</span><span class="symbol">,</span>
1687 <span class="normal">                COGL_FOG_MODE_EXPONENTIAL</span><span class="symbol">,</span><span class="normal"> </span><span class="comment">/* mode */</span>
1688 <span class="normal">                </span><span class="number">0.5</span><span class="symbol">,</span><span class="normal">                       </span><span class="comment">/* density */</span>
1689 <span class="normal">                </span><span class="number">5.0</span><span class="symbol">,</span><span class="normal"> </span><span class="number">30.0</span><span class="symbol">);</span><span class="normal">                </span><span class="comment">/* z_near and z_far */</span>
1690 <span class="cbracket">}</span></pre></td>
1691       </tr>
1692     </tbody>
1693   </table>
1694 </div>
1695
1696 <p>
1697 </p>
1698 <p>
1699 </p>
1700 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1701 <h3 class="title">Note</h3>The fogging functions only work correctly when the visible actors use
1702 unmultiplied alpha colors. By default Cogl will premultiply textures and
1703 <code class="function">cogl_set_source_color()</code> will premultiply colors, so unless you explicitly
1704 load your textures requesting an unmultiplied internal format and use
1705 <code class="function">cogl_material_set_color()</code> you can only use fogging with fully opaque actors.
1706 Support for premultiplied colors will improve in the future when we can
1707 depend on fragment shaders.</div>
1708 <p>
1709 </p>
1710 <div class="variablelist"><table border="0">
1711 <col align="left" valign="top">
1712 <tbody>
1713 <tr>
1714 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1715 <td>the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
1716 </td>
1717 </tr>
1718 <tr>
1719 <td><p><span class="term"><em class="parameter"><code>fog</code></em> :</span></p></td>
1720 <td>a <a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog"><span class="type">ClutterFog</span></a> structure</td>
1721 </tr>
1722 </tbody>
1723 </table></div>
1724 <p class="since">Since 0.6</p>
1725 </div>
1726 <hr>
1727 <div class="refsect2">
1728 <a name="clutter-stage-get-fog"></a><h3>clutter_stage_get_fog ()</h3>
1729 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_get_fog               (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
1730                                                          <em class="parameter"><code><a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog"><span class="type">ClutterFog</span></a> *fog</code></em>);</pre>
1731 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1732 <h3 class="title">Warning</h3>
1733 <p><code class="literal">clutter_stage_get_fog</code> has been deprecated since version 1.10 and should not be used in newly-written code. This function will always return the default
1734   values of <a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog"><span class="type">ClutterFog</span></a></p>
1735 </div>
1736 <p>
1737 Retrieves the current depth cueing settings from the stage.
1738 </p>
1739 <div class="variablelist"><table border="0">
1740 <col align="left" valign="top">
1741 <tbody>
1742 <tr>
1743 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1744 <td>the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
1745 </td>
1746 </tr>
1747 <tr>
1748 <td><p><span class="term"><em class="parameter"><code>fog</code></em> :</span></p></td>
1749 <td>return location for a <a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog"><span class="type">ClutterFog</span></a> structure. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
1750 </td>
1751 </tr>
1752 </tbody>
1753 </table></div>
1754 <p class="since">Since 0.6</p>
1755 </div>
1756 </div>
1757 <div class="refsect1">
1758 <a name="ClutterStage.property-details"></a><h2>Property Details</h2>
1759 <div class="refsect2">
1760 <a name="ClutterStage--accept-focus"></a><h3>The <code class="literal">"accept-focus"</code> property</h3>
1761 <pre class="programlisting">  "accept-focus"             <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
1762 <p>
1763 Whether the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> should accept key focus when shown.
1764 </p>
1765 <p>Default value: TRUE</p>
1766 <p class="since">Since 1.6</p>
1767 </div>
1768 <hr>
1769 <div class="refsect2">
1770 <a name="ClutterStage--color"></a><h3>The <code class="literal">"color"</code> property</h3>
1771 <pre class="programlisting">  "color"                    <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>*         : Read / Write</pre>
1772 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1773 <h3 class="title">Warning</h3>
1774 <p><code class="literal">ClutterStage:color</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use the <a class="link" href="ClutterActor.html#ClutterActor--background-color" title='The "background-color" property'><span class="type">"background-color"</span></a> property of
1775   <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> instead.</p>
1776 </div>
1777 <p>
1778 The background color of the main stage.
1779 </p>
1780 </div>
1781 <hr>
1782 <div class="refsect2">
1783 <a name="ClutterStage--cursor-visible"></a><h3>The <code class="literal">"cursor-visible"</code> property</h3>
1784 <pre class="programlisting">  "cursor-visible"           <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
1785 <p>
1786 Whether the mouse pointer should be visible
1787 </p>
1788 <p>Default value: TRUE</p>
1789 </div>
1790 <hr>
1791 <div class="refsect2">
1792 <a name="ClutterStage--fog"></a><h3>The <code class="literal">"fog"</code> property</h3>
1793 <pre class="programlisting">  "fog"                      <a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog"><span class="type">ClutterFog</span></a>*           : Read / Write</pre>
1794 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1795 <h3 class="title">Warning</h3>
1796 <p><code class="literal">ClutterStage:fog</code> has been deprecated since version 1.10 and should not be used in newly-written code. This property does not do anything.</p>
1797 </div>
1798 <p>
1799 The settings for the GL "fog", used only if <a class="link" href="ClutterStage.html#ClutterStage--use-fog" title='The "use-fog" property'><span class="type">"use-fog"</span></a>
1800 is set to <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>
1801 </p>
1802 <p class="since">Since 1.0</p>
1803 </div>
1804 <hr>
1805 <div class="refsect2">
1806 <a name="ClutterStage--fullscreen-set"></a><h3>The <code class="literal">"fullscreen-set"</code> property</h3>
1807 <pre class="programlisting">  "fullscreen-set"           <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read</pre>
1808 <p>Whether the main stage is fullscreen.</p>
1809 <p>Default value: FALSE</p>
1810 </div>
1811 <hr>
1812 <div class="refsect2">
1813 <a name="ClutterStage--key-focus"></a><h3>The <code class="literal">"key-focus"</code> property</h3>
1814 <pre class="programlisting">  "key-focus"                <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>*         : Read / Write</pre>
1815 <p>
1816 The <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> that will receive key events from the underlying
1817 windowing system.
1818 </p>
1819 <p>
1820 If <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> will receive the events.
1821 </p>
1822 <p class="since">Since 1.2</p>
1823 </div>
1824 <hr>
1825 <div class="refsect2">
1826 <a name="ClutterStage--no-clear-hint"></a><h3>The <code class="literal">"no-clear-hint"</code> property</h3>
1827 <pre class="programlisting">  "no-clear-hint"            <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
1828 <p>
1829 Whether or not the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> should clear its contents
1830 before each paint cycle.
1831 </p>
1832 <p>
1833 See <a class="link" href="ClutterStage.html#clutter-stage-set-no-clear-hint" title="clutter_stage_set_no_clear_hint ()"><code class="function">clutter_stage_set_no_clear_hint()</code></a> for further information.
1834 </p>
1835 <p>Default value: FALSE</p>
1836 <p class="since">Since 1.4</p>
1837 </div>
1838 <hr>
1839 <div class="refsect2">
1840 <a name="ClutterStage--offscreen"></a><h3>The <code class="literal">"offscreen"</code> property</h3>
1841 <pre class="programlisting">  "offscreen"                <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
1842 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1843 <h3 class="title">Warning</h3>
1844 <p><code class="literal">ClutterStage:offscreen</code> has been deprecated since version 1.10 and should not be used in newly-written code. This property does not do anything.</p>
1845 </div>
1846 <p>
1847 Whether the stage should be rendered in an offscreen buffer.
1848 </p>
1849 <p>Default value: FALSE</p>
1850 </div>
1851 <hr>
1852 <div class="refsect2">
1853 <a name="ClutterStage--perspective"></a><h3>The <code class="literal">"perspective"</code> property</h3>
1854 <pre class="programlisting">  "perspective"              <a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective"><span class="type">ClutterPerspective</span></a>*   : Read / Write</pre>
1855 <p>
1856 The parameters used for the perspective projection from 3D
1857 coordinates to 2D
1858 </p>
1859 <p class="since">Since 0.8.2</p>
1860 </div>
1861 <hr>
1862 <div class="refsect2">
1863 <a name="ClutterStage--title"></a><h3>The <code class="literal">"title"</code> property</h3>
1864 <pre class="programlisting">  "title"                    <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
1865 <p>
1866 The stage's title - usually displayed in stage windows title decorations.
1867 </p>
1868 <p>Default value: NULL</p>
1869 <p class="since">Since 0.4</p>
1870 </div>
1871 <hr>
1872 <div class="refsect2">
1873 <a name="ClutterStage--use-alpha"></a><h3>The <code class="literal">"use-alpha"</code> property</h3>
1874 <pre class="programlisting">  "use-alpha"                <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
1875 <p>
1876 Whether the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> should honour the alpha component of the
1877 <a class="link" href="ClutterStage.html#ClutterStage--color" title='The "color" property'><span class="type">"color"</span></a> property when painting. If Clutter is run under
1878 a compositing manager this will result in the stage being blended
1879 with the underlying window(s)
1880 </p>
1881 <p>Default value: FALSE</p>
1882 <p class="since">Since 1.2</p>
1883 </div>
1884 <hr>
1885 <div class="refsect2">
1886 <a name="ClutterStage--use-fog"></a><h3>The <code class="literal">"use-fog"</code> property</h3>
1887 <pre class="programlisting">  "use-fog"                  <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
1888 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1889 <h3 class="title">Warning</h3>
1890 <p><code class="literal">ClutterStage:use-fog</code> has been deprecated since version 1.10 and should not be used in newly-written code. This property does not do anything.</p>
1891 </div>
1892 <p>
1893 Whether the stage should use a linear GL "fog" in creating the
1894 depth-cueing effect, to enhance the perception of depth by fading
1895 actors farther from the viewpoint.
1896 </p>
1897 <p>Default value: FALSE</p>
1898 <p class="since">Since 0.6</p>
1899 </div>
1900 <hr>
1901 <div class="refsect2">
1902 <a name="ClutterStage--user-resizable"></a><h3>The <code class="literal">"user-resizable"</code> property</h3>
1903 <pre class="programlisting">  "user-resizable"           <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
1904 <p>
1905 Whether the stage is resizable via user interaction.
1906 </p>
1907 <p>Default value: FALSE</p>
1908 <p class="since">Since 0.4</p>
1909 </div>
1910 </div>
1911 <div class="refsect1">
1912 <a name="ClutterStage.signal-details"></a><h2>Signal Details</h2>
1913 <div class="refsect2">
1914 <a name="ClutterStage-activate"></a><h3>The <code class="literal">"activate"</code> signal</h3>
1915 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage,
1916                                                         <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1917 <p>
1918 The ::activate signal is emitted when the stage receives key focus
1919 from the underlying window system.
1920 </p>
1921 <div class="variablelist"><table border="0">
1922 <col align="left" valign="top">
1923 <tbody>
1924 <tr>
1925 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1926 <td>the stage which was activated</td>
1927 </tr>
1928 <tr>
1929 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1930 <td>user data set when the signal handler was connected.</td>
1931 </tr>
1932 </tbody>
1933 </table></div>
1934 <p class="since">Since 0.6</p>
1935 </div>
1936 <hr>
1937 <div class="refsect2">
1938 <a name="ClutterStage-deactivate"></a><h3>The <code class="literal">"deactivate"</code> signal</h3>
1939 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage,
1940                                                         <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1941 <p>
1942 The ::activate signal is emitted when the stage loses key focus
1943 from the underlying window system.
1944 </p>
1945 <div class="variablelist"><table border="0">
1946 <col align="left" valign="top">
1947 <tbody>
1948 <tr>
1949 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1950 <td>the stage which was deactivated</td>
1951 </tr>
1952 <tr>
1953 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1954 <td>user data set when the signal handler was connected.</td>
1955 </tr>
1956 </tbody>
1957 </table></div>
1958 <p class="since">Since 0.6</p>
1959 </div>
1960 <hr>
1961 <div class="refsect2">
1962 <a name="ClutterStage-delete-event"></a><h3>The <code class="literal">"delete-event"</code> signal</h3>
1963 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage,
1964                                                         <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event,
1965                                                         <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1966 <p>
1967 The ::delete-event signal is emitted when the user closes a
1968 <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> window using the window controls.
1969 </p>
1970 <p>
1971 Clutter by default will call <a class="link" href="clutter-General.html#clutter-main-quit" title="clutter_main_quit ()"><code class="function">clutter_main_quit()</code></a> if <em class="parameter"><code>stage</code></em> is
1972 the default stage, and <a class="link" href="ClutterActor.html#clutter-actor-destroy" title="clutter_actor_destroy ()"><code class="function">clutter_actor_destroy()</code></a> for any other
1973 stage.
1974 </p>
1975 <p>
1976 It is possible to override the default behaviour by connecting
1977 a new handler and returning <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> there.
1978 </p>
1979 <p>
1980 </p>
1981 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1982 <h3 class="title">Note</h3>This signal is emitted only on Clutter backends that
1983 embed <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> in native windows. It is not emitted for
1984 backends that use a static frame buffer.</div>
1985 <p>
1986 </p>
1987 <div class="variablelist"><table border="0">
1988 <col align="left" valign="top">
1989 <tbody>
1990 <tr>
1991 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
1992 <td>the stage that received the event</td>
1993 </tr>
1994 <tr>
1995 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1996 <td>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> of type <a class="link" href="clutter-Events.html#CLUTTER-DELETE:CAPS"><code class="literal">CLUTTER_DELETE</code></a>
1997 </td>
1998 </tr>
1999 <tr>
2000 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
2001 <td>user data set when the signal handler was connected.</td>
2002 </tr>
2003 </tbody>
2004 </table></div>
2005 <p class="since">Since 1.2</p>
2006 </div>
2007 <hr>
2008 <div class="refsect2">
2009 <a name="ClutterStage-fullscreen"></a><h3>The <code class="literal">"fullscreen"</code> signal</h3>
2010 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage,
2011                                                         <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
2012 <p>
2013 The ::fullscreen signal is emitted when the stage is made fullscreen.
2014 </p>
2015 <div class="variablelist"><table border="0">
2016 <col align="left" valign="top">
2017 <tbody>
2018 <tr>
2019 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
2020 <td>the stage which was fullscreened</td>
2021 </tr>
2022 <tr>
2023 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
2024 <td>user data set when the signal handler was connected.</td>
2025 </tr>
2026 </tbody>
2027 </table></div>
2028 <p class="since">Since 0.6</p>
2029 </div>
2030 <hr>
2031 <div class="refsect2">
2032 <a name="ClutterStage-unfullscreen"></a><h3>The <code class="literal">"unfullscreen"</code> signal</h3>
2033 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage,
2034                                                         <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
2035 <p>
2036 The ::unfullscreen signal is emitted when the stage leaves a fullscreen
2037 state.
2038 </p>
2039 <div class="variablelist"><table border="0">
2040 <col align="left" valign="top">
2041 <tbody>
2042 <tr>
2043 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
2044 <td>the stage which has left a fullscreen state.</td>
2045 </tr>
2046 <tr>
2047 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
2048 <td>user data set when the signal handler was connected.</td>
2049 </tr>
2050 </tbody>
2051 </table></div>
2052 <p class="since">Since 0.6</p>
2053 </div>
2054 </div>
2055 </div>
2056 <div class="footer">
2057 <hr>
2058           Generated by GTK-Doc V1.18.1</div>
2059 </body>
2060 </html>