Bug 1387 - Clarify new-frame signal emission with advance()

When calling clutter_timeline_advance(), a timeline will not emit
the ::new-frame signal for the frame we are advancing to, as this
would break the invariants of the timeline behaviour.

The documentation should make this clear.
This commit is contained in:
Emmanuele Bassi 2009-01-27 11:18:09 +00:00
parent 43bd4e5d3f
commit 8608d103f8

View File

@ -1036,7 +1036,12 @@ clutter_timeline_skip (ClutterTimeline *timeline,
* @timeline: A #ClutterTimeline * @timeline: A #ClutterTimeline
* @frame_num: Frame number to advance to * @frame_num: Frame number to advance to
* *
* Advance timeline to the requested frame number * Advance timeline to the requested frame number.
*
* <note><para>The @timeline will not emit the #ClutterTimeline::new-frame
* signal for @frame_num. The first ::new-frame signal after the call to
* clutter_timeline_advance() will be emitted for a frame following
* @frame_num.</para></note>
*/ */
void void
clutter_timeline_advance (ClutterTimeline *timeline, clutter_timeline_advance (ClutterTimeline *timeline,