]> Pileus Git - ~andy/gtk/blob - gdk/gdkframeclock.h
GdkFrameClock: Make the phase explicit when requesting the frame
[~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 <glib-object.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_IS_FRAME_CLOCK(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_FRAME_CLOCK))
41 #define GDK_FRAME_CLOCK_GET_IFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GDK_TYPE_FRAME_CLOCK, GdkFrameClockInterface))
42
43 typedef struct _GdkFrameClock          GdkFrameClock;
44 typedef struct _GdkFrameClockInterface GdkFrameClockInterface;
45
46 typedef enum {
47   GDK_FRAME_CLOCK_PHASE_NONE         = 0,
48   GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT = 1 << 0,
49   GDK_FRAME_CLOCK_PHASE_LAYOUT       = 1 << 1,
50   GDK_FRAME_CLOCK_PHASE_PAINT        = 1 << 2,
51   GDK_FRAME_CLOCK_PHASE_AFTER_PAINT  = 1 << 3
52 } GdkFrameClockPhase;
53
54 struct _GdkFrameClockInterface
55 {
56   GTypeInterface                   base_iface;
57
58   guint64  (* get_frame_time)      (GdkFrameClock *clock);
59
60   void               (* request_phase) (GdkFrameClock      *clock,
61                                         GdkFrameClockPhase  phase);
62   GdkFrameClockPhase (* get_requested) (GdkFrameClock      *clock);
63
64   /* signals */
65   /* void (* frame_requested)    (GdkFrameClock *clock); */
66   /* void (* before_paint)       (GdkFrameClock *clock); */
67   /* void (* layout)             (GdkFrameClock *clock); */
68   /* void (* paint)              (GdkFrameClock *clock); */
69   /* void (* after_paint)        (GdkFrameClock *clock); */
70 };
71
72 GType    gdk_frame_clock_get_type             (void) G_GNUC_CONST;
73
74 guint64  gdk_frame_clock_get_frame_time      (GdkFrameClock *clock);
75
76 void               gdk_frame_clock_request_phase (GdkFrameClock      *clock,
77                                                   GdkFrameClockPhase  phase);
78 GdkFrameClockPhase gdk_frame_clock_get_requested (GdkFrameClock      *clock);
79
80 /* Convenience API */
81 void  gdk_frame_clock_get_frame_time_val (GdkFrameClock  *clock,
82                                           GTimeVal       *timeval);
83
84 /* Signal emitters (used in frame clock implementations) */
85 void     gdk_frame_clock_frame_requested     (GdkFrameClock *clock);
86
87 G_END_DECLS
88
89 #endif /* __GDK_FRAME_CLOCK_H__ */