1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="ClutterTimeline">
<refmeta>
<refentrytitle id="top_of_page">ClutterTimeline</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CLUTTER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ClutterTimeline</refname>
<refpurpose>A base class for managing time based events such
as animations.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>
<synopsis>
typedef <link linkend="ClutterTimelinePrivate">ClutterTimelinePrivate</link>;
<link linkend="ClutterTimeline-struct">ClutterTimeline</link>;
<link linkend="ClutterTimeline">ClutterTimeline</link>* <link linkend="clutter-timeline-new">clutter_timeline_new</link> (<link linkend="guint">guint</link> nframes,
<link linkend="guint">guint</link> fps);
<link linkend="void">void</link> <link linkend="clutter-timeline-set-speed">clutter_timeline_set_speed</link> (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline,
<link linkend="guint">guint</link> fps);
<link linkend="void">void</link> <link linkend="clutter-timeline-start">clutter_timeline_start</link> (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline);
<link linkend="void">void</link> <link linkend="clutter-timeline-pause">clutter_timeline_pause</link> (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline);
<link linkend="void">void</link> <link linkend="clutter-timeline-stop">clutter_timeline_stop</link> (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline);
<link linkend="void">void</link> <link linkend="clutter-timeline-set-loop">clutter_timeline_set_loop</link> (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline,
<link linkend="gboolean">gboolean</link> loop);
<link linkend="void">void</link> <link linkend="clutter-timeline-rewind">clutter_timeline_rewind</link> (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline);
<link linkend="void">void</link> <link linkend="clutter-timeline-skip">clutter_timeline_skip</link> (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline,
<link linkend="guint">guint</link> nframes);
<link linkend="void">void</link> <link linkend="clutter-timeline-advance">clutter_timeline_advance</link> (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline,
<link linkend="guint">guint</link> frame_num);
<link linkend="gint">gint</link> <link linkend="clutter-timeline-get-current-frame">clutter_timeline_get_current_frame</link>
(<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline);
<link linkend="guint">guint</link> <link linkend="clutter-timeline-get-n-frames">clutter_timeline_get_n_frames</link> (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline);
<link linkend="gboolean">gboolean</link> <link linkend="clutter-timeline-is-playing">clutter_timeline_is_playing</link> (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline);
</synopsis>
</refsynopsisdiv>
<refsect1 id="object_hierarchy">
<title id="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----ClutterTimeline
</synopsis>
</refsect1>
<refsect1 id="properties">
<title id="properties.title">Properties</title>
<synopsis>
"<link linkend="ClutterTimeline--fps">fps</link>" <link linkend="gint">gint</link> : Read / Write / Construct
"<link linkend="ClutterTimeline--loop">loop</link>" <link linkend="gboolean">gboolean</link> : Read / Write / Construct
"<link linkend="ClutterTimeline--num-frames">num-frames</link>" <link linkend="gint">gint</link> : Read / Write / Construct Only
</synopsis>
</refsect1>
<refsect1 id="signal_proto">
<title id="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="ClutterTimeline-completed">completed</link>" <link linkend="void">void</link> user_function (<link linkend="ClutterTimeline">ClutterTimeline</link> *cluttertimeline,
<link linkend="gpointer">gpointer</link> user_data) : Run last
"<link linkend="ClutterTimeline-new-frame">new-frame</link>" <link linkend="void">void</link> user_function (<link linkend="ClutterTimeline">ClutterTimeline</link> *cluttertimeline,
<link linkend="gint">gint</link> arg1,
<link linkend="gpointer">gpointer</link> user_data) : Run last
</synopsis>
</refsect1>
<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>
<link linkend="ClutterTimeline"><type>ClutterTimeline</type></link> is a base class for managing time based events such
as animations.</para>
<para>
</para>
</refsect1>
<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="ClutterTimelinePrivate" role="typedef"/>ClutterTimelinePrivate</title>
<indexterm><primary>ClutterTimelinePrivate</primary></indexterm><programlisting>typedef struct ClutterTimelinePrivate ClutterTimelinePrivate;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="ClutterTimeline-struct" role="struct"/>ClutterTimeline</title>
<indexterm><primary>ClutterTimeline</primary></indexterm><programlisting>typedef struct _ClutterTimeline ClutterTimeline;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="clutter-timeline-new" role="function"/>clutter_timeline_new ()</title>
<indexterm><primary>clutter_timeline_new</primary></indexterm><programlisting><link linkend="ClutterTimeline">ClutterTimeline</link>* clutter_timeline_new (<link linkend="guint">guint</link> nframes,
<link linkend="guint">guint</link> fps);</programlisting>
<para>
Create a new <link linkend="ClutterTimeline"><type>ClutterTimeline</type></link> instance.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>nframes</parameter> :</term>
<listitem><simpara> <link linkend="ClutterTimeline"><type>ClutterTimeline</type></link> number of frames
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fps</parameter> :</term>
<listitem><simpara> <link linkend="ClutterTimeline"><type>ClutterTimeline</type></link> frames per second
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="ClutterTimeline"><type>ClutterTimeline</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-timeline-set-speed" role="function"/>clutter_timeline_set_speed ()</title>
<indexterm><primary>clutter_timeline_set_speed</primary></indexterm><programlisting><link linkend="void">void</link> clutter_timeline_set_speed (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline,
<link linkend="guint">guint</link> fps);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>timeline</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fps</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-timeline-start" role="function"/>clutter_timeline_start ()</title>
<indexterm><primary>clutter_timeline_start</primary></indexterm><programlisting><link linkend="void">void</link> clutter_timeline_start (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline);</programlisting>
<para>
Starts the <link linkend="ClutterTimeline"><type>ClutterTimeline</type></link> playing.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>timeline</parameter> :</term>
<listitem><simpara> A <link linkend="ClutterTimeline"><type>ClutterTimeline</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-timeline-pause" role="function"/>clutter_timeline_pause ()</title>
<indexterm><primary>clutter_timeline_pause</primary></indexterm><programlisting><link linkend="void">void</link> clutter_timeline_pause (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline);</programlisting>
<para>
Pauses the <link linkend="ClutterTimeline"><type>ClutterTimeline</type></link> on current frame</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>timeline</parameter> :</term>
<listitem><simpara> A <link linkend="ClutterTimeline"><type>ClutterTimeline</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-timeline-stop" role="function"/>clutter_timeline_stop ()</title>
<indexterm><primary>clutter_timeline_stop</primary></indexterm><programlisting><link linkend="void">void</link> clutter_timeline_stop (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline);</programlisting>
<para>
Stops the <link linkend="ClutterTimeline"><type>ClutterTimeline</type></link> and moves to frame 0</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>timeline</parameter> :</term>
<listitem><simpara> A <link linkend="ClutterTimeline"><type>ClutterTimeline</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-timeline-set-loop" role="function"/>clutter_timeline_set_loop ()</title>
<indexterm><primary>clutter_timeline_set_loop</primary></indexterm><programlisting><link linkend="void">void</link> clutter_timeline_set_loop (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline,
<link linkend="gboolean">gboolean</link> loop);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>timeline</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>loop</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-timeline-rewind" role="function"/>clutter_timeline_rewind ()</title>
<indexterm><primary>clutter_timeline_rewind</primary></indexterm><programlisting><link linkend="void">void</link> clutter_timeline_rewind (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline);</programlisting>
<para>
Rewinds <link linkend="ClutterTimeline"><type>ClutterTimeline</type></link> to frame 0.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>timeline</parameter> :</term>
<listitem><simpara> A <link linkend="ClutterTimeline"><type>ClutterTimeline</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-timeline-skip" role="function"/>clutter_timeline_skip ()</title>
<indexterm><primary>clutter_timeline_skip</primary></indexterm><programlisting><link linkend="void">void</link> clutter_timeline_skip (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline,
<link linkend="guint">guint</link> nframes);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>timeline</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>nframes</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-timeline-advance" role="function"/>clutter_timeline_advance ()</title>
<indexterm><primary>clutter_timeline_advance</primary></indexterm><programlisting><link linkend="void">void</link> clutter_timeline_advance (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline,
<link linkend="guint">guint</link> frame_num);</programlisting>
<para>
Advance timeline to requested frame number</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>timeline</parameter> :</term>
<listitem><simpara> A <link linkend="ClutterTimeline"><type>ClutterTimeline</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>frame_num</parameter> :</term>
<listitem><simpara> Frame number to advance to
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-timeline-get-current-frame" role="function"/>clutter_timeline_get_current_frame ()</title>
<indexterm><primary>clutter_timeline_get_current_frame</primary></indexterm><programlisting><link linkend="gint">gint</link> clutter_timeline_get_current_frame
(<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline);</programlisting>
<para>
Set the speed in frames per second of the timeline.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>timeline</parameter> :</term>
<listitem><simpara> A <link linkend="ClutterTimeline"><type>ClutterTimeline</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-timeline-get-n-frames" role="function"/>clutter_timeline_get_n_frames ()</title>
<indexterm><primary>clutter_timeline_get_n_frames</primary></indexterm><programlisting><link linkend="guint">guint</link> clutter_timeline_get_n_frames (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline);</programlisting>
<para>
Request the totle number of frames for the <link linkend="ClutterTimeline"><type>ClutterTimeline</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>timeline</parameter> :</term>
<listitem><simpara> A <link linkend="ClutterTimeline"><type>ClutterTimeline</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Number of frames for this <link linkend="ClutterTimeline"><type>ClutterTimeline</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-timeline-is-playing" role="function"/>clutter_timeline_is_playing ()</title>
<indexterm><primary>clutter_timeline_is_playing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> clutter_timeline_is_playing (<link linkend="ClutterTimeline">ClutterTimeline</link> *timeline);</programlisting>
<para>
Query state of a <link linkend="ClutterTimeline"><type>ClutterTimeline</type></link> instance.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>timeline</parameter> :</term>
<listitem><simpara> A <link linkend="ClutterTimeline"><type>ClutterTimeline</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if timeline is currently playing, FALSE if not.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="property_details">
<title id="property_details.title">Property Details</title>
<refsect2><title><anchor id="ClutterTimeline--fps"/>The "<literal>fps</literal>" property</title>
<indexterm><primary>ClutterTimeline:fps</primary></indexterm><programlisting> "fps" <link linkend="gint">gint</link> : Read / Write / Construct</programlisting>
<para>Timeline frames per second.</para><para>Allowed values: [0,1000]</para>
<para>Default value: 50</para>
</refsect2>
<refsect2><title><anchor id="ClutterTimeline--loop"/>The "<literal>loop</literal>" property</title>
<indexterm><primary>ClutterTimeline:loop</primary></indexterm><programlisting> "loop" <link linkend="gboolean">gboolean</link> : Read / Write / Construct</programlisting>
<para>Should the timeline automatically restart.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2><title><anchor id="ClutterTimeline--num-frames"/>The "<literal>num-frames</literal>" property</title>
<indexterm><primary>ClutterTimeline:num-frames</primary></indexterm><programlisting> "num-frames" <link linkend="gint">gint</link> : Read / Write / Construct Only</programlisting>
<para>Timelines total number of frames.</para><para>Allowed values: >= 0</para>
<para>Default value: 0</para>
</refsect2>
</refsect1>
<refsect1 id="signals">
<title id="signals.title">Signal Details</title>
<refsect2><title><anchor id="ClutterTimeline-completed"/>The "completed" signal</title>
<indexterm><primary>ClutterTimeline::completed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="ClutterTimeline">ClutterTimeline</link> *cluttertimeline,
<link linkend="gpointer">gpointer</link> user_data) : Run last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>cluttertimeline</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="ClutterTimeline-new-frame"/>The "new-frame" signal</title>
<indexterm><primary>ClutterTimeline::new-frame</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="ClutterTimeline">ClutterTimeline</link> *cluttertimeline,
<link linkend="gint">gint</link> arg1,
<link linkend="gpointer">gpointer</link> user_data) : Run last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>cluttertimeline</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
