]> Pileus Git - ~andy/gtk/blob - gdk/gdkframeclock.h
GdkFrameTimings: add documentation
[~andy/gtk] / gdk / gdkframeclock.h
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, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 /*
21  * Modified by the GTK+ Team and others 1997-2010.  See the AUTHORS
22  * file for a list of people on the GTK+ Team.  See the ChangeLog
23  * files for a list of changes.  These files are distributed with
24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25  */
26
27 #if !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
28 #error "Only <gdk/gdk.h> can be included directly."
29 #endif
30
31 #ifndef __GDK_FRAME_CLOCK_H__
32 #define __GDK_FRAME_CLOCK_H__
33
34 #include <gdk/gdkframetimings.h>
35
36 G_BEGIN_DECLS
37
38 #define GDK_TYPE_FRAME_CLOCK            (gdk_frame_clock_get_type ())
39 #define GDK_FRAME_CLOCK(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDK_TYPE_FRAME_CLOCK, GdkFrameClock))
40 #define GDK_FRAME_CLOCK_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GDK_TYPE_FRAME_CLOCK, GdkFrameClockClass))
41 #define GDK_IS_FRAME_CLOCK(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_FRAME_CLOCK))
42 #define GDK_IS_FRAME_CLOCK_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GDK_TYPE_FRAME_CLOCK))
43 #define GDK_FRAME_CLOCK_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GDK_TYPE_FRAME_CLOCK, GdkFrameClockClass))
44
45 typedef struct _GdkFrameClock              GdkFrameClock;
46 typedef struct _GdkFrameClockPrivate       GdkFrameClockPrivate;
47 typedef struct _GdkFrameClockClass         GdkFrameClockClass;
48
49 typedef enum {
50   GDK_FRAME_CLOCK_PHASE_NONE          = 0,
51   GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS  = 1 << 0,
52   GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT  = 1 << 1,
53   GDK_FRAME_CLOCK_PHASE_UPDATE        = 1 << 2,
54   GDK_FRAME_CLOCK_PHASE_LAYOUT        = 1 << 3,
55   GDK_FRAME_CLOCK_PHASE_PAINT         = 1 << 4,
56   GDK_FRAME_CLOCK_PHASE_RESUME_EVENTS = 1 << 5,
57   GDK_FRAME_CLOCK_PHASE_AFTER_PAINT   = 1 << 6
58 } GdkFrameClockPhase;
59
60 GType    gdk_frame_clock_get_type             (void) G_GNUC_CONST;
61
62 guint64  gdk_frame_clock_get_frame_time            (GdkFrameClock *clock);
63
64 void               gdk_frame_clock_request_phase (GdkFrameClock      *clock,
65                                                   GdkFrameClockPhase  phase);
66
67 /* Frame history */
68 gint64           gdk_frame_clock_get_frame_counter (GdkFrameClock *clock);
69 gint64           gdk_frame_clock_get_history_start (GdkFrameClock *clock);
70 GdkFrameTimings *gdk_frame_clock_get_timings       (GdkFrameClock *clock,
71                                                     gint64         frame_counter);
72
73 GdkFrameTimings *gdk_frame_clock_get_current_timings (GdkFrameClock *clock);
74
75 void gdk_frame_clock_get_refresh_info (GdkFrameClock *clock,
76                                        gint64         base_time,
77                                        gint64        *refresh_interval_return,
78                                        gint64        *presentation_time_return);
79
80 G_END_DECLS
81
82 #endif /* __GDK_FRAME_CLOCK_H__ */