gdk_frame_clock_get_frame_time ()

gint64
gdk_frame_clock_get_frame_time (GdkFrameClock *frame_clock);

Gets the time that should currently be used for animations. Inside the processing of a frame, it’s the time used to compute the animation position of everything in a frame. Outside of a frame, it's the time of the conceptual “previous frame,” which may be either the actual previous frame time, or if that’s too old, an updated time.

Since: 3.8

gdk_frame_clock_request_phase ()

void
gdk_frame_clock_request_phase (GdkFrameClock *frame_clock,
                               GdkFrameClockPhase phase);

Asks the frame clock to run a particular phase. The signal corresponding the requested phase will be emitted the next time the frame clock processes. Multiple calls to gdk_frame_clock_request_phase() will be combined together and only one frame processed. If you are displaying animated content and want to continually request the GDK_FRAME_CLOCK_PHASE_UPDATE phase for a period of time, you should use gdk_frame_clock_begin_updating() instead, since this allows GTK+ to adjust system parameters to get maximally smooth animations.

Since: 3.8

gdk_frame_clock_begin_updating ()

void
gdk_frame_clock_begin_updating (GdkFrameClock *frame_clock);

Starts updates for an animation. Until a matching call to gdk_frame_clock_end_updating() is made, the frame clock will continually request a new frame with the GDK_FRAME_CLOCK_PHASE_UPDATE phase. This function may be called multiple times and frames will be requested until gdk_frame_clock_end_updating() is called the same number of times.

Since: 3.8

gdk_frame_clock_end_updating ()

void
gdk_frame_clock_end_updating (GdkFrameClock *frame_clock);

Stops updates for an animation. See the documentation for gdk_frame_clock_begin_updating().

Since: 3.8

gdk_frame_clock_get_frame_counter ()

gint64
gdk_frame_clock_get_frame_counter (GdkFrameClock *frame_clock);

A GdkFrameClock maintains a 64-bit counter that increments for each frame drawn.

Since: 3.8

gdk_frame_clock_get_history_start ()

gint64
gdk_frame_clock_get_history_start (GdkFrameClock *frame_clock);

GdkFrameClock internally keeps a history of GdkFrameTimings objects for recent frames that can be retrieved with gdk_frame_clock_get_timings(). The set of stored frames is the set from the counter values given by gdk_frame_clock_get_history_start() and gdk_frame_clock_get_frame_counter(), inclusive.

Since: 3.8

gdk_frame_clock_get_timings ()

GdkFrameTimings *
gdk_frame_clock_get_timings (GdkFrameClock *frame_clock,
                             gint64 frame_counter);

Retrieves a GdkFrameTimings object holding timing information for the current frame or a recent frame. The GdkFrameTimings object may not yet be complete: see gdk_frame_timings_get_complete().

Since: 3.8

gdk_frame_clock_get_current_timings ()

GdkFrameTimings *
gdk_frame_clock_get_current_timings (GdkFrameClock *frame_clock);

Gets the frame timings for the current frame.

Since: 3.8

gdk_frame_clock_get_refresh_info ()

void
gdk_frame_clock_get_refresh_info (GdkFrameClock *frame_clock,
                                  gint64 base_time,
                                  gint64 *refresh_interval_return,
                                  gint64 *presentation_time_return);

Using the frame history stored in the frame clock, finds the last known presentation time and refresh interval, and assuming that presentation times are separated by the refresh interval, predicts a presentation time that is a multiple of the refresh interval after the last presentation time, and later than base_time .

Since: 3.8

GdkFrameClock

typedef struct _GdkFrameClock GdkFrameClock;

enum GdkFrameClockPhase

GdkFrameClockPhase is used to represent the different paint clock phases that can be requested. The elements of the enumeration correspond to the signals of GdkFrameClock.

Since: 3.8

The “after-paint” signal

void
user_function (GdkFrameClock *clock,
               gpointer       user_data)

This signal ends processing of the frame. Applications should generally not handle this signal.

Flags: Run Last

The “before-paint” signal

void
user_function (GdkFrameClock *clock,
               gpointer       user_data)

This signal begins processing of the frame. Applications should generally not handle this signal.

Flags: Run Last

The “flush-events” signal

void
user_function (GdkFrameClock *clock,
               gpointer       user_data)

This signal is used to flush pending motion events that are being batched up and compressed together. Applications should not handle this signal.

Flags: Run Last

The “layout” signal

void
user_function (GdkFrameClock *clock,
               gpointer       user_data)

This signal is emitted as the second step of toolkit and application processing of the frame. Any work to update sizes and positions of application elements should be performed. GTK+ normally handles this internally.

Flags: Run Last

The “paint” signal

void
user_function (GdkFrameClock *clock,
               gpointer       user_data)

This signal is emitted as the third step of toolkit and application processing of the frame. The frame is repainted. GDK normally handles this internally and produces expose events, which are turned into GTK+ “draw” signals.

Flags: Run Last

The “resume-events” signal

void
user_function (GdkFrameClock *clock,
               gpointer       user_data)

This signal is emitted after processing of the frame is finished, and is handled internally by GTK+ to resume normal event processing. Applications should not handle this signal.

Flags: Run Last

The “update” signal

void
user_function (GdkFrameClock *clock,
               gpointer       user_data)

This signal is emitted as the first step of toolkit and application processing of the frame. Animations should be updated using gdk_frame_clock_get_frame_time(). Applications can connect directly to this signal, or use gtk_widget_add_tick_callback() as a more convenient interface.

Flags: Run Last