x11: Split function into two

[~andy/gtk] / gdk / gdkframeclock.h

diff --git a/gdk/gdkframeclock.h b/gdk/gdkframeclock.h
index ba6a59f40a7abaf9a5fc043fe37a7da76f86c5c2..32688cdef6cc30872628d48862891f70e60e60d5 100644 (file)
--- a/gdk/gdkframeclock.h
+++ b/gdk/gdkframeclock.h
@@ -31,18 +31,38 @@
 #ifndef __GDK_FRAME_CLOCK_H__
 #define __GDK_FRAME_CLOCK_H__
 
-#include <gdk/gdkframehistory.h>
+#include <gdk/gdkframetimings.h>
 
 G_BEGIN_DECLS
 
-typedef struct _GdkFrameClock                GdkFrameClock;
-typedef struct _GdkFrameClockInterface       GdkFrameClockInterface;
-
-#define GDK_TYPE_FRAME_CLOCK             (gdk_frame_clock_get_type ())
-#define GDK_FRAME_CLOCK(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDK_TYPE_FRAME_CLOCK, GdkFrameClock))
-#define GDK_IS_FRAME_CLOCK(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_FRAME_CLOCK))
-#define GDK_FRAME_CLOCK_GET_IFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GDK_TYPE_FRAME_CLOCK, GdkFrameClockInterface))
-
+#define GDK_TYPE_FRAME_CLOCK            (gdk_frame_clock_get_type ())
+#define GDK_FRAME_CLOCK(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDK_TYPE_FRAME_CLOCK, GdkFrameClock))
+#define GDK_FRAME_CLOCK_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GDK_TYPE_FRAME_CLOCK, GdkFrameClockClass))
+#define GDK_IS_FRAME_CLOCK(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_FRAME_CLOCK))
+#define GDK_IS_FRAME_CLOCK_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GDK_TYPE_FRAME_CLOCK))
+#define GDK_FRAME_CLOCK_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GDK_TYPE_FRAME_CLOCK, GdkFrameClockClass))
+
+typedef struct _GdkFrameClock              GdkFrameClock;
+typedef struct _GdkFrameClockPrivate       GdkFrameClockPrivate;
+typedef struct _GdkFrameClockClass         GdkFrameClockClass;
+
+/**
+ * GdkFrameClockPhase:
+ * @GDK_FRAME_CLOCK_PHASE_NONE: no phase
+ * @GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS: corresponds to GdkFrameClock::flush-events. Should not be handled by applications.
+ * @GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT: corresponds to GdkFrameClock::before-paint. Should not be handled by applications.
+ * @GDK_FRAME_CLOCK_PHASE_UPDATE: corresponds to GdkFrameClock::update.
+ * @GDK_FRAME_CLOCK_PHASE_LAYOUT: corresponds to GdkFrameClock::layout.
+ * @GDK_FRAME_CLOCK_PHASE_PAINT: corresponds to GdkFrameClock::paint.
+ * @GDK_FRAME_CLOCK_PHASE_RESUME_EVENTS: corresponds to GdkFrameClock::resume-events. Should not be handled by applications.
+ * @GDK_FRAME_CLOCK_PHASE_AFTER_PAINT: corresponds to GdkFrameClock::after-paint. Should not be handled by applications.
+ *
+ * #GdkFrameClockPhase is used to represent the different paint clock
+ * phases that can be requested. The element of the enumeration
+ * correspond to the signals of #GdkPaintClock.
+ *
+ * Since: 3.8
+ **/
 typedef enum {
   GDK_FRAME_CLOCK_PHASE_NONE          = 0,
   GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS  = 1 << 0,
@@ -54,59 +74,38 @@ typedef enum {
   GDK_FRAME_CLOCK_PHASE_AFTER_PAINT   = 1 << 6
 } GdkFrameClockPhase;
 
-struct _GdkFrameClockInterface
-{
-  GTypeInterface                  base_iface;
-
-  guint64  (* get_frame_time)            (GdkFrameClock *clock);
-
-  void               (* request_phase) (GdkFrameClock      *clock,
-                                        GdkFrameClockPhase  phase);
-  GdkFrameClockPhase (* get_requested) (GdkFrameClock      *clock);
-
-  void     (* freeze)              (GdkFrameClock *clock);
-  void     (* thaw)                (GdkFrameClock *clock);
-
-  GdkFrameHistory *  (* get_history)   (GdkFrameClock *clock);
-
-  /* signals */
-  /* void (* frame_requested)    (GdkFrameClock *clock); */
-  /* void (* flush_events)       (GdkFrameClock *clock); */
-  /* void (* before_paint)       (GdkFrameClock *clock); */
-  /* void (* update)             (GdkFrameClock *clock); */
-  /* void (* layout)             (GdkFrameClock *clock); */
-  /* void (* paint)              (GdkFrameClock *clock); */
-  /* void (* after_paint)        (GdkFrameClock *clock); */
-  /* void (* resume_events)      (GdkFrameClock *clock); */
-};
-
 GType    gdk_frame_clock_get_type             (void) G_GNUC_CONST;
 
-guint64  gdk_frame_clock_get_frame_time            (GdkFrameClock *clock);
+GDK_AVAILABLE_IN_3_8
+gint64   gdk_frame_clock_get_frame_time            (GdkFrameClock *frame_clock);
 
-void               gdk_frame_clock_request_phase (GdkFrameClock      *clock,
+GDK_AVAILABLE_IN_3_8
+void               gdk_frame_clock_request_phase (GdkFrameClock      *frame_clock,
                                                   GdkFrameClockPhase  phase);
-GdkFrameClockPhase gdk_frame_clock_get_requested (GdkFrameClock      *clock);
-
-void     gdk_frame_clock_freeze              (GdkFrameClock *clock);
-void     gdk_frame_clock_thaw                (GdkFrameClock *clock);
-
-GdkFrameHistory *gdk_frame_clock_get_history (GdkFrameClock *clock);
 
-/* Convenience API */
-void  gdk_frame_clock_get_frame_time_val (GdkFrameClock  *clock,
-                                          GTimeVal       *timeval);
-
-void gdk_frame_clock_get_refresh_info (GdkFrameClock *clock,
+GDK_AVAILABLE_IN_3_8
+void               gdk_frame_clock_begin_updating (GdkFrameClock      *frame_clock);
+GDK_AVAILABLE_IN_3_8
+void               gdk_frame_clock_end_updating   (GdkFrameClock      *frame_clock);
+
+/* Frame history */
+GDK_AVAILABLE_IN_3_8
+gint64           gdk_frame_clock_get_frame_counter (GdkFrameClock *frame_clock);
+GDK_AVAILABLE_IN_3_8
+gint64           gdk_frame_clock_get_history_start (GdkFrameClock *frame_clock);
+GDK_AVAILABLE_IN_3_8
+GdkFrameTimings *gdk_frame_clock_get_timings       (GdkFrameClock *frame_clock,
+                                                    gint64         frame_counter);
+
+GDK_AVAILABLE_IN_3_8
+GdkFrameTimings *gdk_frame_clock_get_current_timings (GdkFrameClock *frame_clock);
+
+GDK_AVAILABLE_IN_3_8
+void gdk_frame_clock_get_refresh_info (GdkFrameClock *frame_clock,
                                        gint64         base_time,
                                        gint64        *refresh_interval_return,
                                        gint64        *presentation_time_return);
 
-GdkFrameTimings *gdk_frame_clock_get_current_frame_timings (GdkFrameClock *clock);
-
-/* Signal emitters (used in frame clock implementations) */
-void     gdk_frame_clock_frame_requested     (GdkFrameClock *clock);
-
 G_END_DECLS
 
 #endif /* __GDK_FRAME_CLOCK_H__ */