<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClutterStage: Clutter Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Clutter Reference Manual">
<link rel="up" href="ch02.html" title="Base actors">
<link rel="prev" href="ch02.html" title="Base actors">
<link rel="next" href="ClutterClone.html" title="ClutterClone">
<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#ClutterStage.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ClutterStage.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#ClutterStage.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ClutterStage.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#ClutterStage.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch02.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterClone.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterStage"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterStage.top_of_page"></a>ClutterStage</span></h2>
<p>ClutterStage — Top level visual element to which actors are placed.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterStage.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-new" title="clutter_stage_new ()">clutter_stage_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-ensure-current" title="clutter_stage_ensure_current ()">clutter_stage_ensure_current</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-ensure-viewport" title="clutter_stage_ensure_viewport ()">clutter_stage_ensure_viewport</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-ensure-redraw" title="clutter_stage_ensure_redraw ()">clutter_stage_ensure_redraw</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-event" title="clutter_stage_event ()">clutter_stage_event</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-set-key-focus" title="clutter_stage_set_key_focus ()">clutter_stage_set_key_focus</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-get-key-focus" title="clutter_stage_get_key_focus ()">clutter_stage_get_key_focus</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guchar</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-read-pixels" title="clutter_stage_read_pixels ()">clutter_stage_read_pixels</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-set-use-alpha" title="clutter_stage_set_use_alpha ()">clutter_stage_set_use_alpha</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-get-use-alpha" title="clutter_stage_get_use_alpha ()">clutter_stage_get_use_alpha</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-set-minimum-size" title="clutter_stage_set_minimum_size ()">clutter_stage_set_minimum_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-get-minimum-size" title="clutter_stage_get_minimum_size ()">clutter_stage_get_minimum_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-set-no-clear-hint" title="clutter_stage_set_no_clear_hint ()">clutter_stage_set_no_clear_hint</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-get-no-clear-hint" title="clutter_stage_get_no_clear_hint ()">clutter_stage_get_no_clear_hint</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-get-redraw-clip-bounds" title="clutter_stage_get_redraw_clip_bounds ()">clutter_stage_get_redraw_clip_bounds</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-get-motion-events-enabled" title="clutter_stage_get_motion_events_enabled ()">clutter_stage_get_motion_events_enabled</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-set-motion-events-enabled" title="clutter_stage_set_motion_events_enabled ()">clutter_stage_set_motion_events_enabled</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-set-perspective" title="clutter_stage_set_perspective ()">clutter_stage_set_perspective</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-get-perspective" title="clutter_stage_get_perspective ()">clutter_stage_get_perspective</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-set-title" title="clutter_stage_set_title ()">clutter_stage_set_title</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-get-title" title="clutter_stage_get_title ()">clutter_stage_get_title</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-set-user-resizable" title="clutter_stage_set_user_resizable ()">clutter_stage_set_user_resizable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-get-user-resizable" title="clutter_stage_get_user_resizable ()">clutter_stage_get_user_resizable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-set-fullscreen" title="clutter_stage_set_fullscreen ()">clutter_stage_set_fullscreen</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-get-fullscreen" title="clutter_stage_get_fullscreen ()">clutter_stage_get_fullscreen</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-show-cursor" title="clutter_stage_show_cursor ()">clutter_stage_show_cursor</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-hide-cursor" title="clutter_stage_hide_cursor ()">clutter_stage_hide_cursor</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-set-accept-focus" title="clutter_stage_set_accept_focus ()">clutter_stage_set_accept_focus</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-get-accept-focus" title="clutter_stage_get_accept_focus ()">clutter_stage_get_accept_focus</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-set-sync-delay" title="clutter_stage_set_sync_delay ()">clutter_stage_set_sync_delay</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-skip-sync-delay" title="clutter_stage_skip_sync_delay ()">clutter_stage_skip_sync_delay</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ClutterStage.html#CLUTTER-STAGE-WIDTH:CAPS" title="CLUTTER_STAGE_WIDTH">CLUTTER_STAGE_WIDTH</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ClutterStage.html#CLUTTER-STAGE-HEIGHT:CAPS" title="CLUTTER_STAGE_HEIGHT">CLUTTER_STAGE_HEIGHT</a></td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-get-default" title="clutter_stage_get_default ()">clutter_stage_get_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-is-default" title="clutter_stage_is_default ()">clutter_stage_is_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-set-color" title="clutter_stage_set_color ()">clutter_stage_set_color</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-get-color" title="clutter_stage_get_color ()">clutter_stage_get_color</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-queue-redraw" title="clutter_stage_queue_redraw ()">clutter_stage_queue_redraw</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-set-use-fog" title="clutter_stage_set_use_fog ()">clutter_stage_set_use_fog</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-get-use-fog" title="clutter_stage_get_use_fog ()">clutter_stage_get_use_fog</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-set-fog" title="clutter_stage_set_fog ()">clutter_stage_set_fog</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterStage.html#clutter-stage-get-fog" title="clutter_stage_get_fog ()">clutter_stage_get_fog</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterStage.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterStage.html#ClutterStage--accept-focus" title="The “accept-focus” property">accept-focus</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *</td>
<td class="property_name"><a class="link" href="ClutterStage.html#ClutterStage--color" title="The “color” property">color</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterStage.html#ClutterStage--cursor-visible" title="The “cursor-visible” property">cursor-visible</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="ClutterStage.html#ClutterFog"><span class="type">ClutterFog</span></a> *</td>
<td class="property_name"><a class="link" href="ClutterStage.html#ClutterStage--fog" title="The “fog” property">fog</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterStage.html#ClutterStage--fullscreen-set" title="The “fullscreen-set” property">fullscreen-set</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *</td>
<td class="property_name"><a class="link" href="ClutterStage.html#ClutterStage--key-focus" title="The “key-focus” property">key-focus</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterStage.html#ClutterStage--no-clear-hint" title="The “no-clear-hint” property">no-clear-hint</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterStage.html#ClutterStage--offscreen" title="The “offscreen” property">offscreen</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="ClutterStage.html#ClutterPerspective"><span class="type">ClutterPerspective</span></a> *</td>
<td class="property_name"><a class="link" href="ClutterStage.html#ClutterStage--perspective" title="The “perspective” property">perspective</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="ClutterStage.html#ClutterStage--title" title="The “title” property">title</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterStage.html#ClutterStage--use-alpha" title="The “use-alpha” property">use-alpha</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterStage.html#ClutterStage--use-fog" title="The “use-fog” property">use-fog</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterStage.html#ClutterStage--user-resizable" title="The “user-resizable” property">user-resizable</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterStage.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ClutterStage.html#ClutterStage-activate" title="The “activate” signal">activate</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ClutterStage.html#ClutterStage-after-paint" title="The “after-paint” signal">after-paint</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ClutterStage.html#ClutterStage-deactivate" title="The “deactivate” signal">deactivate</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">gboolean</span></td>
<td class="signal_name"><a class="link" href="ClutterStage.html#ClutterStage-delete-event" title="The “delete-event” signal">delete-event</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ClutterStage.html#ClutterStage-fullscreen" title="The “fullscreen” signal">fullscreen</a></td>
<td class="signal_flags">Run First</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ClutterStage.html#ClutterStage-unfullscreen" title="The “unfullscreen” signal">unfullscreen</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<a name="ClutterPerspective"></a><a name="ClutterFog"></a><div class="refsect1">
<a name="ClutterStage.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="ClutterStage.html#ClutterStage-struct" title="ClutterStage">ClutterStage</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterStage.html#ClutterStageClass" title="struct ClutterStageClass">ClutterStageClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="ClutterStage.html#ClutterPickMode" title="enum ClutterPickMode">ClutterPickMode</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="ClutterStage.html#ClutterPerspective-struct" title="ClutterPerspective">ClutterPerspective</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="ClutterStage.html#ClutterFog-struct" title="ClutterFog">ClutterFog</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterStage.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/home/ebassi/gnome/install/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a>
<span class="lineart">├──</span> ClutterFog
<span class="lineart">╰──</span> ClutterPerspective
GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
<span class="lineart">╰──</span> <a class="link" href="ClutterGroup.html" title="ClutterGroup">ClutterGroup</a>
<span class="lineart">╰──</span> ClutterStage
</pre>
</div>
<div class="refsect1">
<a name="ClutterStage.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
ClutterStage implements
<a class="link" href="ClutterContainer.html" title="ClutterContainer">ClutterContainer</a>, <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>, <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable">ClutterAnimatable</a> and AtkImplementorIface.</p>
</div>
<div class="refsect1">
<a name="ClutterStage.description"></a><h2>Description</h2>
<p><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> is a top level 'window' on which child actors are placed
and manipulated.</p>
<p>Backends might provide support for multiple stages. The support for this
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>
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
supports multiple stages, new <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> instances can be created
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
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
actors contained inside them.</p>
<p><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> is a proxy actor, wrapping the backend-specific
implementation of the windowing system. It is possible to subclass
<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>, as long as every overridden virtual function chains up to
the parent class corresponding function.</p>
</div>
<div class="refsect1">
<a name="ClutterStage.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-stage-new"></a><h3>clutter_stage_new ()</h3>
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
clutter_stage_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new, non-default stage. A non-default stage is a new
top-level actor which can be used as another container. It works
exactly like the default stage, but while <a class="link" href="ClutterStage.html#clutter-stage-get-default" title="clutter_stage_get_default ()"><code class="function">clutter_stage_get_default()</code></a>
will always return the same instance, you will have to keep a pointer
to any <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> returned by <a class="link" href="ClutterStage.html#clutter-stage-new" title="clutter_stage_new ()"><code class="function">clutter_stage_new()</code></a>.</p>
<p>The ability to support multiple stages depends on the current
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
<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
backend supports multiple stages.</p>
<div class="refsect3">
<a name="clutter-stage-new.returns"></a><h4>Returns</h4>
<p> a new stage, or <code class="literal">NULL</code> if the default backend does
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
programmatically close the returned stage.</p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-get-actor-at-pos"></a><h3>clutter_stage_get_actor_at_pos ()</h3>
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
clutter_stage_get_actor_at_pos (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><a class="link" href="ClutterStage.html#ClutterPickMode" title="enum ClutterPickMode"><span class="type">ClutterPickMode</span></a> pick_mode</code></em>,
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
<em class="parameter"><code><span class="type">gint</span> y</code></em>);</pre>
<p>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
to the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> at those coordinates.</p>
<p>By using <em class="parameter"><code>pick_mode</code></em>
it is possible to control which actors will be
painted and thus available.</p>
<div class="refsect3">
<a name="clutter-stage-get-actor-at-pos.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pick_mode</p></td>
<td class="parameter_description"><p>how the scene graph should be painted</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>X coordinate to check</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>Y coordinate to check</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-stage-get-actor-at-pos.returns"></a><h4>Returns</h4>
<p> the actor at the specified coordinates,
if any. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-ensure-current"></a><h3>clutter_stage_ensure_current ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_ensure_current (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<p>This function essentially makes sure the right GL context is
current for the passed stage. It is not intended to
be used by applications.</p>
<div class="refsect3">
<a name="clutter-stage-ensure-current.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-ensure-viewport"></a><h3>clutter_stage_ensure_viewport ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_ensure_viewport (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<p>Ensures that the GL viewport is updated with the current
stage window size.</p>
<p>This function will queue a redraw of <em class="parameter"><code>stage</code></em>
.</p>
<p>This function should not be called by applications; it is used
when embedding a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> into a toolkit with another
windowing system, like GTK+.</p>
<div class="refsect3">
<a name="clutter-stage-ensure-viewport.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-ensure-redraw"></a><h3>clutter_stage_ensure_redraw ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_ensure_redraw (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<p>Ensures that <em class="parameter"><code>stage</code></em>
is redrawn</p>
<p>This function should not be called by applications: it is
used when embedding a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> into a toolkit with
another windowing system, like GTK+.</p>
<div class="refsect3">
<a name="clutter-stage-ensure-redraw.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-event"></a><h3>clutter_stage_event ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_stage_event (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
<p>This function is used to emit an event on the main stage.</p>
<p>You should rarely need to use this function, except for
synthetised events.</p>
<div class="refsect3">
<a name="clutter-stage-event.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>event</p></td>
<td class="parameter_description"><p>a <a class="link" href="clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-stage-event.returns"></a><h4>Returns</h4>
<p> the return value from the signal emission</p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-set-key-focus"></a><h3>clutter_stage_set_key_focus ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_set_key_focus (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);</pre>
<p>Sets the key focus on <em class="parameter"><code>actor</code></em>
. An actor with key focus will receive
all the key events. If <em class="parameter"><code>actor</code></em>
is <code class="literal">NULL</code>, the stage will receive
focus.</p>
<div class="refsect3">
<a name="clutter-stage-set-key-focus.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>actor</p></td>
<td class="parameter_description"><p> the actor to set key focus to, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-get-key-focus"></a><h3>clutter_stage_get_key_focus ()</h3>
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
clutter_stage_get_key_focus (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<p>Retrieves the actor that is currently under key focus.</p>
<div class="refsect3">
<a name="clutter-stage-get-key-focus.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-stage-get-key-focus.returns"></a><h4>Returns</h4>
<p> the actor with key focus, or the stage. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-read-pixels"></a><h3>clutter_stage_read_pixels ()</h3>
<pre class="programlisting"><span class="returnvalue">guchar</span> *
clutter_stage_read_pixels (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
<em class="parameter"><code><span class="type">gint</span> y</code></em>,
<em class="parameter"><code><span class="type">gint</span> width</code></em>,
<em class="parameter"><code><span class="type">gint</span> height</code></em>);</pre>
<p>Makes a screenshot of the stage in RGBA 8bit data, returns a
linear buffer with <em class="parameter"><code>width</code></em>
* 4 as rowstride.</p>
<p>The alpha data contained in the returned buffer is driver-dependent,
and not guaranteed to hold any sensible value.</p>
<div class="refsect3">
<a name="clutter-stage-read-pixels.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>x coordinate of the first pixel that is read from stage</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>y coordinate of the first pixel that is read from stage</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>Width dimention of pixels to be read, or -1 for the
entire stage width</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>Height dimention of pixels to be read, or -1 for the
entire stage height</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-stage-read-pixels.returns"></a><h4>Returns</h4>
<p> a pointer to newly allocated memory with the buffer
or <code class="literal">NULL</code> if the read failed. Use <code class="function">g_free()</code> on the returned data
to release the resources it has allocated. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-set-throttle-motion-events"></a><h3>clutter_stage_set_throttle_motion_events ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_set_throttle_motion_events
(<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> throttle</code></em>);</pre>
<p>Sets whether motion events received between redraws should
be throttled or not. If motion events are throttled, those
events received by the windowing system between redraws will
be compressed so that only the last event will be propagated
to the <em class="parameter"><code>stage</code></em>
and its actors.</p>
<p>This function should only be used if you want to have all
the motion events delivered to your application code.</p>
<div class="refsect3">
<a name="clutter-stage-set-throttle-motion-events.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>throttle</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> to throttle motion events</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-get-throttle-motion-events"></a><h3>clutter_stage_get_throttle_motion_events ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_stage_get_throttle_motion_events
(<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<p>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>
<div class="refsect3">
<a name="clutter-stage-get-throttle-motion-events.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-stage-get-throttle-motion-events.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the motion events are being throttled,
and <code class="literal">FALSE</code> otherwise</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-set-use-alpha"></a><h3>clutter_stage_set_use_alpha ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_set_use_alpha (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> use_alpha</code></em>);</pre>
<p>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
the alpha channel of the <a class="link" href="ClutterStage.html#ClutterStage--color" title="The “color” property"><span class="type">“color”</span></a></p>
<div class="refsect3">
<a name="clutter-stage-set-use-alpha.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>use_alpha</p></td>
<td class="parameter_description"><p>whether the stage should honour the opacity or the
alpha channel of the stage color</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-get-use-alpha"></a><h3>clutter_stage_get_use_alpha ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_stage_get_use_alpha (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<p>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>
<div class="refsect3">
<a name="clutter-stage-get-use-alpha.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-stage-get-use-alpha.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the stage should honour the opacity and the
alpha channel of the stage color</p>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-set-minimum-size"></a><h3>clutter_stage_set_minimum_size ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_set_minimum_size (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><span class="type">guint</span> width</code></em>,
<em class="parameter"><code><span class="type">guint</span> height</code></em>);</pre>
<p>Sets the minimum size for a stage window, if the default backend
uses <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> inside a window</p>
<p>This is a convenience function, and it is equivalent to setting the
<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>
</p>
<p>If the current size of <em class="parameter"><code>stage</code></em>
is smaller than the minimum size, the
<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>
</p>
<p>This function has no effect if <em class="parameter"><code>stage</code></em>
is fullscreen</p>
<div class="refsect3">
<a name="clutter-stage-set-minimum-size.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>width, in pixels</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>height, in pixels</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-get-minimum-size"></a><h3>clutter_stage_get_minimum_size ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_get_minimum_size (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><span class="type">guint</span> *width</code></em>,
<em class="parameter"><code><span class="type">guint</span> *height</code></em>);</pre>
<p>Retrieves the minimum size for a stage window as set using
<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>.</p>
<p>The returned size may not correspond to the actual minimum size and
it is specific to the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> implementation inside the
Clutter backend</p>
<div class="refsect3">
<a name="clutter-stage-get-minimum-size.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p> return location for the minimum width, in pixels,
or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p> return location for the minimum height, in pixels,
or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-set-no-clear-hint"></a><h3>clutter_stage_set_no_clear_hint ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_set_no_clear_hint (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> no_clear</code></em>);</pre>
<p>Sets whether the <em class="parameter"><code>stage</code></em>
should clear itself at the beginning
of each paint cycle or not.</p>
<p>Clearing the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> can be a costly operation, especially
if the stage is always covered - for instance, in a full-screen
video player or in a game with a background texture.</p>
<p>This setting is a hint; Clutter might discard this hint
depending on its internal state.</p>
<p>If parts of the stage are visible and you disable clearing you
might end up with visual artifacts while painting the contents of
the stage.</p>
<div class="refsect3">
<a name="clutter-stage-set-no-clear-hint.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>no_clear</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if the <em class="parameter"><code>stage</code></em>
should not clear itself on every
repaint cycle</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-get-no-clear-hint"></a><h3>clutter_stage_get_no_clear_hint ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_stage_get_no_clear_hint (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<p>Retrieves the hint set with <a class="link" href="ClutterStage.html#clutter-stage-set-no-clear-hint" title="clutter_stage_set_no_clear_hint ()"><code class="function">clutter_stage_set_no_clear_hint()</code></a></p>
<div class="refsect3">
<a name="clutter-stage-get-no-clear-hint.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-stage-get-no-clear-hint.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the stage should not clear itself on every paint
cycle, and <code class="literal">FALSE</code> otherwise</p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-get-redraw-clip-bounds"></a><h3>clutter_stage_get_redraw_clip_bounds ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_get_redraw_clip_bounds (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/cairo/cairo-Types.html#cairo-rectangle-int-t"><span class="type">cairo_rectangle_int_t</span></a> *clip</code></em>);</pre>
<p>Gets the bounds of the current redraw for <em class="parameter"><code>stage</code></em>
in stage pixel
coordinates. E.g., if only a single actor has queued a redraw then
Clutter may redraw the stage with a clip so that it doesn't have to
paint every pixel in the stage. This function would then return the
bounds of that clip. An application can use this information to
avoid some extra work if it knows that some regions of the stage
aren't going to be painted. This should only be called while the
stage is being painted. If there is no current redraw clip then
this function will set <em class="parameter"><code>clip</code></em>
to the full extents of the stage.</p>
<div class="refsect3">
<a name="clutter-stage-get-redraw-clip-bounds.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>clip</p></td>
<td class="parameter_description"><p> Return location for the clip bounds. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-get-motion-events-enabled"></a><h3>clutter_stage_get_motion_events_enabled ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_stage_get_motion_events_enabled
(<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<p>Retrieves the value set using <a class="link" href="ClutterStage.html#clutter-stage-set-motion-events-enabled" title="clutter_stage_set_motion_events_enabled ()"><code class="function">clutter_stage_set_motion_events_enabled()</code></a>.</p>
<div class="refsect3">
<a name="clutter-stage-get-motion-events-enabled.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-stage-get-motion-events-enabled.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the per-actor motion event delivery is enabled
and <code class="literal">FALSE</code> otherwise</p>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-set-motion-events-enabled"></a><h3>clutter_stage_set_motion_events_enabled ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_set_motion_events_enabled
(<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> enabled</code></em>);</pre>
<p>Sets whether per-actor motion events (and relative crossing
events) should be disabled or not.</p>
<p>The default is <code class="literal">TRUE</code>.</p>
<p>If <em class="parameter"><code>enable</code></em>
is <code class="literal">FALSE</code> the following signals will not be emitted
by the actors children of <em class="parameter"><code>stage</code></em>
:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><a class="link" href="ClutterActor.html#ClutterActor-motion-event" title="The “motion-event” signal"><span class="type">“motion-event”</span></a></p></li>
<li class="listitem"><p><a class="link" href="ClutterActor.html#ClutterActor-enter-event" title="The “enter-event” signal"><span class="type">“enter-event”</span></a></p></li>
<li class="listitem"><p><a class="link" href="ClutterActor.html#ClutterActor-leave-event" title="The “leave-event” signal"><span class="type">“leave-event”</span></a></p></li>
</ul></div>
<p>The events will still be delivered to the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>.</p>
<p>The main side effect of this function is that disabling the motion
events will disable picking to detect the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> underneath
the pointer for each motion event. This is useful, for instance,
when dragging a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> across the <em class="parameter"><code>stage</code></em>
: the actor underneath
the pointer is not going to change, so it's meaningless to perform
a pick.</p>
<div class="refsect3">
<a name="clutter-stage-set-motion-events-enabled.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>enabled</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> to enable the motion events delivery, and <code class="literal">FALSE</code>
otherwise</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-set-perspective"></a><h3>clutter_stage_set_perspective ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_set_perspective (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><a class="link" href="ClutterStage.html#ClutterPerspective"><span class="type">ClutterPerspective</span></a> *perspective</code></em>);</pre>
<p>Sets the stage perspective. Using this function is not recommended
because it will disable Clutter's attempts to generate an
appropriate perspective based on the size of the stage.</p>
<div class="refsect3">
<a name="clutter-stage-set-perspective.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>perspective</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterStage.html#ClutterPerspective"><span class="type">ClutterPerspective</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-get-perspective"></a><h3>clutter_stage_get_perspective ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_get_perspective (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><a class="link" href="ClutterStage.html#ClutterPerspective"><span class="type">ClutterPerspective</span></a> *perspective</code></em>);</pre>
<p>Retrieves the stage perspective.</p>
<div class="refsect3">
<a name="clutter-stage-get-perspective.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>perspective</p></td>
<td class="parameter_description"><p> return location for a
<a class="link" href="ClutterStage.html#ClutterPerspective"><span class="type">ClutterPerspective</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-set-title"></a><h3>clutter_stage_set_title ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_set_title (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>);</pre>
<p>Sets the stage title.</p>
<div class="refsect3">
<a name="clutter-stage-set-title.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>title</p></td>
<td class="parameter_description"><p>A utf8 string for the stage windows title.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-get-title"></a><h3>clutter_stage_get_title ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
clutter_stage_get_title (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<p>Gets the stage title.</p>
<div class="refsect3">
<a name="clutter-stage-get-title.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-stage-get-title.returns"></a><h4>Returns</h4>
<p> pointer to the title string for the stage. The
returned string is owned by the actor and should not
be modified or freed.</p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-set-user-resizable"></a><h3>clutter_stage_set_user_resizable ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_set_user_resizable (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> resizable</code></em>);</pre>
<p>Sets if the stage is resizable by user interaction (e.g. via
window manager controls)</p>
<div class="refsect3">
<a name="clutter-stage-set-user-resizable.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>resizable</p></td>
<td class="parameter_description"><p>whether the stage should be user resizable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-get-user-resizable"></a><h3>clutter_stage_get_user_resizable ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_stage_get_user_resizable (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<p>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>
<div class="refsect3">
<a name="clutter-stage-get-user-resizable.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-stage-get-user-resizable.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the stage is resizable by the user.</p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-set-fullscreen"></a><h3>clutter_stage_set_fullscreen ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_set_fullscreen (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> fullscreen</code></em>);</pre>
<p>Asks to place the stage window in the fullscreen or unfullscreen
states.</p>
<p> ( Note that you shouldn't assume the window is definitely full screen
afterward, because other entities (e.g. the user or window manager)
could unfullscreen it again, and not all window managers honor
requests to fullscreen windows.</p>
<p>If you want to receive notification of the fullscreen state you
should either use the <a class="link" href="ClutterStage.html#ClutterStage-fullscreen" title="The “fullscreen” signal"><span class="type">“fullscreen”</span></a> and
<a class="link" href="ClutterStage.html#ClutterStage-unfullscreen" title="The “unfullscreen” signal"><span class="type">“unfullscreen”</span></a> signals, or use the notify signal
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>
<div class="refsect3">
<a name="clutter-stage-set-fullscreen.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fullscreen</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> to to set the stage fullscreen</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-get-fullscreen"></a><h3>clutter_stage_get_fullscreen ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_stage_get_fullscreen (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<p>Retrieves whether the stage is full screen or not</p>
<div class="refsect3">
<a name="clutter-stage-get-fullscreen.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-stage-get-fullscreen.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the stage is full screen</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-show-cursor"></a><h3>clutter_stage_show_cursor ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_show_cursor (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<p>Shows the cursor on the stage window</p>
<div class="refsect3">
<a name="clutter-stage-show-cursor.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-hide-cursor"></a><h3>clutter_stage_hide_cursor ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_hide_cursor (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<p>Makes the cursor invisible on the stage window</p>
<div class="refsect3">
<a name="clutter-stage-hide-cursor.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-set-accept-focus"></a><h3>clutter_stage_set_accept_focus ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_set_accept_focus (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> accept_focus</code></em>);</pre>
<p>Sets whether the <em class="parameter"><code>stage</code></em>
should accept the key focus when shown.</p>
<p>This function should be called before showing <em class="parameter"><code>stage</code></em>
using
<a class="link" href="ClutterActor.html#clutter-actor-show" title="clutter_actor_show ()"><code class="function">clutter_actor_show()</code></a>.</p>
<div class="refsect3">
<a name="clutter-stage-set-accept-focus.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>accept_focus</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> to accept focus on show</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix10.html#api-index-1.6">1.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-get-accept-focus"></a><h3>clutter_stage_get_accept_focus ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_stage_get_accept_focus (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<p>Retrieves the value set with <a class="link" href="ClutterStage.html#clutter-stage-set-accept-focus" title="clutter_stage_set_accept_focus ()"><code class="function">clutter_stage_set_accept_focus()</code></a>.</p>
<div class="refsect3">
<a name="clutter-stage-get-accept-focus.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-stage-get-accept-focus.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> should accept focus, and <code class="literal">FALSE</code>
otherwise</p>
</div>
<p class="since">Since: <a class="link" href="ix10.html#api-index-1.6">1.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-set-sync-delay"></a><h3>clutter_stage_set_sync_delay ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_set_sync_delay (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><span class="type">gint</span> sync_delay</code></em>);</pre>
<p>This function enables an alternate behavior where Clutter draws at
a fixed point in time after the frame presentation time (also known
as the VBlank time). This is most useful when the application
wants to show incoming data with predictable latency. (The primary
example of this would be a window system compositor.) By synchronizing
to provide new data before Clutter redraws, an external source of
updates (in the compositor, an application) can get a reliable latency.</p>
<p>The appropriate value of <em class="parameter"><code>sync_delay</code></em>
depends on the complexity of
drawing the stage's scene graph - in general a value of between 0
and 8 ms (up to one-half of a typical 60hz frame rate) is appropriate.
using a larger value will reduce latency but risks skipping a frame if
drawing the stage takes too long.</p>
<div class="refsect3">
<a name="clutter-stage-set-sync-delay.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sync_delay</p></td>
<td class="parameter_description"><p>number of milliseconds after frame presentation to wait
before painting the next frame. If less than zero, restores the
default behavior where redraw is throttled to the refresh rate but
not synchronized to it.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix14.html#api-index-1.14">1.14</a></p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-skip-sync-delay"></a><h3>clutter_stage_skip_sync_delay ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_skip_sync_delay (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<p>Causes the next frame for the stage to be drawn as quickly as
possible, ignoring any delay that <a class="link" href="ClutterStage.html#clutter-stage-set-sync-delay" title="clutter_stage_set_sync_delay ()"><code class="function">clutter_stage_set_sync_delay()</code></a>
would normally cause.</p>
<div class="refsect3">
<a name="clutter-stage-skip-sync-delay.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix14.html#api-index-1.14">1.14</a></p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-STAGE-WIDTH:CAPS"></a><h3>CLUTTER_STAGE_WIDTH</h3>
<pre class="programlisting">#define CLUTTER_STAGE_WIDTH() (clutter_actor_get_width (clutter_stage_get_default ()))
</pre>
<div class="warning">
<p><code class="literal">CLUTTER_STAGE_WIDTH</code> has been deprecated since version 1.2 and should not be used in newly-written code.</p>
<p>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>
</div>
<p>Macro that evaluates to the width of the default stage</p>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-STAGE-HEIGHT:CAPS"></a><h3>CLUTTER_STAGE_HEIGHT</h3>
<pre class="programlisting">#define CLUTTER_STAGE_HEIGHT() (clutter_actor_get_height (clutter_stage_get_default ()))
</pre>
<div class="warning">
<p><code class="literal">CLUTTER_STAGE_HEIGHT</code> has been deprecated since version 1.2 and should not be used in newly-written code.</p>
<p>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>
</div>
<p>Macro that evaluates to the height of the default stage</p>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-get-default"></a><h3>clutter_stage_get_default ()</h3>
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
clutter_stage_get_default (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_stage_get_default</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterStage.html#clutter-stage-new" title="clutter_stage_new ()"><code class="function">clutter_stage_new()</code></a> instead.</p>
</div>
<p>Retrieves a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> singleton.</p>
<p>This function is not as useful as it sounds, and will most likely
by deprecated in the future. Application code should only create
a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> instance using <a class="link" href="ClutterStage.html#clutter-stage-new" title="clutter_stage_new ()"><code class="function">clutter_stage_new()</code></a>, and manage the
lifetime of the stage manually.</p>
<p>The default stage singleton has a platform-specific behaviour: on
platforms without the <a class="link" href="clutter-Features.html#CLUTTER-FEATURE-STAGE-MULTIPLE:CAPS"><code class="literal">CLUTTER_FEATURE_STAGE_MULTIPLE</code></a> feature flag
set, the first <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> instance will also be set to be the
default stage instance, and this function will always return a
pointer to it.</p>
<p>On platforms with the <a class="link" href="clutter-Features.html#CLUTTER-FEATURE-STAGE-MULTIPLE:CAPS"><code class="literal">CLUTTER_FEATURE_STAGE_MULTIPLE</code></a> feature flag
set, the default stage will be created by the first call to this
function, and every following call will return the same pointer to
it.</p>
<div class="refsect3">
<a name="clutter-stage-get-default.returns"></a><h4>Returns</h4>
<p> the main
<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>. You should never destroy or unref the returned
actor. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Clutter.Stage]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-is-default"></a><h3>clutter_stage_is_default ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_stage_is_default (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_stage_is_default</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Track the stage pointer inside your application
code, or use <a class="link" href="ClutterActor.html#clutter-actor-get-stage" title="clutter_actor_get_stage ()"><code class="function">clutter_actor_get_stage()</code></a> to retrieve the stage for
a given actor.</p>
</div>
<p>Checks if <em class="parameter"><code>stage</code></em>
is the default stage, or an instance created using
<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>
<div class="refsect3">
<a name="clutter-stage-is-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-stage-is-default.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the passed stage is the default one</p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-set-color"></a><h3>clutter_stage_set_color ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_set_color (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_stage_set_color</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterActor.html#clutter-actor-set-background-color" title="clutter_actor_set_background_color ()"><code class="function">clutter_actor_set_background_color()</code></a> instead.</p>
</div>
<p>Sets the stage color.</p>
<div class="refsect3">
<a name="clutter-stage-set-color.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>A <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-get-color"></a><h3>clutter_stage_get_color ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_get_color (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_stage_get_color</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterActor.html#clutter-actor-get-background-color" title="clutter_actor_get_background_color ()"><code class="function">clutter_actor_get_background_color()</code></a> instead.</p>
</div>
<p>Retrieves the stage color.</p>
<div class="refsect3">
<a name="clutter-stage-get-color.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p> return location for a <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-queue-redraw"></a><h3>clutter_stage_queue_redraw ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_queue_redraw (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_stage_queue_redraw</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterActor.html#clutter-actor-queue-redraw" title="clutter_actor_queue_redraw ()"><code class="function">clutter_actor_queue_redraw()</code></a> instead.</p>
</div>
<p>Queues a redraw for the passed stage.</p>
<p>Applications should call <a class="link" href="ClutterActor.html#clutter-actor-queue-redraw" title="clutter_actor_queue_redraw ()"><code class="function">clutter_actor_queue_redraw()</code></a> and not
this function.</p>
<div class="refsect3">
<a name="clutter-stage-queue-redraw.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-set-use-fog"></a><h3>clutter_stage_set_use_fog ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_set_use_fog (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> fog</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_stage_set_use_fog</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Calling this function produces no visible effect</p>
</div>
<p>Sets whether the depth cueing effect on the stage should be enabled
or not.</p>
<p>Depth cueing is a 3D effect that makes actors farther away from the
viewing point less opaque, by fading them with the stage color.</p>
<p>The parameters of the GL fog used can be changed using the
<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>
<div class="refsect3">
<a name="clutter-stage-set-use-fog.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fog</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> for enabling the depth cueing effect</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-get-use-fog"></a><h3>clutter_stage_get_use_fog ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_stage_get_use_fog (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_stage_get_use_fog</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>This function will always return <code class="literal">FALSE</code></p>
</div>
<p>Gets whether the depth cueing effect is enabled on <em class="parameter"><code>stage</code></em>
.</p>
<div class="refsect3">
<a name="clutter-stage-get-use-fog.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-stage-get-use-fog.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the depth cueing effect is enabled</p>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-set-fog"></a><h3>clutter_stage_set_fog ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_set_fog (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><a class="link" href="ClutterStage.html#ClutterFog"><span class="type">ClutterFog</span></a> *fog</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_stage_set_fog</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Fog settings are ignored.</p>
</div>
<p>Sets the fog (also known as "depth cueing") settings for the <em class="parameter"><code>stage</code></em>
.</p>
<p>A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> will only use a linear fog progression, which
depends solely on the distance from the viewer. The <code class="function">cogl_set_fog()</code>
function in COGL exposes more of the underlying implementation,
and allows changing the for progression function. It can be directly
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
a signal handler to the <a class="link" href="ClutterActor.html#ClutterActor-paint" title="The “paint” signal"><span class="type">“paint”</span></a> signal on the <em class="parameter"><code>stage</code></em>
,
like:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="function"><a href="ClutterStage.html#clutter-stage-set-use-fog">clutter_stage_set_use_fog</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">stage</span><span class="symbol">,</span><span class="normal"> FALSE</span><span class="symbol">);</span>
<span class="function">g_signal_connect</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">stage</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"paint"</span><span class="symbol">,</span><span class="normal"> </span><span class="function">G_CALLBACK</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">on_stage_paint</span><span class="symbol">),</span><span class="normal"> NULL</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>The paint signal handler will call <code class="function">cogl_set_fog()</code> with the
desired settings:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="keyword">static</span><span class="normal"> </span><span class="type">void</span>
<span class="function">on_stage_paint</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">ClutterActor</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">actor</span><span class="symbol">)</span>
<span class="cbracket">{</span>
<span class="normal"> </span><span class="usertype">ClutterColor</span><span class="normal"> stage_color </span><span class="symbol">=</span><span class="normal"> </span><span class="cbracket">{</span><span class="normal"> </span><span class="number">0</span><span class="symbol">,</span><span class="normal"> </span><span class="cbracket">}</span><span class="symbol">;</span>
<span class="normal"> </span><span class="usertype">CoglColor</span><span class="normal"> fog_color </span><span class="symbol">=</span><span class="normal"> </span><span class="cbracket">{</span><span class="normal"> </span><span class="number">0</span><span class="symbol">,</span><span class="normal"> </span><span class="cbracket">}</span><span class="symbol">;</span>
<span class="normal"> </span><span class="comment">// set the fog color to the stage background color</span>
<span class="normal"> </span><span class="function"><a href="ClutterStage.html#clutter-stage-get-color">clutter_stage_get_color</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">CLUTTER_STAGE</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">actor</span><span class="symbol">),</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">stage_color</span><span class="symbol">);</span>
<span class="normal"> </span><span class="function">cogl_color_init_from_4ub</span><span class="normal"> </span><span class="symbol">(&</span><span class="normal">fog_color</span><span class="symbol">,</span>
<span class="normal"> stage_color</span><span class="symbol">.</span><span class="normal">red</span><span class="symbol">,</span>
<span class="normal"> stage_color</span><span class="symbol">.</span><span class="normal">green</span><span class="symbol">,</span>
<span class="normal"> stage_color</span><span class="symbol">.</span><span class="normal">blue</span><span class="symbol">,</span>
<span class="normal"> stage_color</span><span class="symbol">.</span><span class="normal">alpha</span><span class="symbol">);</span>
<span class="normal"> </span><span class="comment">// enable fog //</span>
<span class="normal"> </span><span class="function">cogl_set_fog</span><span class="normal"> </span><span class="symbol">(&</span><span class="normal">fog_color</span><span class="symbol">,</span>
<span class="normal"> COGL_FOG_MODE_EXPONENTIAL</span><span class="symbol">,</span><span class="normal"> </span><span class="comment">// mode</span>
<span class="normal"> </span><span class="number">0.5</span><span class="symbol">,</span><span class="normal"> </span><span class="comment">// density</span>
<span class="normal"> </span><span class="number">5.0</span><span class="symbol">,</span><span class="normal"> </span><span class="number">30.0</span><span class="symbol">);</span><span class="normal"> </span><span class="comment">// z_near and z_far</span>
<span class="cbracket">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>The fogging functions only work correctly when the visible actors use
unmultiplied alpha colors. By default Cogl will premultiply textures and
<code class="function">cogl_set_source_color()</code> will premultiply colors, so unless you explicitly
load your textures requesting an unmultiplied internal format and use
<code class="function">cogl_material_set_color()</code> you can only use fogging with fully opaque actors.
Support for premultiplied colors will improve in the future when we can
depend on fragment shaders.</p>
<div class="refsect3">
<a name="clutter-stage-set-fog.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fog</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html#ClutterFog"><span class="type">ClutterFog</span></a> structure</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-stage-get-fog"></a><h3>clutter_stage_get_fog ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_stage_get_fog (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><a class="link" href="ClutterStage.html#ClutterFog"><span class="type">ClutterFog</span></a> *fog</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_stage_get_fog</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>This function will always return the default
values of <a class="link" href="ClutterStage.html#ClutterFog"><span class="type">ClutterFog</span></a></p>
</div>
<p>Retrieves the current depth cueing settings from the stage.</p>
<div class="refsect3">
<a name="clutter-stage-get-fog.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fog</p></td>
<td class="parameter_description"><p> return location for a <a class="link" href="ClutterStage.html#ClutterFog"><span class="type">ClutterFog</span></a> structure. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterStage.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterStage-struct"></a><h3>ClutterStage</h3>
<pre class="programlisting">typedef struct _ClutterStage ClutterStage;</pre>
<p>The <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> structure contains only private data
and should be accessed using the provided API</p>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStageClass"></a><h3>struct ClutterStageClass</h3>
<pre class="programlisting">struct ClutterStageClass {
/* signals */
void (* fullscreen) (ClutterStage *stage);
void (* unfullscreen) (ClutterStage *stage);
void (* activate) (ClutterStage *stage);
void (* deactivate) (ClutterStage *stage);
gboolean (* delete_event) (ClutterStage *stage,
ClutterEvent *event);
};
</pre>
<p>The <a class="link" href="ClutterStage.html#ClutterStageClass" title="struct ClutterStageClass"><span class="type">ClutterStageClass</span></a> structure contains only private data</p>
<div class="refsect3">
<a name="ClutterStageClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterStageClass.fullscreen"></a>fullscreen</code></em> ()</p></td>
<td class="struct_member_description"><p>handler for the <a class="link" href="ClutterStage.html#ClutterStage-fullscreen" title="The “fullscreen” signal"><span class="type">“fullscreen”</span></a> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterStageClass.unfullscreen"></a>unfullscreen</code></em> ()</p></td>
<td class="struct_member_description"><p>handler for the <a class="link" href="ClutterStage.html#ClutterStage-unfullscreen" title="The “unfullscreen” signal"><span class="type">“unfullscreen”</span></a> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterStageClass.activate"></a>activate</code></em> ()</p></td>
<td class="struct_member_description"><p>handler for the <a class="link" href="ClutterStage.html#ClutterStage-activate" title="The “activate” signal"><span class="type">“activate”</span></a> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterStageClass.deactivate"></a>deactivate</code></em> ()</p></td>
<td class="struct_member_description"><p>handler for the <a class="link" href="ClutterStage.html#ClutterStage-deactivate" title="The “deactivate” signal"><span class="type">“deactivate”</span></a> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterStageClass.delete-event"></a>delete_event</code></em> ()</p></td>
<td class="struct_member_description"><p>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</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterPickMode"></a><h3>enum ClutterPickMode</h3>
<p>Controls the paint cycle of the scene graph when in pick mode</p>
<div class="refsect3">
<a name="ClutterPickMode.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-PICK-NONE:CAPS"></a>CLUTTER_PICK_NONE</p></td>
<td class="enum_member_description">
<p>Do not paint any actor</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-PICK-REACTIVE:CAPS"></a>CLUTTER_PICK_REACTIVE</p></td>
<td class="enum_member_description">
<p>Paint only the reactive actors</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-PICK-ALL:CAPS"></a>CLUTTER_PICK_ALL</p></td>
<td class="enum_member_description">
<p>Paint all actors</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterPerspective-struct"></a><h3>ClutterPerspective</h3>
<pre class="programlisting">typedef struct {
gfloat fovy;
gfloat aspect;
gfloat z_near;
gfloat z_far;
} ClutterPerspective;
</pre>
<p>Stage perspective definition. <a class="link" href="ClutterStage.html#ClutterPerspective"><span class="type">ClutterPerspective</span></a> is only used by
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>
<div class="refsect3">
<a name="ClutterPerspective.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">gfloat</span> <em class="structfield"><code><a name="ClutterPerspective-struct.fovy"></a>fovy</code></em>;</p></td>
<td class="struct_member_description"><p>the field of view angle, in degrees, in the y direction</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gfloat</span> <em class="structfield"><code><a name="ClutterPerspective-struct.aspect"></a>aspect</code></em>;</p></td>
<td class="struct_member_description"><p>the aspect ratio that determines the field of view in the x
direction. The aspect ratio is the ratio of x (width) to y (height)</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gfloat</span> <em class="structfield"><code><a name="ClutterPerspective-struct.z-near"></a>z_near</code></em>;</p></td>
<td class="struct_member_description"><p>the distance from the viewer to the near clipping
plane (always positive)</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gfloat</span> <em class="structfield"><code><a name="ClutterPerspective-struct.z-far"></a>z_far</code></em>;</p></td>
<td class="struct_member_description"><p>the distance from the viewer to the far clipping
plane (always positive)</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterFog-struct"></a><h3>ClutterFog</h3>
<pre class="programlisting">typedef struct {
gfloat z_near;
gfloat z_far;
} ClutterFog;
</pre>
<div class="warning">
<p><code class="literal">ClutterFog</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>The fog-related API in <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> has been
deprecated as well.</p>
</div>
<p>Fog settings used to create the depth cueing effect.</p>
<div class="refsect3">
<a name="ClutterFog.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">gfloat</span> <em class="structfield"><code><a name="ClutterFog-struct.z-near"></a>z_near</code></em>;</p></td>
<td class="struct_member_description"><p>starting distance from the viewer to the near clipping
plane (always positive)</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gfloat</span> <em class="structfield"><code><a name="ClutterFog-struct.z-far"></a>z_far</code></em>;</p></td>
<td class="struct_member_description"><p>final distance from the viewer to the far clipping
plane (always positive)</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterStage.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterStage--accept-focus"></a><h3>The <code class="literal">“accept-focus”</code> property</h3>
<pre class="programlisting"> “accept-focus” <span class="type">gboolean</span></pre>
<p>Whether the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> should accept key focus when shown.</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
<p class="since">Since: <a class="link" href="ix10.html#api-index-1.6">1.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStage--color"></a><h3>The <code class="literal">“color”</code> property</h3>
<pre class="programlisting"> “color” <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *</pre>
<p>The background color of the main stage.</p>
<div class="warning">
<p><code class="literal">ClutterStage:color</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Use the <a class="link" href="ClutterActor.html#ClutterActor--background-color" title="The “background-color” property"><span class="type">“background-color”</span></a> property of
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> instead.</p>
</div>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStage--cursor-visible"></a><h3>The <code class="literal">“cursor-visible”</code> property</h3>
<pre class="programlisting"> “cursor-visible” <span class="type">gboolean</span></pre>
<p>Whether the mouse pointer should be visible</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStage--fog"></a><h3>The <code class="literal">“fog”</code> property</h3>
<pre class="programlisting"> “fog” <a class="link" href="ClutterStage.html#ClutterFog"><span class="type">ClutterFog</span></a> *</pre>
<p>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>
is set to <code class="literal">TRUE</code></p>
<div class="warning">
<p><code class="literal">ClutterStage:fog</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>This property does not do anything.</p>
</div>
<p>Flags: Read / Write</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStage--fullscreen-set"></a><h3>The <code class="literal">“fullscreen-set”</code> property</h3>
<pre class="programlisting"> “fullscreen-set” <span class="type">gboolean</span></pre>
<p>Whether the main stage is fullscreen.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStage--key-focus"></a><h3>The <code class="literal">“key-focus”</code> property</h3>
<pre class="programlisting"> “key-focus” <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *</pre>
<p>The <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> that will receive key events from the underlying
windowing system.</p>
<p>If <code class="literal">NULL</code>, the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> will receive the events.</p>
<p>Flags: Read / Write</p>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStage--no-clear-hint"></a><h3>The <code class="literal">“no-clear-hint”</code> property</h3>
<pre class="programlisting"> “no-clear-hint” <span class="type">gboolean</span></pre>
<p>Whether or not the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> should clear its contents
before each paint cycle.</p>
<p>See <a class="link" href="ClutterStage.html#clutter-stage-set-no-clear-hint" title="clutter_stage_set_no_clear_hint ()"><code class="function">clutter_stage_set_no_clear_hint()</code></a> for further information.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStage--offscreen"></a><h3>The <code class="literal">“offscreen”</code> property</h3>
<pre class="programlisting"> “offscreen” <span class="type">gboolean</span></pre>
<p>Whether the stage should be rendered in an offscreen buffer.</p>
<div class="warning">
<p><code class="literal">ClutterStage:offscreen</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>This property does not do anything.</p>
</div>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStage--perspective"></a><h3>The <code class="literal">“perspective”</code> property</h3>
<pre class="programlisting"> “perspective” <a class="link" href="ClutterStage.html#ClutterPerspective"><span class="type">ClutterPerspective</span></a> *</pre>
<p>The parameters used for the perspective projection from 3D
coordinates to 2D</p>
<p>Flags: Read / Write</p>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStage--title"></a><h3>The <code class="literal">“title”</code> property</h3>
<pre class="programlisting"> “title” <span class="type">gchar</span> *</pre>
<p>The stage's title - usually displayed in stage windows title decorations.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStage--use-alpha"></a><h3>The <code class="literal">“use-alpha”</code> property</h3>
<pre class="programlisting"> “use-alpha” <span class="type">gboolean</span></pre>
<p>Whether the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> should honour the alpha component of the
<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
a compositing manager this will result in the stage being blended
with the underlying window(s)</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStage--use-fog"></a><h3>The <code class="literal">“use-fog”</code> property</h3>
<pre class="programlisting"> “use-fog” <span class="type">gboolean</span></pre>
<p>Whether the stage should use a linear GL "fog" in creating the
depth-cueing effect, to enhance the perception of depth by fading
actors farther from the viewpoint.</p>
<div class="warning">
<p><code class="literal">ClutterStage:use-fog</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>This property does not do anything.</p>
</div>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStage--user-resizable"></a><h3>The <code class="literal">“user-resizable”</code> property</h3>
<pre class="programlisting"> “user-resizable” <span class="type">gboolean</span></pre>
<p>Whether the stage is resizable via user interaction.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterStage.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="ClutterStage-activate"></a><h3>The <code class="literal">“activate”</code> signal</h3>
<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,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::activate signal is emitted when the stage receives key focus
from the underlying window system.</p>
<div class="refsect3">
<a name="ClutterStage-activate.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>the stage which was activated</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStage-after-paint"></a><h3>The <code class="literal">“after-paint”</code> signal</h3>
<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,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::after-paint signal is emitted after the stage is painted,
but before the results are displayed on the screen.</p>
<div class="refsect3">
<a name="ClutterStage-after-paint.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>the stage that received the event</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
<p class="since">Since: <a class="link" href="ix17.html#api-index-1.20">1.20</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStage-deactivate"></a><h3>The <code class="literal">“deactivate”</code> signal</h3>
<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,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::deactivate signal is emitted when the stage loses key focus
from the underlying window system.</p>
<div class="refsect3">
<a name="ClutterStage-deactivate.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>the stage which was deactivated</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStage-delete-event"></a><h3>The <code class="literal">“delete-event”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
user_function (<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage,
<a class="link" href="clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a> *event,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::delete-event signal is emitted when the user closes a
<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> window using the window controls.</p>
<p>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
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
stage.</p>
<p>It is possible to override the default behaviour by connecting
a new handler and returning <code class="literal">TRUE</code> there.</p>
<p>This signal is emitted only on Clutter backends that
embed <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> in native windows. It is not emitted for
backends that use a static frame buffer.</p>
<div class="refsect3">
<a name="ClutterStage-delete-event.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>the stage that received the event</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>event</p></td>
<td class="parameter_description"><p>a <a class="link" href="clutter-Events.html#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></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStage-fullscreen"></a><h3>The <code class="literal">“fullscreen”</code> signal</h3>
<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,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::fullscreen signal is emitted when the stage is made fullscreen.</p>
<div class="refsect3">
<a name="ClutterStage-fullscreen.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>the stage which was fullscreened</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterStage-unfullscreen"></a><h3>The <code class="literal">“unfullscreen”</code> signal</h3>
<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,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::unfullscreen signal is emitted when the stage leaves a fullscreen
state.</p>
<div class="refsect3">
<a name="ClutterStage-unfullscreen.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stage</p></td>
<td class="parameter_description"><p>the stage which has left a fullscreen state.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>