~oem-solutions-group/unity-2d/clutter-1.0

« back to all changes in this revision

Viewing changes to doc/reference/clutter/html/ClutterStage.html

  • Committer: Bazaar Package Importer
  • Author(s): Emilio Pozuelo Monfort
  • Date: 2010-03-21 13:27:56 UTC
  • mto: (2.1.3 experimental)
  • mto: This revision was merged to the branch mainline in revision 8.
  • Revision ID: james.westby@ubuntu.com-20100321132756-nf8yd30yxo3zzwcm
Tags: upstream-1.2.2
Import upstream version 1.2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
7
7
<link rel="home" href="index.html" title="Clutter Reference Manual">
8
8
<link rel="up" href="ch03.html" title="Container actors">
9
9
<link rel="prev" href="ClutterGroup.html" title="ClutterGroup">
10
 
<link rel="next" href="clutteranimation.html" title="Part V. Clutter Animation Framework">
11
 
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
10
<link rel="next" href="ClutterBox.html" title="ClutterBox">
 
11
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="clutter-overview.html" title="Part I. Overview">
14
14
<link rel="part" href="building-clutter.html" title="Part II. Building Clutter">
17
17
<link rel="chapter" href="ch01.html" title="Abstract classes and interfaces">
18
18
<link rel="chapter" href="ch02.html" title="Base actors">
19
19
<link rel="chapter" href="ch03.html" title="Container actors">
 
20
<link rel="chapter" href="ch04.html" title="Layout managers">
20
21
<link rel="part" href="clutteranimation.html" title="Part V. Clutter Animation Framework">
21
 
<link rel="chapter" href="ch04.html" title="Base classes">
22
 
<link rel="chapter" href="ch05.html" title="Behaviours">
23
 
<link rel="chapter" href="ch06.html" title="High Level API">
 
22
<link rel="chapter" href="ch05.html" title="Base classes">
 
23
<link rel="chapter" href="ch06.html" title="Behaviours">
 
24
<link rel="chapter" href="ch07.html" title="High Level API">
24
25
<link rel="part" href="cluttertools.html" title="Part VI. Clutter Tools">
25
 
<link rel="chapter" href="ch07.html" title="General purpose API">
26
 
<link rel="chapter" href="ch08.html" title="User interface definition">
27
 
<link rel="chapter" href="ch09.html" title="Generic list model">
 
26
<link rel="chapter" href="ch08.html" title="General purpose API">
 
27
<link rel="chapter" href="ch09.html" title="User interface definition">
 
28
<link rel="chapter" href="ch10.html" title="Generic list model">
28
29
<link rel="part" href="clutterbackends.html" title="Part VII. Clutter Backends">
29
30
<link rel="part" href="additionaldocs.html" title="Part VIII. Additional Documentation">
30
31
<link rel="chapter" href="clutter-subclassing-ClutterActor.html" title="Implementing a new actor">
47
48
<link rel="index" href="ix05.html" title="Index of new symbols in 0.6">
48
49
<link rel="index" href="ix06.html" title="Index of new symbols in 0.8">
49
50
<link rel="index" href="ix07.html" title="Index of new symbols in 1.0">
 
51
<link rel="index" href="ix08.html" title="Index of new symbols in 1.2">
50
52
<link rel="appendix" href="license.html" title="Appendix A. License">
51
53
</head>
52
54
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
56
58
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
57
59
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
58
60
<th width="100%" align="center">Clutter Reference Manual</th>
59
 
<td><a accesskey="n" href="clutteranimation.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
61
<td><a accesskey="n" href="ClutterBox.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
60
62
</tr>
61
63
<tr><td colspan="5" class="shortcuts">
62
64
<a href="#ClutterStage.synopsis" class="shortcut">Top</a>
63
 
                 | 
64
 
                <a href="#ClutterStage.description" class="shortcut">Description</a>
65
 
                 | 
66
 
                <a href="#ClutterStage.object-hierarchy" class="shortcut">Object Hierarchy</a>
67
 
                 | 
68
 
                <a href="#ClutterStage.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
69
 
                 | 
70
 
                <a href="#ClutterStage.properties" class="shortcut">Properties</a>
71
 
                 | 
72
 
                <a href="#ClutterStage.signals" class="shortcut">Signals</a>
 
65
                   | 
 
66
                  <a href="#ClutterStage.description" class="shortcut">Description</a>
 
67
                   | 
 
68
                  <a href="#ClutterStage.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
69
                   | 
 
70
                  <a href="#ClutterStage.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
71
                   | 
 
72
                  <a href="#ClutterStage.properties" class="shortcut">Properties</a>
 
73
                   | 
 
74
                  <a href="#ClutterStage.signals" class="shortcut">Signals</a>
73
75
</td></tr>
74
76
</table>
75
77
<div class="refentry" title="ClutterStage">
83
85
</tr></table></div>
84
86
<div class="refsynopsisdiv" title="Synopsis">
85
87
<a name="ClutterStage.synopsis"></a><h2>Synopsis</h2>
86
 
<pre class="synopsis">
87
 
                    <a class="link" href="ClutterStage.html#ClutterStage-struct" title="ClutterStage">ClutterStage</a>;
 
88
<pre class="synopsis">                    <a class="link" href="ClutterStage.html#ClutterStage-struct" title="ClutterStage">ClutterStage</a>;
88
89
                    <a class="link" href="ClutterStage.html#ClutterStageClass" title="ClutterStageClass">ClutterStageClass</a>;
89
 
#define             <a class="link" href="ClutterStage.html#CLUTTER-STAGE-WIDTH--CAPS" title="CLUTTER_STAGE_WIDTH()">CLUTTER_STAGE_WIDTH</a>                 ()
90
 
#define             <a class="link" href="ClutterStage.html#CLUTTER-STAGE-HEIGHT--CAPS" title="CLUTTER_STAGE_HEIGHT()">CLUTTER_STAGE_HEIGHT</a>                ()
91
 
<a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a> *      <a class="link" href="ClutterStage.html#clutter-stage-get-default" title="clutter_stage_get_default ()">clutter_stage_get_default</a>           (void);
92
 
<a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a> *      <a class="link" href="ClutterStage.html#clutter-stage-new" title="clutter_stage_new ()">clutter_stage_new</a>                   (void);
93
 
<a
94
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
95
 
>gboolean</a>            <a class="link" href="ClutterStage.html#clutter-stage-is-default" title="clutter_stage_is_default ()">clutter_stage_is_default</a>            (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);
 
90
#define             <a class="link" href="ClutterStage.html#CLUTTER-STAGE-WIDTH:CAPS" title="CLUTTER_STAGE_WIDTH()">CLUTTER_STAGE_WIDTH</a>                 ()
 
91
#define             <a class="link" href="ClutterStage.html#CLUTTER-STAGE-HEIGHT:CAPS" title="CLUTTER_STAGE_HEIGHT()">CLUTTER_STAGE_HEIGHT</a>                ()
 
92
<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>           (void);
 
93
<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>                   (void);
 
94
<a href="http://library.gnome.org/devel/glib/unstable/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>            (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);
96
95
 
97
 
void                <a class="link" href="ClutterStage.html#clutter-stage-set-color" title="clutter_stage_set_color ()">clutter_stage_set_color</a>             (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
98
 
                                                         const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor">ClutterColor</a> *color);
99
 
void                <a class="link" href="ClutterStage.html#clutter-stage-get-color" title="clutter_stage_get_color ()">clutter_stage_get_color</a>             (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
100
 
                                                         <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor">ClutterColor</a> *color);
101
 
void                <a class="link" href="ClutterStage.html#clutter-stage-set-fullscreen" title="clutter_stage_set_fullscreen ()">clutter_stage_set_fullscreen</a>        (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
102
 
                                                         <a
103
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
104
 
>gboolean</a> fullscreen);
105
 
<a
106
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
107
 
>gboolean</a>            <a class="link" href="ClutterStage.html#clutter-stage-get-fullscreen" title="clutter_stage_get_fullscreen ()">clutter_stage_get_fullscreen</a>        (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);
108
 
void                <a class="link" href="ClutterStage.html#clutter-stage-show-cursor" title="clutter_stage_show_cursor ()">clutter_stage_show_cursor</a>           (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);
109
 
void                <a class="link" href="ClutterStage.html#clutter-stage-hide-cursor" title="clutter_stage_hide_cursor ()">clutter_stage_hide_cursor</a>           (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);
 
96
<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>             (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
97
                                                         const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="returnvalue">ClutterColor</span></a> *color);
 
98
<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>             (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
99
                                                         <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="returnvalue">ClutterColor</span></a> *color);
 
100
<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>        (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
101
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> fullscreen);
 
102
<a href="http://library.gnome.org/devel/glib/unstable/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>        (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);
 
103
<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>           (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);
 
104
<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>           (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);
110
105
enum                <a class="link" href="ClutterStage.html#ClutterPickMode" title="enum ClutterPickMode">ClutterPickMode</a>;
111
 
<a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</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>      (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
112
 
                                                         <a class="link" href="ClutterStage.html#ClutterPickMode" title="enum ClutterPickMode">ClutterPickMode</a> pick_mode,
113
 
                                                         <a
114
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
115
 
>gint</a> x,
116
 
                                                         <a
117
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
118
 
>gint</a> y);
119
 
void                <a class="link" href="ClutterStage.html#clutter-stage-ensure-current" title="clutter_stage_ensure_current ()">clutter_stage_ensure_current</a>        (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);
120
 
void                <a class="link" href="ClutterStage.html#clutter-stage-ensure-viewport" title="clutter_stage_ensure_viewport ()">clutter_stage_ensure_viewport</a>       (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);
121
 
void                <a class="link" href="ClutterStage.html#clutter-stage-ensure-redraw" title="clutter_stage_ensure_redraw ()">clutter_stage_ensure_redraw</a>         (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);
122
 
void                <a class="link" href="ClutterStage.html#clutter-stage-queue-redraw" title="clutter_stage_queue_redraw ()">clutter_stage_queue_redraw</a>          (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);
123
 
<a
124
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
125
 
>gboolean</a>            <a class="link" href="ClutterStage.html#clutter-stage-event" title="clutter_stage_event ()">clutter_stage_event</a>                 (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
126
 
                                                         <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent">ClutterEvent</a> *event);
127
 
void                <a class="link" href="ClutterStage.html#clutter-stage-set-key-focus" title="clutter_stage_set_key_focus ()">clutter_stage_set_key_focus</a>         (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
128
 
                                                         <a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a> *actor);
129
 
<a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a> *      <a class="link" href="ClutterStage.html#clutter-stage-get-key-focus" title="clutter_stage_get_key_focus ()">clutter_stage_get_key_focus</a>         (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);
130
 
<a
131
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"
132
 
>guchar</a> *            <a class="link" href="ClutterStage.html#clutter-stage-read-pixels" title="clutter_stage_read_pixels ()">clutter_stage_read_pixels</a>           (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
133
 
                                                         <a
134
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
135
 
>gint</a> x,
136
 
                                                         <a
137
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
138
 
>gint</a> y,
139
 
                                                         <a
140
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
141
 
>gint</a> width,
142
 
                                                         <a
143
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
144
 
>gint</a> height);
145
 
void                <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>
146
 
                                                        (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
147
 
                                                         <a
148
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
149
 
>gboolean</a> throttle);
150
 
<a
151
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
152
 
>gboolean</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>
153
 
                                                        (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);
 
106
<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>      (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
107
                                                         <a class="link" href="ClutterStage.html#ClutterPickMode" title="enum ClutterPickMode"><span class="returnvalue">ClutterPickMode</span></a> pick_mode,
 
108
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> x,
 
109
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> y);
 
110
<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>        (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);
 
111
<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>       (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);
 
112
<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>         (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);
 
113
<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>          (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);
 
114
<a href="http://library.gnome.org/devel/glib/unstable/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>                 (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
115
                                                         <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="returnvalue">ClutterEvent</span></a> *event);
 
116
<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>         (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
117
                                                         <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *actor);
 
118
<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>         (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);
 
119
<a href="http://library.gnome.org/devel/glib/unstable/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>           (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
120
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> x,
 
121
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> y,
 
122
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> width,
 
123
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> height);
 
124
<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>
 
125
                                                        (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
126
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> throttle);
 
127
<a href="http://library.gnome.org/devel/glib/unstable/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>
 
128
                                                        (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);
 
129
<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>         (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
130
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> use_alpha);
 
131
<a href="http://library.gnome.org/devel/glib/unstable/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>         (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);
 
132
<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>      (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
133
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> width,
 
134
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> height);
 
135
<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>      (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
136
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> *width,
 
137
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> *height);
154
138
 
155
139
                    <a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective">ClutterPerspective</a>;
156
 
void                <a class="link" href="ClutterStage.html#clutter-stage-set-perspective" title="clutter_stage_set_perspective ()">clutter_stage_set_perspective</a>       (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
157
 
                                                         <a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective">ClutterPerspective</a> *perspective);
158
 
void                <a class="link" href="ClutterStage.html#clutter-stage-get-perspective" title="clutter_stage_get_perspective ()">clutter_stage_get_perspective</a>       (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
159
 
                                                         <a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective">ClutterPerspective</a> *perspective);
 
140
<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>       (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
141
                                                         <a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective"><span class="returnvalue">ClutterPerspective</span></a> *perspective);
 
142
<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>       (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
143
                                                         <a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective"><span class="returnvalue">ClutterPerspective</span></a> *perspective);
160
144
 
161
 
void                <a class="link" href="ClutterStage.html#clutter-stage-set-title" title="clutter_stage_set_title ()">clutter_stage_set_title</a>             (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
162
 
                                                         const <a
163
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
164
 
>gchar</a> *title);
165
 
const <a
166
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
167
 
>gchar</a> *       <a class="link" href="ClutterStage.html#clutter-stage-get-title" title="clutter_stage_get_title ()">clutter_stage_get_title</a>             (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);
168
 
void                <a class="link" href="ClutterStage.html#clutter-stage-set-user-resizable" title="clutter_stage_set_user_resizable ()">clutter_stage_set_user_resizable</a>    (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
169
 
                                                         <a
170
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
171
 
>gboolean</a> resizable);
172
 
<a
173
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
174
 
>gboolean</a>            <a class="link" href="ClutterStage.html#clutter-stage-get-user-resizable" title="clutter_stage_get_user_resizable ()">clutter_stage_get_user_resizable</a>    (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);
 
145
<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>             (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
146
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *title);
 
147
const <a href="http://library.gnome.org/devel/glib/unstable/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>             (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);
 
148
<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>    (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
149
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> resizable);
 
150
<a href="http://library.gnome.org/devel/glib/unstable/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>    (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);
175
151
 
176
152
                    <a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog">ClutterFog</a>;
177
 
void                <a class="link" href="ClutterStage.html#clutter-stage-set-use-fog" title="clutter_stage_set_use_fog ()">clutter_stage_set_use_fog</a>           (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
178
 
                                                         <a
179
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
180
 
>gboolean</a> fog);
181
 
<a
182
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
183
 
>gboolean</a>            <a class="link" href="ClutterStage.html#clutter-stage-get-use-fog" title="clutter_stage_get_use_fog ()">clutter_stage_get_use_fog</a>           (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);
184
 
void                <a class="link" href="ClutterStage.html#clutter-stage-set-fog" title="clutter_stage_set_fog ()">clutter_stage_set_fog</a>               (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
185
 
                                                         <a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog">ClutterFog</a> *fog);
186
 
void                <a class="link" href="ClutterStage.html#clutter-stage-get-fog" title="clutter_stage_get_fog ()">clutter_stage_get_fog</a>               (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
187
 
                                                         <a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog">ClutterFog</a> *fog);
 
153
<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>           (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
154
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> fog);
 
155
<a href="http://library.gnome.org/devel/glib/unstable/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>           (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);
 
156
<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>               (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
157
                                                         <a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog"><span class="returnvalue">ClutterFog</span></a> *fog);
 
158
<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>               (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
159
                                                         <a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog"><span class="returnvalue">ClutterFog</span></a> *fog);
188
160
</pre>
189
161
</div>
190
162
<div class="refsect1" title="Object Hierarchy">
191
163
<a name="ClutterStage.object-hierarchy"></a><h2>Object Hierarchy</h2>
192
164
<pre class="synopsis">
193
 
  <a
194
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
195
 
>GObject</a>
196
 
   +----<a
197
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
198
 
>GInitiallyUnowned</a>
 
165
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
166
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
199
167
         +----<a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
200
168
               +----<a class="link" href="ClutterGroup.html" title="ClutterGroup">ClutterGroup</a>
201
169
                     +----ClutterStage
210
178
<div class="refsect1" title="Properties">
211
179
<a name="ClutterStage.properties"></a><h2>Properties</h2>
212
180
<pre class="synopsis">
213
 
  "<a class="link" href="ClutterStage.html#ClutterStage--color" title='The "color" property'>color</a>"                    <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor">ClutterColor</a>*         : Read / Write
214
 
  "<a class="link" href="ClutterStage.html#ClutterStage--cursor-visible" title='The "cursor-visible" property'>cursor-visible</a>"           <a
215
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
216
 
>gboolean</a>              : Read / Write
217
 
  "<a class="link" href="ClutterStage.html#ClutterStage--fog" title='The "fog" property'>fog</a>"                      <a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog">ClutterFog</a>*           : Read / Write
218
 
  "<a class="link" href="ClutterStage.html#ClutterStage--fullscreen-set" title='The "fullscreen-set" property'>fullscreen-set</a>"           <a
219
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
220
 
>gboolean</a>              : Read
221
 
  "<a class="link" href="ClutterStage.html#ClutterStage--offscreen" title='The "offscreen" property'>offscreen</a>"                <a
222
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
223
 
>gboolean</a>              : Read / Write
224
 
  "<a class="link" href="ClutterStage.html#ClutterStage--perspective" title='The "perspective" property'>perspective</a>"              <a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective">ClutterPerspective</a>*   : Read / Write
225
 
  "<a class="link" href="ClutterStage.html#ClutterStage--title" title='The "title" property'>title</a>"                    <a
226
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
227
 
>gchar</a>*                : Read / Write
228
 
  "<a class="link" href="ClutterStage.html#ClutterStage--use-fog" title='The "use-fog" property'>use-fog</a>"                  <a
229
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
230
 
>gboolean</a>              : Read / Write
231
 
  "<a class="link" href="ClutterStage.html#ClutterStage--user-resizable" title='The "user-resizable" property'>user-resizable</a>"           <a
232
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
233
 
>gboolean</a>              : Read / Write
 
181
  "<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
 
182
  "<a class="link" href="ClutterStage.html#ClutterStage--cursor-visible" title='The "cursor-visible" property'>cursor-visible</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 
183
  "<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
 
184
  "<a class="link" href="ClutterStage.html#ClutterStage--fullscreen-set" title='The "fullscreen-set" property'>fullscreen-set</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read
 
185
  "<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
 
186
  "<a class="link" href="ClutterStage.html#ClutterStage--offscreen" title='The "offscreen" property'>offscreen</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 
187
  "<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
 
188
  "<a class="link" href="ClutterStage.html#ClutterStage--title" title='The "title" property'>title</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
 
189
  "<a class="link" href="ClutterStage.html#ClutterStage--use-alpha" title='The "use-alpha" property'>use-alpha</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 
190
  "<a class="link" href="ClutterStage.html#ClutterStage--use-fog" title='The "use-fog" property'>use-fog</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 
191
  "<a class="link" href="ClutterStage.html#ClutterStage--user-resizable" title='The "user-resizable" property'>user-resizable</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
234
192
</pre>
235
193
</div>
236
194
<div class="refsect1" title="Signals">
238
196
<pre class="synopsis">
239
197
  "<a class="link" href="ClutterStage.html#ClutterStage-activate" title='The "activate" signal'>activate</a>"                                       : Run Last
240
198
  "<a class="link" href="ClutterStage.html#ClutterStage-deactivate" title='The "deactivate" signal'>deactivate</a>"                                     : Run Last
 
199
  "<a class="link" href="ClutterStage.html#ClutterStage-delete-event" title='The "delete-event" signal'>delete-event</a>"                                   : Run Last
241
200
  "<a class="link" href="ClutterStage.html#ClutterStage-fullscreen" title='The "fullscreen" signal'>fullscreen</a>"                                     : Run First
242
201
  "<a class="link" href="ClutterStage.html#ClutterStage-unfullscreen" title='The "unfullscreen" signal'>unfullscreen</a>"                                   : Run Last
243
202
</pre>
256
215
</p>
257
216
<p>
258
217
Backends might provide support for multiple stages. The support for this
259
 
feature can be checked at run-time using the <code class="function">clutter_feature_available()</code>
260
 
function and the <code class="literal">CLUTTER_FEATURE_STAGE_MULTIPLE</code> flag. If the backend used
 
218
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>
 
219
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
261
220
supports multiple stages, new <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> instances can be created
262
221
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
263
222
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
268
227
implementation of the windowing system. It is possible to subclass
269
228
<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>, as long as every overridden virtual function chains up to
270
229
the parent class corresponding function.</p>
271
 
<p>
272
 
</p>
273
230
</div>
274
231
<div class="refsect1" title="Details">
275
232
<a name="ClutterStage.details"></a><h2>Details</h2>
279
236
<p>
280
237
The <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> structure contains only private data
281
238
and should be accessed using the provided API</p>
282
 
<p>
283
 
</p>
284
239
<p class="since">Since 0.1</p>
285
240
</div>
286
241
<hr>
292
247
  void (* unfullscreen) (ClutterStage *stage);
293
248
  void (* activate)     (ClutterStage *stage);
294
249
  void (* deactivate)   (ClutterStage *stage);
 
250
 
 
251
  gboolean (* delete_event) (ClutterStage *stage,
 
252
                             ClutterEvent *event);
295
253
} ClutterStageClass;
296
254
</pre>
297
255
<p>
298
256
The <a class="link" href="ClutterStage.html#ClutterStageClass" title="ClutterStageClass"><span class="type">ClutterStageClass</span></a> structure contains only private data</p>
299
 
<p>
300
 
</p>
301
257
<div class="variablelist"><table border="0">
302
258
<col align="left" valign="top">
303
259
<tbody>
304
260
<tr>
305
 
<td><p><span class="term"><em class="structfield"><code>fullscreen</code></em> ()</span></p></td>
 
261
<td><p><span class="term"><em class="structfield"><code><a name="ClutterStageClass.fullscreen"></a>fullscreen</code></em> ()</span></p></td>
306
262
<td> handler for the <a class="link" href="ClutterStage.html#ClutterStage-fullscreen" title='The "fullscreen" signal'><span class="type">"fullscreen"</span></a> signal
307
263
</td>
308
264
</tr>
309
265
<tr>
310
 
<td><p><span class="term"><em class="structfield"><code>unfullscreen</code></em> ()</span></p></td>
 
266
<td><p><span class="term"><em class="structfield"><code><a name="ClutterStageClass.unfullscreen"></a>unfullscreen</code></em> ()</span></p></td>
311
267
<td> handler for the <a class="link" href="ClutterStage.html#ClutterStage-unfullscreen" title='The "unfullscreen" signal'><span class="type">"unfullscreen"</span></a> signal
312
268
</td>
313
269
</tr>
314
270
<tr>
315
 
<td><p><span class="term"><em class="structfield"><code>activate</code></em> ()</span></p></td>
 
271
<td><p><span class="term"><em class="structfield"><code><a name="ClutterStageClass.activate"></a>activate</code></em> ()</span></p></td>
316
272
<td> handler for the <a class="link" href="ClutterStage.html#ClutterStage-activate" title='The "activate" signal'><span class="type">"activate"</span></a> signal
317
273
</td>
318
274
</tr>
319
275
<tr>
320
 
<td><p><span class="term"><em class="structfield"><code>deactivate</code></em> ()</span></p></td>
 
276
<td><p><span class="term"><em class="structfield"><code><a name="ClutterStageClass.deactivate"></a>deactivate</code></em> ()</span></p></td>
321
277
<td> handler for the <span class="type">"deactive"</span> signal
322
278
</td>
323
279
</tr>
 
280
<tr>
 
281
<td><p><span class="term"><em class="structfield"><code><a name="ClutterStageClass.delete-event"></a>delete_event</code></em> ()</span></p></td>
 
282
<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
 
283
</td>
 
284
</tr>
324
285
</tbody>
325
286
</table></div>
326
287
<p class="since">Since 0.1</p>
327
288
</div>
328
289
<hr>
329
290
<div class="refsect2" title="CLUTTER_STAGE_WIDTH()">
330
 
<a name="CLUTTER-STAGE-WIDTH--CAPS"></a><h3>CLUTTER_STAGE_WIDTH()</h3>
331
 
<pre class="programlisting">#define             CLUTTER_STAGE_WIDTH()</pre>
 
291
<a name="CLUTTER-STAGE-WIDTH:CAPS"></a><h3>CLUTTER_STAGE_WIDTH()</h3>
 
292
<pre class="programlisting">#define CLUTTER_STAGE_WIDTH()           (clutter_actor_get_width (clutter_stage_get_default ()))
 
293
</pre>
 
294
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
295
<h3 class="title">Warning</h3>
 
296
<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>
 
297
</div>
332
298
<p>
333
299
Macro that evaluates to the width of the default stage</p>
334
 
<p>
335
 
</p>
336
300
<p class="since">Since 0.2</p>
337
301
</div>
338
302
<hr>
339
303
<div class="refsect2" title="CLUTTER_STAGE_HEIGHT()">
340
 
<a name="CLUTTER-STAGE-HEIGHT--CAPS"></a><h3>CLUTTER_STAGE_HEIGHT()</h3>
341
 
<pre class="programlisting">#define             CLUTTER_STAGE_HEIGHT()</pre>
 
304
<a name="CLUTTER-STAGE-HEIGHT:CAPS"></a><h3>CLUTTER_STAGE_HEIGHT()</h3>
 
305
<pre class="programlisting">#define CLUTTER_STAGE_HEIGHT()          (clutter_actor_get_height (clutter_stage_get_default ()))
 
306
</pre>
 
307
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
308
<h3 class="title">Warning</h3>
 
309
<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>
 
310
</div>
342
311
<p>
343
312
Macro that evaluates to the height of the default stage</p>
344
 
<p>
345
 
</p>
346
313
<p class="since">Since 0.2</p>
347
314
</div>
348
315
<hr>
349
316
<div class="refsect2" title="clutter_stage_get_default ()">
350
317
<a name="clutter-stage-get-default"></a><h3>clutter_stage_get_default ()</h3>
351
 
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a> *      clutter_stage_get_default           (void);</pre>
 
318
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_stage_get_default           (void);</pre>
352
319
<p>
353
320
Returns the main stage. The default <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> is a singleton,
354
321
so the stage will be created the first time this function is
357
324
</p>
358
325
<p>
359
326
Clutter guarantess the existence of the default stage.</p>
360
 
<p>
361
 
</p>
362
327
<div class="variablelist"><table border="0">
363
328
<col align="left" valign="top">
364
329
<tbody><tr>
365
330
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
366
 
<td>transfer none. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=transfer"><span class="acronym">transfer</span></a> none. </td>
 
331
<td>transfer none. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
367
332
</tr></tbody>
368
333
</table></div>
369
334
</div>
370
335
<hr>
371
336
<div class="refsect2" title="clutter_stage_new ()">
372
337
<a name="clutter-stage-new"></a><h3>clutter_stage_new ()</h3>
373
 
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a> *      clutter_stage_new                   (void);</pre>
 
338
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_stage_new                   (void);</pre>
374
339
<p>
375
340
Creates a new, non-default stage. A non-default stage is a new
376
341
top-level actor which can be used as another container. It works
380
345
</p>
381
346
<p>
382
347
The ability to support multiple stages depends on the current
383
 
backend. Use <code class="function">clutter_feature_available()</code> and
384
 
<code class="literal">CLUTTER_FEATURE_STAGE_MULTIPLE</code> to check at runtime whether a
 
348
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
 
349
<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
385
350
backend supports multiple stages.</p>
386
 
<p>
387
 
</p>
388
351
<div class="variablelist"><table border="0">
389
352
<col align="left" valign="top">
390
353
<tbody><tr>
391
354
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
392
 
<td> a new stage, or <a
393
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
394
 
><code class="literal">NULL</code></a> if the default backend does
 
355
<td> a new stage, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the default backend does
395
356
  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
396
357
  programmatically close the returned stage.
397
358
 
403
364
<hr>
404
365
<div class="refsect2" title="clutter_stage_is_default ()">
405
366
<a name="clutter-stage-is-default"></a><h3>clutter_stage_is_default ()</h3>
406
 
<pre class="programlisting"><a
407
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
408
 
>gboolean</a>            clutter_stage_is_default            (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);</pre>
 
367
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_stage_is_default            (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);</pre>
409
368
<p>
410
369
Checks if <em class="parameter"><code>stage</code></em> is the default stage, or an instance created using
411
370
<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.</p>
412
 
<p>
413
 
</p>
414
371
<div class="variablelist"><table border="0">
415
372
<col align="left" valign="top">
416
373
<tbody>
421
378
</tr>
422
379
<tr>
423
380
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
424
 
<td> <a
425
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
426
 
><code class="literal">TRUE</code></a> if the passed stage is the default one
 
381
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the passed stage is the default one
427
382
 
428
383
</td>
429
384
</tr>
434
389
<hr>
435
390
<div class="refsect2" title="clutter_stage_set_color ()">
436
391
<a name="clutter-stage-set-color"></a><h3>clutter_stage_set_color ()</h3>
437
 
<pre class="programlisting">void                clutter_stage_set_color             (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
438
 
                                                         const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor">ClutterColor</a> *color);</pre>
 
392
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_color             (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
393
                                                         const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="returnvalue">ClutterColor</span></a> *color);</pre>
439
394
<p>
440
395
Sets the stage color.</p>
441
 
<p>
442
 
</p>
443
396
<div class="variablelist"><table border="0">
444
397
<col align="left" valign="top">
445
398
<tbody>
459
412
<hr>
460
413
<div class="refsect2" title="clutter_stage_get_color ()">
461
414
<a name="clutter-stage-get-color"></a><h3>clutter_stage_get_color ()</h3>
462
 
<pre class="programlisting">void                clutter_stage_get_color             (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
463
 
                                                         <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor">ClutterColor</a> *color);</pre>
 
415
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_get_color             (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
416
                                                         <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="returnvalue">ClutterColor</span></a> *color);</pre>
464
417
<p>
465
418
Retrieves the stage color.</p>
466
 
<p>
467
 
</p>
468
419
<div class="variablelist"><table border="0">
469
420
<col align="left" valign="top">
470
421
<tbody>
484
435
<hr>
485
436
<div class="refsect2" title="clutter_stage_set_fullscreen ()">
486
437
<a name="clutter-stage-set-fullscreen"></a><h3>clutter_stage_set_fullscreen ()</h3>
487
 
<pre class="programlisting">void                clutter_stage_set_fullscreen        (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
488
 
                                                         <a
489
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
490
 
>gboolean</a> fullscreen);</pre>
 
438
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_fullscreen        (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
439
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> fullscreen);</pre>
491
440
<p>
492
441
Asks to place the stage window in the fullscreen or unfullscreen
493
442
states.
503
452
should either use the <a class="link" href="ClutterStage.html#ClutterStage-fullscreen" title='The "fullscreen" signal'><span class="type">"fullscreen"</span></a> and
504
453
<a class="link" href="ClutterStage.html#ClutterStage-unfullscreen" title='The "unfullscreen" signal'><span class="type">"unfullscreen"</span></a> signals, or use the notify signal
505
454
for the <a class="link" href="ClutterStage.html#ClutterStage--fullscreen-set" title='The "fullscreen-set" property'><span class="type">"fullscreen-set"</span></a> property</p>
506
 
<p>
507
 
</p>
508
455
<div class="variablelist"><table border="0">
509
456
<col align="left" valign="top">
510
457
<tbody>
515
462
</tr>
516
463
<tr>
517
464
<td><p><span class="term"><em class="parameter"><code>fullscreen</code></em> :</span></p></td>
518
 
<td> <a
519
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
520
 
><code class="literal">TRUE</code></a> to to set the stage fullscreen
 
465
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to to set the stage fullscreen
521
466
</td>
522
467
</tr>
523
468
</tbody>
527
472
<hr>
528
473
<div class="refsect2" title="clutter_stage_get_fullscreen ()">
529
474
<a name="clutter-stage-get-fullscreen"></a><h3>clutter_stage_get_fullscreen ()</h3>
530
 
<pre class="programlisting"><a
531
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
532
 
>gboolean</a>            clutter_stage_get_fullscreen        (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);</pre>
 
475
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_stage_get_fullscreen        (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);</pre>
533
476
<p>
534
477
Retrieves whether the stage is full screen or not</p>
535
 
<p>
536
 
</p>
537
478
<div class="variablelist"><table border="0">
538
479
<col align="left" valign="top">
539
480
<tbody>
544
485
</tr>
545
486
<tr>
546
487
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
547
 
<td> <a
548
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
549
 
><code class="literal">TRUE</code></a> if the stage is full screen
 
488
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the stage is full screen
550
489
 
551
490
</td>
552
491
</tr>
557
496
<hr>
558
497
<div class="refsect2" title="clutter_stage_show_cursor ()">
559
498
<a name="clutter-stage-show-cursor"></a><h3>clutter_stage_show_cursor ()</h3>
560
 
<pre class="programlisting">void                clutter_stage_show_cursor           (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);</pre>
 
499
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_show_cursor           (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);</pre>
561
500
<p>
562
501
Shows the cursor on the stage window</p>
563
 
<p>
564
 
</p>
565
502
<div class="variablelist"><table border="0">
566
503
<col align="left" valign="top">
567
504
<tbody><tr>
574
511
<hr>
575
512
<div class="refsect2" title="clutter_stage_hide_cursor ()">
576
513
<a name="clutter-stage-hide-cursor"></a><h3>clutter_stage_hide_cursor ()</h3>
577
 
<pre class="programlisting">void                clutter_stage_hide_cursor           (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);</pre>
 
514
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_hide_cursor           (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);</pre>
578
515
<p>
579
516
Makes the cursor invisible on the stage window</p>
580
 
<p>
581
 
</p>
582
517
<div class="variablelist"><table border="0">
583
518
<col align="left" valign="top">
584
519
<tbody><tr>
600
535
</pre>
601
536
<p>
602
537
Controls the paint cycle of the scene graph when in pick mode</p>
603
 
<p>
604
 
</p>
605
538
<div class="variablelist"><table border="0">
606
539
<col align="left" valign="top">
607
540
<tbody>
608
541
<tr>
609
 
<td><p><a name="CLUTTER-PICK-NONE--CAPS"></a><span class="term"><code class="literal">CLUTTER_PICK_NONE</code></span></p></td>
 
542
<td><p><a name="CLUTTER-PICK-NONE:CAPS"></a><span class="term"><code class="literal">CLUTTER_PICK_NONE</code></span></p></td>
610
543
<td> Do not paint any actor
611
544
</td>
612
545
</tr>
613
546
<tr>
614
 
<td><p><a name="CLUTTER-PICK-REACTIVE--CAPS"></a><span class="term"><code class="literal">CLUTTER_PICK_REACTIVE</code></span></p></td>
 
547
<td><p><a name="CLUTTER-PICK-REACTIVE:CAPS"></a><span class="term"><code class="literal">CLUTTER_PICK_REACTIVE</code></span></p></td>
615
548
<td> Paint only the reactive actors
616
549
</td>
617
550
</tr>
618
551
<tr>
619
 
<td><p><a name="CLUTTER-PICK-ALL--CAPS"></a><span class="term"><code class="literal">CLUTTER_PICK_ALL</code></span></p></td>
 
552
<td><p><a name="CLUTTER-PICK-ALL:CAPS"></a><span class="term"><code class="literal">CLUTTER_PICK_ALL</code></span></p></td>
620
553
<td> Paint all actors
621
554
</td>
622
555
</tr>
627
560
<hr>
628
561
<div class="refsect2" title="clutter_stage_get_actor_at_pos ()">
629
562
<a name="clutter-stage-get-actor-at-pos"></a><h3>clutter_stage_get_actor_at_pos ()</h3>
630
 
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a> *      clutter_stage_get_actor_at_pos      (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
631
 
                                                         <a class="link" href="ClutterStage.html#ClutterPickMode" title="enum ClutterPickMode">ClutterPickMode</a> pick_mode,
632
 
                                                         <a
633
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
634
 
>gint</a> x,
635
 
                                                         <a
636
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
637
 
>gint</a> y);</pre>
 
563
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_stage_get_actor_at_pos      (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
564
                                                         <a class="link" href="ClutterStage.html#ClutterPickMode" title="enum ClutterPickMode"><span class="returnvalue">ClutterPickMode</span></a> pick_mode,
 
565
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> x,
 
566
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> y);</pre>
638
567
<p>
639
568
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
640
569
to the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> at those coordinates.
642
571
<p>
643
572
By using <em class="parameter"><code>pick_mode</code></em> it is possible to control which actors will be
644
573
painted and thus available.</p>
645
 
<p>
646
 
</p>
647
574
<div class="variablelist"><table border="0">
648
575
<col align="left" valign="top">
649
576
<tbody>
669
596
</tr>
670
597
<tr>
671
598
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
672
 
<td>transfer none. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=transfer"><span class="acronym">transfer</span></a> none. </td>
 
599
<td>transfer none. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
673
600
</tr>
674
601
</tbody>
675
602
</table></div>
677
604
<hr>
678
605
<div class="refsect2" title="clutter_stage_ensure_current ()">
679
606
<a name="clutter-stage-ensure-current"></a><h3>clutter_stage_ensure_current ()</h3>
680
 
<pre class="programlisting">void                clutter_stage_ensure_current        (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);</pre>
 
607
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_ensure_current        (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);</pre>
681
608
<p>
682
609
This function essentially makes sure the right GL context is
683
610
current for the passed stage. It is not intended to
684
611
be used by applications.</p>
685
 
<p>
686
 
</p>
687
612
<div class="variablelist"><table border="0">
688
613
<col align="left" valign="top">
689
614
<tbody><tr>
697
622
<hr>
698
623
<div class="refsect2" title="clutter_stage_ensure_viewport ()">
699
624
<a name="clutter-stage-ensure-viewport"></a><h3>clutter_stage_ensure_viewport ()</h3>
700
 
<pre class="programlisting">void                clutter_stage_ensure_viewport       (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);</pre>
 
625
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_ensure_viewport       (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);</pre>
701
626
<p>
702
627
Ensures that the GL viewport is updated with the current
703
628
stage window size.
709
634
This function should not be called by applications; it is used
710
635
when embedding a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> into a toolkit with another
711
636
windowing system, like GTK+.</p>
712
 
<p>
713
 
</p>
714
637
<div class="variablelist"><table border="0">
715
638
<col align="left" valign="top">
716
639
<tbody><tr>
724
647
<hr>
725
648
<div class="refsect2" title="clutter_stage_ensure_redraw ()">
726
649
<a name="clutter-stage-ensure-redraw"></a><h3>clutter_stage_ensure_redraw ()</h3>
727
 
<pre class="programlisting">void                clutter_stage_ensure_redraw         (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);</pre>
 
650
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_ensure_redraw         (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);</pre>
728
651
<p>
729
652
Ensures that <em class="parameter"><code>stage</code></em> is redrawn
730
653
</p>
732
655
This function should not be called by applications: it is
733
656
used when embedding a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> into a toolkit with
734
657
another windowing system, like GTK+.</p>
735
 
<p>
736
 
</p>
737
658
<div class="variablelist"><table border="0">
738
659
<col align="left" valign="top">
739
660
<tbody><tr>
747
668
<hr>
748
669
<div class="refsect2" title="clutter_stage_queue_redraw ()">
749
670
<a name="clutter-stage-queue-redraw"></a><h3>clutter_stage_queue_redraw ()</h3>
750
 
<pre class="programlisting">void                clutter_stage_queue_redraw          (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);</pre>
 
671
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_queue_redraw          (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);</pre>
751
672
<p>
752
673
Queues a redraw for the passed stage.
753
674
</p>
763
684
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
764
685
<h3 class="title">Note</h3>This function is just a wrapper for <a class="link" href="ClutterActor.html#clutter-actor-queue-redraw" title="clutter_actor_queue_redraw ()"><code class="function">clutter_actor_queue_redraw()</code></a>
765
686
and should probably go away.</div>
766
 
<p>
767
 
</p>
768
687
<div class="variablelist"><table border="0">
769
688
<col align="left" valign="top">
770
689
<tbody><tr>
778
697
<hr>
779
698
<div class="refsect2" title="clutter_stage_event ()">
780
699
<a name="clutter-stage-event"></a><h3>clutter_stage_event ()</h3>
781
 
<pre class="programlisting"><a
782
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
783
 
>gboolean</a>            clutter_stage_event                 (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
784
 
                                                         <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent">ClutterEvent</a> *event);</pre>
 
700
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_stage_event                 (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
701
                                                         <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="returnvalue">ClutterEvent</span></a> *event);</pre>
785
702
<p>
786
703
This function is used to emit an event on the main stage.
787
704
</p>
788
705
<p>
789
706
You should rarely need to use this function, except for
790
707
synthetised events.</p>
791
 
<p>
792
 
</p>
793
708
<div class="variablelist"><table border="0">
794
709
<col align="left" valign="top">
795
710
<tbody>
816
731
<hr>
817
732
<div class="refsect2" title="clutter_stage_set_key_focus ()">
818
733
<a name="clutter-stage-set-key-focus"></a><h3>clutter_stage_set_key_focus ()</h3>
819
 
<pre class="programlisting">void                clutter_stage_set_key_focus         (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
820
 
                                                         <a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a> *actor);</pre>
 
734
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_key_focus         (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
735
                                                         <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *actor);</pre>
821
736
<p>
822
737
Sets the key focus on <em class="parameter"><code>actor</code></em>. An actor with key focus will receive
823
 
all the key events. If <em class="parameter"><code>actor</code></em> is <a
824
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
825
 
><code class="literal">NULL</code></a>, the stage will receive
 
738
all the key events. If <em class="parameter"><code>actor</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the stage will receive
826
739
focus.</p>
827
 
<p>
828
 
</p>
829
740
<div class="variablelist"><table border="0">
830
741
<col align="left" valign="top">
831
742
<tbody>
836
747
</tr>
837
748
<tr>
838
749
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
839
 
<td> the actor to set key focus to, or <a
840
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
841
 
><code class="literal">NULL</code></a>. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=allow-none"><span class="acronym">allow-none</span></a>. </td>
 
750
<td> the actor to set key focus to, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>. </td>
842
751
</tr>
843
752
</tbody>
844
753
</table></div>
847
756
<hr>
848
757
<div class="refsect2" title="clutter_stage_get_key_focus ()">
849
758
<a name="clutter-stage-get-key-focus"></a><h3>clutter_stage_get_key_focus ()</h3>
850
 
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a> *      clutter_stage_get_key_focus         (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);</pre>
 
759
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_stage_get_key_focus         (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);</pre>
851
760
<p>
852
761
Retrieves the actor that is currently under key focus.</p>
853
 
<p>
854
 
</p>
855
762
<div class="variablelist"><table border="0">
856
763
<col align="left" valign="top">
857
764
<tbody>
862
769
</tr>
863
770
<tr>
864
771
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
865
 
<td> the actor with key focus, or the stage. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=transfer"><span class="acronym">transfer</span></a> none. </td>
 
772
<td> the actor with key focus, or the stage. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
866
773
</tr>
867
774
</tbody>
868
775
</table></div>
871
778
<hr>
872
779
<div class="refsect2" title="clutter_stage_read_pixels ()">
873
780
<a name="clutter-stage-read-pixels"></a><h3>clutter_stage_read_pixels ()</h3>
874
 
<pre class="programlisting"><a
875
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"
876
 
>guchar</a> *            clutter_stage_read_pixels           (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
877
 
                                                         <a
878
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
879
 
>gint</a> x,
880
 
                                                         <a
881
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
882
 
>gint</a> y,
883
 
                                                         <a
884
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
885
 
>gint</a> width,
886
 
                                                         <a
887
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
888
 
>gint</a> height);</pre>
 
781
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> *            clutter_stage_read_pixels           (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
782
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> x,
 
783
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> y,
 
784
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> width,
 
785
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> height);</pre>
889
786
<p>
890
787
Makes a screenshot of the stage in RGBA 8bit data, returns a
891
788
linear buffer with <em class="parameter"><code>width</code></em> * 4 as rowstride.
893
790
<p>
894
791
The alpha data contained in the returned buffer is driver-dependent,
895
792
and not guaranteed to hold any sensible value.</p>
896
 
<p>
897
 
</p>
898
793
<div class="variablelist"><table border="0">
899
794
<col align="left" valign="top">
900
795
<tbody>
928
823
<tr>
929
824
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
930
825
<td> a pointer to newly allocated memory with the buffer
931
 
  or <a
932
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
933
 
><code class="literal">NULL</code></a> if the read failed. Use <a
934
 
href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"
935
 
><code class="function">g_free()</code></a> on the returned data
 
826
  or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the read failed. Use <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> on the returned data
936
827
  to release the resources it has allocated.
937
828
</td>
938
829
</tr>
942
833
<hr>
943
834
<div class="refsect2" title="clutter_stage_set_throttle_motion_events ()">
944
835
<a name="clutter-stage-set-throttle-motion-events"></a><h3>clutter_stage_set_throttle_motion_events ()</h3>
945
 
<pre class="programlisting">void                clutter_stage_set_throttle_motion_events
946
 
                                                        (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
947
 
                                                         <a
948
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
949
 
>gboolean</a> throttle);</pre>
 
836
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_throttle_motion_events
 
837
                                                        (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
838
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> throttle);</pre>
950
839
<p>
951
840
Sets whether motion events received between redraws should
952
841
be throttled or not. If motion events are throttled, those
957
846
<p>
958
847
This function should only be used if you want to have all
959
848
the motion events delivered to your application code.</p>
960
 
<p>
961
 
</p>
962
849
<div class="variablelist"><table border="0">
963
850
<col align="left" valign="top">
964
851
<tbody>
969
856
</tr>
970
857
<tr>
971
858
<td><p><span class="term"><em class="parameter"><code>throttle</code></em> :</span></p></td>
972
 
<td> <a
973
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
974
 
><code class="literal">TRUE</code></a> to throttle motion events
 
859
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to throttle motion events
975
860
</td>
976
861
</tr>
977
862
</tbody>
981
866
<hr>
982
867
<div class="refsect2" title="clutter_stage_get_throttle_motion_events ()">
983
868
<a name="clutter-stage-get-throttle-motion-events"></a><h3>clutter_stage_get_throttle_motion_events ()</h3>
984
 
<pre class="programlisting"><a
985
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
986
 
>gboolean</a>            clutter_stage_get_throttle_motion_events
987
 
                                                        (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);</pre>
 
869
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_stage_get_throttle_motion_events
 
870
                                                        (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);</pre>
988
871
<p>
989
872
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></p>
990
 
<p>
991
 
</p>
992
873
<div class="variablelist"><table border="0">
993
874
<col align="left" valign="top">
994
875
<tbody>
999
880
</tr>
1000
881
<tr>
1001
882
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1002
 
<td> <a
1003
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
1004
 
><code class="literal">TRUE</code></a> if the motion events are being throttled,
1005
 
  and <a
1006
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
1007
 
><code class="literal">FALSE</code></a> otherwise
 
883
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the motion events are being throttled,
 
884
  and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise
1008
885
 
1009
886
</td>
1010
887
</tr>
1013
890
<p class="since">Since 1.0</p>
1014
891
</div>
1015
892
<hr>
 
893
<div class="refsect2" title="clutter_stage_set_use_alpha ()">
 
894
<a name="clutter-stage-set-use-alpha"></a><h3>clutter_stage_set_use_alpha ()</h3>
 
895
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_use_alpha         (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
896
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> use_alpha);</pre>
 
897
<p>
 
898
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
 
899
the alpha channel of the <a class="link" href="ClutterStage.html#ClutterStage--color" title='The "color" property'><span class="type">"color"</span></a></p>
 
900
<div class="variablelist"><table border="0">
 
901
<col align="left" valign="top">
 
902
<tbody>
 
903
<tr>
 
904
<td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 
905
<td> a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 
906
</td>
 
907
</tr>
 
908
<tr>
 
909
<td><p><span class="term"><em class="parameter"><code>use_alpha</code></em> :</span></p></td>
 
910
<td> whether the stage should honour the opacity or the
 
911
  alpha channel of the stage color
 
912
</td>
 
913
</tr>
 
914
</tbody>
 
915
</table></div>
 
916
<p class="since">Since 1.2</p>
 
917
</div>
 
918
<hr>
 
919
<div class="refsect2" title="clutter_stage_get_use_alpha ()">
 
920
<a name="clutter-stage-get-use-alpha"></a><h3>clutter_stage_get_use_alpha ()</h3>
 
921
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_stage_get_use_alpha         (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);</pre>
 
922
<p>
 
923
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></p>
 
924
<div class="variablelist"><table border="0">
 
925
<col align="left" valign="top">
 
926
<tbody>
 
927
<tr>
 
928
<td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 
929
<td> a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 
930
</td>
 
931
</tr>
 
932
<tr>
 
933
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
934
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the stage should honour the opacity and the
 
935
  alpha channel of the stage color
 
936
 
 
937
</td>
 
938
</tr>
 
939
</tbody>
 
940
</table></div>
 
941
<p class="since">Since 1.2</p>
 
942
</div>
 
943
<hr>
 
944
<div class="refsect2" title="clutter_stage_set_minimum_size ()">
 
945
<a name="clutter-stage-set-minimum-size"></a><h3>clutter_stage_set_minimum_size ()</h3>
 
946
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_minimum_size      (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
947
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> width,
 
948
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> height);</pre>
 
949
<p>
 
950
Sets the minimum size for a stage window, if the default backend
 
951
uses <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> inside a window
 
952
</p>
 
953
<p>
 
954
This is a convenience function, and it is equivalent to setting the
 
955
<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>
 
956
</p>
 
957
<p>
 
958
If the current size of <em class="parameter"><code>stage</code></em> is smaller than the minimum size, the
 
959
<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>
 
960
</p>
 
961
<p>
 
962
This function has no effect if <em class="parameter"><code>stage</code></em> is fullscreen</p>
 
963
<div class="variablelist"><table border="0">
 
964
<col align="left" valign="top">
 
965
<tbody>
 
966
<tr>
 
967
<td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 
968
<td> a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 
969
</td>
 
970
</tr>
 
971
<tr>
 
972
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
 
973
<td> width, in pixels
 
974
</td>
 
975
</tr>
 
976
<tr>
 
977
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
 
978
<td> height, in pixels
 
979
</td>
 
980
</tr>
 
981
</tbody>
 
982
</table></div>
 
983
<p class="since">Since 1.2</p>
 
984
</div>
 
985
<hr>
 
986
<div class="refsect2" title="clutter_stage_get_minimum_size ()">
 
987
<a name="clutter-stage-get-minimum-size"></a><h3>clutter_stage_get_minimum_size ()</h3>
 
988
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_get_minimum_size      (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
989
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> *width,
 
990
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> *height);</pre>
 
991
<p>
 
992
Retrieves the minimum size for a stage window as set using
 
993
<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>.
 
994
</p>
 
995
<p>
 
996
The returned size may not correspond to the actual minimum size and
 
997
it is specific to the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> implementation inside the
 
998
Clutter backend</p>
 
999
<div class="variablelist"><table border="0">
 
1000
<col align="left" valign="top">
 
1001
<tbody>
 
1002
<tr>
 
1003
<td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 
1004
<td> a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
 
1005
</td>
 
1006
</tr>
 
1007
<tr>
 
1008
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
 
1009
<td>out. <acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>. </td>
 
1010
</tr>
 
1011
<tr>
 
1012
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
 
1013
<td>out. <acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>. </td>
 
1014
</tr>
 
1015
</tbody>
 
1016
</table></div>
 
1017
<p class="since">Since 1.2</p>
 
1018
</div>
 
1019
<hr>
1016
1020
<div class="refsect2" title="ClutterPerspective">
1017
1021
<a name="ClutterPerspective"></a><h3>ClutterPerspective</h3>
1018
1022
<pre class="programlisting">typedef struct {
1025
1029
<p>
1026
1030
Stage perspective definition. <a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective"><span class="type">ClutterPerspective</span></a> is only used by
1027
1031
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>.</p>
1028
 
<p>
1029
 
</p>
1030
1032
<div class="variablelist"><table border="0">
1031
1033
<col align="left" valign="top">
1032
1034
<tbody>
1033
1035
<tr>
1034
 
<td><p><span class="term"><a
1035
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
1036
 
>gfloat</a> <em class="structfield"><code>fovy</code></em>;</span></p></td>
 
1036
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/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>
1037
1037
<td> the field of view angle, in degrees, in the y direction
1038
1038
</td>
1039
1039
</tr>
1040
1040
<tr>
1041
 
<td><p><span class="term"><a
1042
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
1043
 
>gfloat</a> <em class="structfield"><code>aspect</code></em>;</span></p></td>
 
1041
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/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>
1044
1042
<td> the aspect ratio that determines the field of view in the x
1045
1043
  direction. The aspect ratio is the ratio of x (width) to y (height)
1046
1044
</td>
1047
1045
</tr>
1048
1046
<tr>
1049
 
<td><p><span class="term"><a
1050
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
1051
 
>gfloat</a> <em class="structfield"><code>z_near</code></em>;</span></p></td>
 
1047
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/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>
1052
1048
<td> the distance from the viewer to the near clipping
1053
1049
  plane (always positive)
1054
1050
</td>
1055
1051
</tr>
1056
1052
<tr>
1057
 
<td><p><span class="term"><a
1058
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
1059
 
>gfloat</a> <em class="structfield"><code>z_far</code></em>;</span></p></td>
 
1053
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/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>
1060
1054
<td> the distance from the viewer to the far clipping
1061
1055
  plane (always positive)
1062
1056
</td>
1068
1062
<hr>
1069
1063
<div class="refsect2" title="clutter_stage_set_perspective ()">
1070
1064
<a name="clutter-stage-set-perspective"></a><h3>clutter_stage_set_perspective ()</h3>
1071
 
<pre class="programlisting">void                clutter_stage_set_perspective       (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
1072
 
                                                         <a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective">ClutterPerspective</a> *perspective);</pre>
 
1065
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_perspective       (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
1066
                                                         <a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective"><span class="returnvalue">ClutterPerspective</span></a> *perspective);</pre>
1073
1067
<p>
1074
1068
Sets the stage perspective.</p>
1075
 
<p>
1076
 
</p>
1077
1069
<div class="variablelist"><table border="0">
1078
1070
<col align="left" valign="top">
1079
1071
<tbody>
1093
1085
<hr>
1094
1086
<div class="refsect2" title="clutter_stage_get_perspective ()">
1095
1087
<a name="clutter-stage-get-perspective"></a><h3>clutter_stage_get_perspective ()</h3>
1096
 
<pre class="programlisting">void                clutter_stage_get_perspective       (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
1097
 
                                                         <a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective">ClutterPerspective</a> *perspective);</pre>
 
1088
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_get_perspective       (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
1089
                                                         <a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective"><span class="returnvalue">ClutterPerspective</span></a> *perspective);</pre>
1098
1090
<p>
1099
1091
Retrieves the stage perspective.</p>
1100
 
<p>
1101
 
</p>
1102
1092
<div class="variablelist"><table border="0">
1103
1093
<col align="left" valign="top">
1104
1094
<tbody>
1118
1108
<hr>
1119
1109
<div class="refsect2" title="clutter_stage_set_title ()">
1120
1110
<a name="clutter-stage-set-title"></a><h3>clutter_stage_set_title ()</h3>
1121
 
<pre class="programlisting">void                clutter_stage_set_title             (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
1122
 
                                                         const <a
1123
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1124
 
>gchar</a> *title);</pre>
 
1111
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_title             (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
1112
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *title);</pre>
1125
1113
<p>
1126
1114
Sets the stage title.</p>
1127
 
<p>
1128
 
</p>
1129
1115
<div class="variablelist"><table border="0">
1130
1116
<col align="left" valign="top">
1131
1117
<tbody>
1146
1132
<hr>
1147
1133
<div class="refsect2" title="clutter_stage_get_title ()">
1148
1134
<a name="clutter-stage-get-title"></a><h3>clutter_stage_get_title ()</h3>
1149
 
<pre class="programlisting">const <a
1150
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1151
 
>gchar</a> *       clutter_stage_get_title             (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);</pre>
 
1135
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       clutter_stage_get_title             (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);</pre>
1152
1136
<p>
1153
1137
Gets the stage title.</p>
1154
 
<p>
1155
 
</p>
1156
1138
<div class="variablelist"><table border="0">
1157
1139
<col align="left" valign="top">
1158
1140
<tbody>
1176
1158
<hr>
1177
1159
<div class="refsect2" title="clutter_stage_set_user_resizable ()">
1178
1160
<a name="clutter-stage-set-user-resizable"></a><h3>clutter_stage_set_user_resizable ()</h3>
1179
 
<pre class="programlisting">void                clutter_stage_set_user_resizable    (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
1180
 
                                                         <a
1181
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1182
 
>gboolean</a> resizable);</pre>
 
1161
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_user_resizable    (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
1162
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> resizable);</pre>
1183
1163
<p>
1184
1164
Sets if the stage is resizable by user interaction (e.g. via
1185
1165
window manager controls)</p>
1186
 
<p>
1187
 
</p>
1188
1166
<div class="variablelist"><table border="0">
1189
1167
<col align="left" valign="top">
1190
1168
<tbody>
1205
1183
<hr>
1206
1184
<div class="refsect2" title="clutter_stage_get_user_resizable ()">
1207
1185
<a name="clutter-stage-get-user-resizable"></a><h3>clutter_stage_get_user_resizable ()</h3>
1208
 
<pre class="programlisting"><a
1209
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1210
 
>gboolean</a>            clutter_stage_get_user_resizable    (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);</pre>
 
1186
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_stage_get_user_resizable    (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);</pre>
1211
1187
<p>
1212
1188
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>.</p>
1213
 
<p>
1214
 
</p>
1215
1189
<div class="variablelist"><table border="0">
1216
1190
<col align="left" valign="top">
1217
1191
<tbody>
1222
1196
</tr>
1223
1197
<tr>
1224
1198
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1225
 
<td> <a
1226
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
1227
 
><code class="literal">TRUE</code></a> if the stage is resizable by the user.
 
1199
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the stage is resizable by the user.
1228
1200
 
1229
1201
</td>
1230
1202
</tr>
1242
1214
</pre>
1243
1215
<p>
1244
1216
Fog settings used to create the depth cueing effect.</p>
1245
 
<p>
1246
 
</p>
1247
1217
<div class="variablelist"><table border="0">
1248
1218
<col align="left" valign="top">
1249
1219
<tbody>
1250
1220
<tr>
1251
 
<td><p><span class="term"><a
1252
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
1253
 
>gfloat</a> <em class="structfield"><code>z_near</code></em>;</span></p></td>
 
1221
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/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>
1254
1222
<td> starting distance from the viewer to the near clipping
1255
1223
  plane (always positive)
1256
1224
</td>
1257
1225
</tr>
1258
1226
<tr>
1259
 
<td><p><span class="term"><a
1260
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
1261
 
>gfloat</a> <em class="structfield"><code>z_far</code></em>;</span></p></td>
 
1227
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/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>
1262
1228
<td> final distance from the viewer to the far clipping
1263
1229
  plane (always positive)
1264
1230
</td>
1270
1236
<hr>
1271
1237
<div class="refsect2" title="clutter_stage_set_use_fog ()">
1272
1238
<a name="clutter-stage-set-use-fog"></a><h3>clutter_stage_set_use_fog ()</h3>
1273
 
<pre class="programlisting">void                clutter_stage_set_use_fog           (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
1274
 
                                                         <a
1275
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1276
 
>gboolean</a> fog);</pre>
 
1239
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_use_fog           (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
1240
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> fog);</pre>
1277
1241
<p>
1278
1242
Sets whether the depth cueing effect on the stage should be enabled
1279
1243
or not.
1285
1249
<p>
1286
1250
The parameters of the GL fog used can be changed using the
1287
1251
<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.</p>
1288
 
<p>
1289
 
</p>
1290
1252
<div class="variablelist"><table border="0">
1291
1253
<col align="left" valign="top">
1292
1254
<tbody>
1297
1259
</tr>
1298
1260
<tr>
1299
1261
<td><p><span class="term"><em class="parameter"><code>fog</code></em> :</span></p></td>
1300
 
<td> <a
1301
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
1302
 
><code class="literal">TRUE</code></a> for enabling the depth cueing effect
 
1262
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for enabling the depth cueing effect
1303
1263
</td>
1304
1264
</tr>
1305
1265
</tbody>
1309
1269
<hr>
1310
1270
<div class="refsect2" title="clutter_stage_get_use_fog ()">
1311
1271
<a name="clutter-stage-get-use-fog"></a><h3>clutter_stage_get_use_fog ()</h3>
1312
 
<pre class="programlisting"><a
1313
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1314
 
>gboolean</a>            clutter_stage_get_use_fog           (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage);</pre>
 
1272
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_stage_get_use_fog           (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage);</pre>
1315
1273
<p>
1316
1274
Gets whether the depth cueing effect is enabled on <em class="parameter"><code>stage</code></em>.</p>
1317
 
<p>
1318
 
</p>
1319
1275
<div class="variablelist"><table border="0">
1320
1276
<col align="left" valign="top">
1321
1277
<tbody>
1326
1282
</tr>
1327
1283
<tr>
1328
1284
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1329
 
<td> <a
1330
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
1331
 
><code class="literal">TRUE</code></a> if the the depth cueing effect is enabled
 
1285
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the the depth cueing effect is enabled
1332
1286
 
1333
1287
</td>
1334
1288
</tr>
1339
1293
<hr>
1340
1294
<div class="refsect2" title="clutter_stage_set_fog ()">
1341
1295
<a name="clutter-stage-set-fog"></a><h3>clutter_stage_set_fog ()</h3>
1342
 
<pre class="programlisting">void                clutter_stage_set_fog               (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
1343
 
                                                         <a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog">ClutterFog</a> *fog);</pre>
 
1296
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_set_fog               (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
1297
                                                         <a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog"><span class="returnvalue">ClutterFog</span></a> *fog);</pre>
1344
1298
<p>
1345
1299
Sets the fog (also known as "depth cueing") settings for the <em class="parameter"><code>stage</code></em>.
1346
1300
</p>
1347
1301
<p>
1348
1302
A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> will only use a linear fog progression, which
1349
 
depends solely on the distance from the viewer. The <a
1350
 
href="../cogl/cogl-General-API.html#cogl-set-fog"
1351
 
><code class="function">cogl_set_fog()</code></a>
 
1303
depends solely on the distance from the viewer. The <a href="../cogl/cogl-General-API.html#cogl-set-fog"><code class="function">cogl_set_fog()</code></a>
1352
1304
function in COGL exposes more of the underlying implementation,
1353
1305
and allows changing the for progression function. It can be directly
1354
1306
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
1364
1316
<p>
1365
1317
</p>
1366
1318
<p>
1367
 
The paint signal handler will call <a
1368
 
href="../cogl/cogl-General-API.html#cogl-set-fog"
1369
 
><code class="function">cogl_set_fog()</code></a> with the
 
1319
The paint signal handler will call <a href="../cogl/cogl-General-API.html#cogl-set-fog"><code class="function">cogl_set_fog()</code></a> with the
1370
1320
desired settings:
1371
1321
</p>
1372
1322
<p>
1406
1356
<p>
1407
1357
      We can look to improve this in the future when we can depend on
1408
1358
      fragment shaders.</p>
1409
 
<p>
1410
 
</p>
1411
1359
<div class="variablelist"><table border="0">
1412
1360
<col align="left" valign="top">
1413
1361
<tbody>
1428
1376
<hr>
1429
1377
<div class="refsect2" title="clutter_stage_get_fog ()">
1430
1378
<a name="clutter-stage-get-fog"></a><h3>clutter_stage_get_fog ()</h3>
1431
 
<pre class="programlisting">void                clutter_stage_get_fog               (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
1432
 
                                                         <a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog">ClutterFog</a> *fog);</pre>
 
1379
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_stage_get_fog               (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *stage,
 
1380
                                                         <a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog"><span class="returnvalue">ClutterFog</span></a> *fog);</pre>
1433
1381
<p>
1434
1382
Retrieves the current depth cueing settings from the stage.</p>
1435
 
<p>
1436
 
</p>
1437
1383
<div class="variablelist"><table border="0">
1438
1384
<col align="left" valign="top">
1439
1385
<tbody>
1456
1402
<a name="ClutterStage.property-details"></a><h2>Property Details</h2>
1457
1403
<div class="refsect2" title='The "color" property'>
1458
1404
<a name="ClutterStage--color"></a><h3>The <code class="literal">"color"</code> property</h3>
1459
 
<pre class="programlisting">  "color"                    <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor">ClutterColor</a>*         : Read / Write</pre>
 
1405
<pre class="programlisting">  "color"                    <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>*         : Read / Write</pre>
1460
1406
<p>
1461
1407
The color of the main stage.</p>
1462
 
<p>
1463
 
</p>
1464
1408
</div>
1465
1409
<hr>
1466
1410
<div class="refsect2" title='The "cursor-visible" property'>
1467
1411
<a name="ClutterStage--cursor-visible"></a><h3>The <code class="literal">"cursor-visible"</code> property</h3>
1468
 
<pre class="programlisting">  "cursor-visible"           <a
1469
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1470
 
>gboolean</a>              : Read / Write</pre>
 
1412
<pre class="programlisting">  "cursor-visible"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
1471
1413
<p>
1472
1414
Whether the mouse pointer should be visible</p>
1473
 
<p>
1474
 
</p>
1475
1415
<p>Default value: TRUE</p>
1476
1416
</div>
1477
1417
<hr>
1478
1418
<div class="refsect2" title='The "fog" property'>
1479
1419
<a name="ClutterStage--fog"></a><h3>The <code class="literal">"fog"</code> property</h3>
1480
 
<pre class="programlisting">  "fog"                      <a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog">ClutterFog</a>*           : Read / Write</pre>
 
1420
<pre class="programlisting">  "fog"                      <a class="link" href="ClutterStage.html#ClutterFog" title="ClutterFog"><span class="type">ClutterFog</span></a>*           : Read / Write</pre>
1481
1421
<p>
1482
1422
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>
1483
 
is set to <a
1484
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
1485
 
><code class="literal">TRUE</code></a></p>
1486
 
<p>
1487
 
</p>
1488
 
<p>Since 1.0</p>
 
1423
is set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a></p>
 
1424
<p class="since">Since 1.0</p>
1489
1425
</div>
1490
1426
<hr>
1491
1427
<div class="refsect2" title='The "fullscreen-set" property'>
1492
1428
<a name="ClutterStage--fullscreen-set"></a><h3>The <code class="literal">"fullscreen-set"</code> property</h3>
1493
 
<pre class="programlisting">  "fullscreen-set"           <a
1494
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1495
 
>gboolean</a>              : Read</pre>
 
1429
<pre class="programlisting">  "fullscreen-set"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read</pre>
1496
1430
<p>Whether the main stage is fullscreen.</p>
1497
1431
<p>Default value: FALSE</p>
1498
1432
</div>
1499
1433
<hr>
 
1434
<div class="refsect2" title='The "key-focus" property'>
 
1435
<a name="ClutterStage--key-focus"></a><h3>The <code class="literal">"key-focus"</code> property</h3>
 
1436
<pre class="programlisting">  "key-focus"                <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>*         : Read / Write</pre>
 
1437
<p>
 
1438
The <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> that will receive key events from the underlying
 
1439
windowing system.
 
1440
</p>
 
1441
<p>
 
1442
If <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.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.</p>
 
1443
<p class="since">Since 1.2</p>
 
1444
</div>
 
1445
<hr>
1500
1446
<div class="refsect2" title='The "offscreen" property'>
1501
1447
<a name="ClutterStage--offscreen"></a><h3>The <code class="literal">"offscreen"</code> property</h3>
1502
 
<pre class="programlisting">  "offscreen"                <a
1503
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1504
 
>gboolean</a>              : Read / Write</pre>
 
1448
<pre class="programlisting">  "offscreen"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
1505
1449
<p>
1506
1450
Whether the stage should be rendered in an offscreen buffer.
1507
1451
</p>
1513
1457
stage to an offscreen buffer. This property might not work
1514
1458
and it might be deprecated at any later date.</p>
1515
1459
</div>
1516
 
<p>
1517
 
</p>
1518
1460
<p>Default value: FALSE</p>
1519
1461
</div>
1520
1462
<hr>
1521
1463
<div class="refsect2" title='The "perspective" property'>
1522
1464
<a name="ClutterStage--perspective"></a><h3>The <code class="literal">"perspective"</code> property</h3>
1523
 
<pre class="programlisting">  "perspective"              <a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective">ClutterPerspective</a>*   : Read / Write</pre>
 
1465
<pre class="programlisting">  "perspective"              <a class="link" href="ClutterStage.html#ClutterPerspective" title="ClutterPerspective"><span class="type">ClutterPerspective</span></a>*   : Read / Write</pre>
1524
1466
<p>
1525
1467
The parameters used for the perspective projection from 3D
1526
1468
coordinates to 2D</p>
1527
 
<p>
1528
 
</p>
1529
 
<p>Since 0.8.2</p>
 
1469
<p class="since">Since 0.8.2</p>
1530
1470
</div>
1531
1471
<hr>
1532
1472
<div class="refsect2" title='The "title" property'>
1533
1473
<a name="ClutterStage--title"></a><h3>The <code class="literal">"title"</code> property</h3>
1534
 
<pre class="programlisting">  "title"                    <a
1535
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1536
 
>gchar</a>*                : Read / Write</pre>
 
1474
<pre class="programlisting">  "title"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
1537
1475
<p>
1538
1476
The stage's title - usually displayed in stage windows title decorations.</p>
1539
 
<p>
1540
 
</p>
1541
1477
<p>Default value: NULL</p>
1542
 
<p>Since 0.4</p>
 
1478
<p class="since">Since 0.4</p>
 
1479
</div>
 
1480
<hr>
 
1481
<div class="refsect2" title='The "use-alpha" property'>
 
1482
<a name="ClutterStage--use-alpha"></a><h3>The <code class="literal">"use-alpha"</code> property</h3>
 
1483
<pre class="programlisting">  "use-alpha"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 
1484
<p>
 
1485
Whether the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> should honour the alpha component of the
 
1486
<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
 
1487
a compositing manager this will result in the stage being blended
 
1488
with the underlying window(s)</p>
 
1489
<p>Default value: FALSE</p>
 
1490
<p class="since">Since 1.2</p>
1543
1491
</div>
1544
1492
<hr>
1545
1493
<div class="refsect2" title='The "use-fog" property'>
1546
1494
<a name="ClutterStage--use-fog"></a><h3>The <code class="literal">"use-fog"</code> property</h3>
1547
 
<pre class="programlisting">  "use-fog"                  <a
1548
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1549
 
>gboolean</a>              : Read / Write</pre>
 
1495
<pre class="programlisting">  "use-fog"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
1550
1496
<p>
1551
1497
Whether the stage should use a linear GL "fog" in creating the
1552
1498
depth-cueing effect, to enhance the perception of depth by fading
1553
1499
actors farther from the viewpoint.</p>
1554
 
<p>
1555
 
</p>
1556
1500
<p>Default value: FALSE</p>
1557
 
<p>Since 0.6</p>
 
1501
<p class="since">Since 0.6</p>
1558
1502
</div>
1559
1503
<hr>
1560
1504
<div class="refsect2" title='The "user-resizable" property'>
1561
1505
<a name="ClutterStage--user-resizable"></a><h3>The <code class="literal">"user-resizable"</code> property</h3>
1562
 
<pre class="programlisting">  "user-resizable"           <a
1563
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1564
 
>gboolean</a>              : Read / Write</pre>
 
1506
<pre class="programlisting">  "user-resizable"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
1565
1507
<p>
1566
1508
Whether the stage is resizable via user interaction.</p>
1567
 
<p>
1568
 
</p>
1569
1509
<p>Default value: FALSE</p>
1570
 
<p>Since 0.4</p>
 
1510
<p class="since">Since 0.4</p>
1571
1511
</div>
1572
1512
</div>
1573
1513
<div class="refsect1" title="Signal Details">
1574
1514
<a name="ClutterStage.signal-details"></a><h2>Signal Details</h2>
1575
1515
<div class="refsect2" title='The "activate" signal'>
1576
1516
<a name="ClutterStage-activate"></a><h3>The <code class="literal">"activate"</code> signal</h3>
1577
 
<pre class="programlisting">void                user_function                      (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
1578
 
                                                        <a
1579
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
1580
 
>gpointer</a>      user_data)      : Run Last</pre>
 
1517
<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,
 
1518
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : Run Last</pre>
1581
1519
<p>
1582
1520
The ::activate signal is emitted when the stage receives key focus
1583
1521
from the underlying window system.</p>
1584
 
<p>
1585
 
</p>
1586
1522
<div class="variablelist"><table border="0">
1587
1523
<col align="left" valign="top">
1588
1524
<tbody>
1597
1533
</tr>
1598
1534
</tbody>
1599
1535
</table></div>
1600
 
<p>Since 0.6</p>
 
1536
<p class="since">Since 0.6</p>
1601
1537
</div>
1602
1538
<hr>
1603
1539
<div class="refsect2" title='The "deactivate" signal'>
1604
1540
<a name="ClutterStage-deactivate"></a><h3>The <code class="literal">"deactivate"</code> signal</h3>
1605
 
<pre class="programlisting">void                user_function                      (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
1606
 
                                                        <a
1607
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
1608
 
>gpointer</a>      user_data)      : Run Last</pre>
 
1541
<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,
 
1542
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : Run Last</pre>
1609
1543
<p>
1610
1544
The ::activate signal is emitted when the stage loses key focus
1611
1545
from the underlying window system.</p>
1612
 
<p>
1613
 
</p>
1614
1546
<div class="variablelist"><table border="0">
1615
1547
<col align="left" valign="top">
1616
1548
<tbody>
1625
1557
</tr>
1626
1558
</tbody>
1627
1559
</table></div>
1628
 
<p>Since 0.6</p>
 
1560
<p class="since">Since 0.6</p>
 
1561
</div>
 
1562
<hr>
 
1563
<div class="refsect2" title='The "delete-event" signal'>
 
1564
<a name="ClutterStage-delete-event"></a><h3>The <code class="literal">"delete-event"</code> signal</h3>
 
1565
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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,
 
1566
                                                        <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event,
 
1567
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : Run Last</pre>
 
1568
<p>
 
1569
The ::delete-event signal is emitted when the user closes a
 
1570
<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> window using the window controls.
 
1571
</p>
 
1572
<p>
 
1573
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
 
1574
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
 
1575
stage.
 
1576
</p>
 
1577
<p>
 
1578
It is possible to override the default behaviour by connecting
 
1579
a new handler and returning <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> there.
 
1580
</p>
 
1581
<p>
 
1582
</p>
 
1583
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1584
<h3 class="title">Note</h3>This signal is emitted only on Clutter backends that
 
1585
embed <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> in native windows. It is not emitted for
 
1586
backends that use a static frame buffer.</div>
 
1587
<div class="variablelist"><table border="0">
 
1588
<col align="left" valign="top">
 
1589
<tbody>
 
1590
<tr>
 
1591
<td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
 
1592
<td> the stage that received the event
 
1593
</td>
 
1594
</tr>
 
1595
<tr>
 
1596
<td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
 
1597
<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>
 
1598
</td>
 
1599
</tr>
 
1600
<tr>
 
1601
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
1602
<td>user data set when the signal handler was connected.</td>
 
1603
</tr>
 
1604
</tbody>
 
1605
</table></div>
 
1606
<p class="since">Since 1.2</p>
1629
1607
</div>
1630
1608
<hr>
1631
1609
<div class="refsect2" title='The "fullscreen" signal'>
1632
1610
<a name="ClutterStage-fullscreen"></a><h3>The <code class="literal">"fullscreen"</code> signal</h3>
1633
 
<pre class="programlisting">void                user_function                      (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
1634
 
                                                        <a
1635
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
1636
 
>gpointer</a>      user_data)      : Run First</pre>
 
1611
<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,
 
1612
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : Run First</pre>
1637
1613
<p>
1638
1614
The ::fullscreen signal is emitted when the stage is made fullscreen.</p>
1639
 
<p>
1640
 
</p>
1641
1615
<div class="variablelist"><table border="0">
1642
1616
<col align="left" valign="top">
1643
1617
<tbody>
1652
1626
</tr>
1653
1627
</tbody>
1654
1628
</table></div>
1655
 
<p>Since 0.6</p>
 
1629
<p class="since">Since 0.6</p>
1656
1630
</div>
1657
1631
<hr>
1658
1632
<div class="refsect2" title='The "unfullscreen" signal'>
1659
1633
<a name="ClutterStage-unfullscreen"></a><h3>The <code class="literal">"unfullscreen"</code> signal</h3>
1660
 
<pre class="programlisting">void                user_function                      (<a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a> *stage,
1661
 
                                                        <a
1662
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
1663
 
>gpointer</a>      user_data)      : Run Last</pre>
 
1634
<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,
 
1635
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)      : Run Last</pre>
1664
1636
<p>
1665
1637
The ::unfullscreen signal is emitted when the stage leaves a fullscreen
1666
1638
state.</p>
1667
 
<p>
1668
 
</p>
1669
1639
<div class="variablelist"><table border="0">
1670
1640
<col align="left" valign="top">
1671
1641
<tbody>
1680
1650
</tr>
1681
1651
</tbody>
1682
1652
</table></div>
1683
 
<p>Since 0.6</p>
 
1653
<p class="since">Since 0.6</p>
1684
1654
</div>
1685
1655
</div>
1686
1656
</div>
1687
1657
<div class="footer">
1688
1658
<hr>
1689
 
          Generated by GTK-Doc V1.11</div>
 
1659
          Generated by GTK-Doc V1.13</div>
1690
1660
</body>
1691
 
</html>
 
1661
</html>
 
 
b'\\ No newline at end of file'