1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>Win32 Specific Support</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="Clutter Reference Manual">
8 <link rel="up" href="clutterbackends.html" title="Part VII. Clutter Backends">
9 <link rel="prev" href="clutter-ClutterGLXTexturePixmap.html" title="ClutterGLXTexturePixmap">
10 <link rel="next" href="clutter-EGL-Specific-Support.html" title="EGL Specific Support">
11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="clutter-ClutterGLXTexturePixmap.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="clutterbackends.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">Clutter Reference Manual</th>
21 <td><a accesskey="n" href="clutter-EGL-Specific-Support.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#clutter-Win32-Specific-Support.synopsis" class="shortcut">Top</a>
26 <a href="#clutter-Win32-Specific-Support.description" class="shortcut">Description</a>
29 <div class="refentry">
30 <a name="clutter-Win32-Specific-Support"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
33 <h2><span class="refentrytitle"><a name="clutter-Win32-Specific-Support.top_of_page"></a>Win32 Specific Support</span></h2>
34 <p>Win32 Specific Support — Win32 specific API</p>
36 <td valign="top" align="right"></td>
38 <div class="refsynopsisdiv">
39 <a name="clutter-Win32-Specific-Support.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis"><span class="returnvalue">void</span> <a class="link" href="clutter-Win32-Specific-Support.html#clutter-win32-disable-event-retrieval" title="clutter_win32_disable_event_retrieval ()">clutter_win32_disable_event_retrieval</a>
41 (<em class="parameter"><code><span class="type">void</span></code></em>);
42 <span class="returnvalue">gboolean</span> <a class="link" href="clutter-Win32-Specific-Support.html#clutter-win32-set-stage-foreign" title="clutter_win32_set_stage_foreign ()">clutter_win32_set_stage_foreign</a> (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
43 <em class="parameter"><code><span class="type">HWND</span> hwnd</code></em>);
44 <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> * <a class="link" href="clutter-Win32-Specific-Support.html#clutter-win32-get-stage-from-window" title="clutter_win32_get_stage_from_window ()">clutter_win32_get_stage_from_window</a> (<em class="parameter"><code><span class="type">HWND</span> hwnd</code></em>);
45 <span class="returnvalue">HWND</span> <a class="link" href="clutter-Win32-Specific-Support.html#clutter-win32-get-stage-window" title="clutter_win32_get_stage_window ()">clutter_win32_get_stage_window</a> (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);
46 <span class="returnvalue">gboolean</span> <a class="link" href="clutter-Win32-Specific-Support.html#clutter-win32-handle-event" title="clutter_win32_handle_event ()">clutter_win32_handle_event</a> (<em class="parameter"><code>const <span class="type">MSG</span> *msg</code></em>);
49 <div class="refsect1">
50 <a name="clutter-Win32-Specific-Support.description"></a><h2>Description</h2>
52 The Win32 backend for Clutter provides some specific API, allowing
53 integration with the Win32 API for embedding and manipulating the
57 The ClutterWin32 API is available since Clutter 0.8
60 <div class="refsect1">
61 <a name="clutter-Win32-Specific-Support.details"></a><h2>Details</h2>
62 <div class="refsect2">
63 <a name="clutter-win32-disable-event-retrieval"></a><h3>clutter_win32_disable_event_retrieval ()</h3>
64 <pre class="programlisting"><span class="returnvalue">void</span> clutter_win32_disable_event_retrieval
65 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
67 Disables retrieval of Windows messages in the main loop. Use to
68 create event-less canvas.
71 This function can only be called before calling <a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()"><code class="function">clutter_init()</code></a>.
73 <p class="since">Since 0.8</p>
76 <div class="refsect2">
77 <a name="clutter-win32-set-stage-foreign"></a><h3>clutter_win32_set_stage_foreign ()</h3>
78 <pre class="programlisting"><span class="returnvalue">gboolean</span> clutter_win32_set_stage_foreign (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
79 <em class="parameter"><code><span class="type">HWND</span> hwnd</code></em>);</pre>
81 Target the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> to use an existing external window handle.
83 <div class="variablelist"><table border="0">
84 <col align="left" valign="top">
87 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
88 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
92 <td><p><span class="term"><em class="parameter"><code>hwnd</code></em> :</span></p></td>
93 <td>an existing window handle</td>
96 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
98 <code class="literal">TRUE</code> if foreign window is valid</td>
102 <p class="since">Since 0.8</p>
105 <div class="refsect2">
106 <a name="clutter-win32-get-stage-from-window"></a><h3>clutter_win32_get_stage_from_window ()</h3>
107 <pre class="programlisting"><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> * clutter_win32_get_stage_from_window (<em class="parameter"><code><span class="type">HWND</span> hwnd</code></em>);</pre>
109 Gets the stage for a particular window.
111 <div class="variablelist"><table border="0">
112 <col align="left" valign="top">
115 <td><p><span class="term"><em class="parameter"><code>hwnd</code></em> :</span></p></td>
116 <td>a window handle</td>
119 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
120 <td>The stage or NULL if a stage does not exist for the
125 <p class="since">Since 0.8</p>
128 <div class="refsect2">
129 <a name="clutter-win32-get-stage-window"></a><h3>clutter_win32_get_stage_window ()</h3>
130 <pre class="programlisting"><span class="returnvalue">HWND</span> clutter_win32_get_stage_window (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
132 Gets the stage's window handle
134 <div class="variablelist"><table border="0">
135 <col align="left" valign="top">
138 <td><p><span class="term"><em class="parameter"><code>stage</code></em> :</span></p></td>
139 <td>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
143 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
144 <td>An HWND for the stage window.</td>
148 <p class="since">Since 0.8</p>
151 <div class="refsect2">
152 <a name="clutter-win32-handle-event"></a><h3>clutter_win32_handle_event ()</h3>
153 <pre class="programlisting"><span class="returnvalue">gboolean</span> clutter_win32_handle_event (<em class="parameter"><code>const <span class="type">MSG</span> *msg</code></em>);</pre>
155 This function processes a single Win32 message. It can be used to
156 hook into external windows message processing (for example, a GDK
160 If <a class="link" href="clutter-Win32-Specific-Support.html#clutter-win32-disable-event-retrieval" title="clutter_win32_disable_event_retrieval ()"><code class="function">clutter_win32_disable_event_retrieval()</code></a> has been called, you must
161 let this function process events to update Clutter's internal state.
163 <div class="variablelist"><table border="0">
164 <col align="left" valign="top">
167 <td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
168 <td>A pointer to a structure describing a Win32 message.</td>
171 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
173 <code class="literal">TRUE</code> if the message was handled entirely by Clutter
174 and no further processing (such as calling the default window
175 procedure) should take place. <code class="literal">FALSE</code> is returned if is the message
176 was not handled at all or if Clutter expects processing to take
181 <p class="since">Since 1.6</p>
187 Generated by GTK-Doc V1.18.1</div>