1/* GDK - The GIMP Drawing Kit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
16 */
17
18/*
19 * Modified by the GTK+ Team and others 1997-2010. See the AUTHORS
20 * file for a list of people on the GTK+ Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
23 */
24
25#ifndef __GDK_FRAME_CLOCK_H__
26#define __GDK_FRAME_CLOCK_H__
27
28#if !defined (__GDK_H_INSIDE__) && !defined (GTK_COMPILATION)
29#error "Only <gdk/gdk.h> can be included directly."
30#endif
31
32#include <gdk/gdkframetimings.h>
33
34G_BEGIN_DECLS
35
36#define GDK_TYPE_FRAME_CLOCK (gdk_frame_clock_get_type ())
37#define GDK_FRAME_CLOCK(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDK_TYPE_FRAME_CLOCK, GdkFrameClock))
38#define GDK_FRAME_CLOCK_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GDK_TYPE_FRAME_CLOCK, GdkFrameClockClass))
39#define GDK_IS_FRAME_CLOCK(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_FRAME_CLOCK))
40#define GDK_IS_FRAME_CLOCK_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GDK_TYPE_FRAME_CLOCK))
41#define GDK_FRAME_CLOCK_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GDK_TYPE_FRAME_CLOCK, GdkFrameClockClass))
42
43typedef struct _GdkFrameClock GdkFrameClock;
44typedef struct _GdkFrameClockPrivate GdkFrameClockPrivate;
45typedef struct _GdkFrameClockClass GdkFrameClockClass;
46
47/**
48 * GdkFrameClockPhase:
49 * @GDK_FRAME_CLOCK_PHASE_NONE: no phase
50 * @GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS: corresponds to GdkFrameClock::flush-events. Should not be handled by applications.
51 * @GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT: corresponds to GdkFrameClock::before-paint. Should not be handled by applications.
52 * @GDK_FRAME_CLOCK_PHASE_UPDATE: corresponds to GdkFrameClock::update.
53 * @GDK_FRAME_CLOCK_PHASE_LAYOUT: corresponds to GdkFrameClock::layout. Should not be handled by applicatiosn.
54 * @GDK_FRAME_CLOCK_PHASE_PAINT: corresponds to GdkFrameClock::paint.
55 * @GDK_FRAME_CLOCK_PHASE_RESUME_EVENTS: corresponds to GdkFrameClock::resume-events. Should not be handled by applications.
56 * @GDK_FRAME_CLOCK_PHASE_AFTER_PAINT: corresponds to GdkFrameClock::after-paint. Should not be handled by applications.
57 *
58 * Used to represent the different paint clock phases that can be requested.
59 *
60 * The elements of the enumeration correspond to the signals of `GdkFrameClock`.
61 */
62typedef enum {
63 GDK_FRAME_CLOCK_PHASE_NONE = 0,
64 GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS = 1 << 0,
65 GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT = 1 << 1,
66 GDK_FRAME_CLOCK_PHASE_UPDATE = 1 << 2,
67 GDK_FRAME_CLOCK_PHASE_LAYOUT = 1 << 3,
68 GDK_FRAME_CLOCK_PHASE_PAINT = 1 << 4,
69 GDK_FRAME_CLOCK_PHASE_RESUME_EVENTS = 1 << 5,
70 GDK_FRAME_CLOCK_PHASE_AFTER_PAINT = 1 << 6
71} GdkFrameClockPhase;
72
73GDK_AVAILABLE_IN_ALL
74GType gdk_frame_clock_get_type (void) G_GNUC_CONST;
75
76GDK_AVAILABLE_IN_ALL
77gint64 gdk_frame_clock_get_frame_time (GdkFrameClock *frame_clock);
78
79GDK_AVAILABLE_IN_ALL
80void gdk_frame_clock_request_phase (GdkFrameClock *frame_clock,
81 GdkFrameClockPhase phase);
82
83GDK_AVAILABLE_IN_ALL
84void gdk_frame_clock_begin_updating (GdkFrameClock *frame_clock);
85GDK_AVAILABLE_IN_ALL
86void gdk_frame_clock_end_updating (GdkFrameClock *frame_clock);
87
88/* Frame history */
89GDK_AVAILABLE_IN_ALL
90gint64 gdk_frame_clock_get_frame_counter (GdkFrameClock *frame_clock);
91GDK_AVAILABLE_IN_ALL
92gint64 gdk_frame_clock_get_history_start (GdkFrameClock *frame_clock);
93GDK_AVAILABLE_IN_ALL
94GdkFrameTimings *gdk_frame_clock_get_timings (GdkFrameClock *frame_clock,
95 gint64 frame_counter);
96
97GDK_AVAILABLE_IN_ALL
98GdkFrameTimings *gdk_frame_clock_get_current_timings (GdkFrameClock *frame_clock);
99
100GDK_AVAILABLE_IN_ALL
101void gdk_frame_clock_get_refresh_info (GdkFrameClock *frame_clock,
102 gint64 base_time,
103 gint64 *refresh_interval_return,
104 gint64 *presentation_time_return);
105
106GDK_AVAILABLE_IN_ALL
107double gdk_frame_clock_get_fps (GdkFrameClock *frame_clock);
108
109G_END_DECLS
110
111#endif /* __GDK_FRAME_CLOCK_H__ */
112

source code of gtk/gdk/gdkframeclock.h