Pileus Git - ~andy/gtk/blob - 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/gdkframehistory.h>
  35
  36 G_BEGIN_DECLS
  37
  38 typedef struct _GdkFrameClock                GdkFrameClock;
  39 typedef struct _GdkFrameClockInterface       GdkFrameClockInterface;
  40
  41 #define GDK_TYPE_FRAME_CLOCK             (gdk_frame_clock_get_type ())
  42 #define GDK_FRAME_CLOCK(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDK_TYPE_FRAME_CLOCK, GdkFrameClock))
  43 #define GDK_IS_FRAME_CLOCK(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_FRAME_CLOCK))
  44 #define GDK_FRAME_CLOCK_GET_IFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GDK_TYPE_FRAME_CLOCK, GdkFrameClockInterface))
  45
  46 typedef enum {
  47   GDK_FRAME_CLOCK_PHASE_NONE          = 0,
  48   GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS  = 1 << 0,
  49   GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT  = 1 << 1,
  50   GDK_FRAME_CLOCK_PHASE_UPDATE        = 1 << 2,
  51   GDK_FRAME_CLOCK_PHASE_LAYOUT        = 1 << 3,
  52   GDK_FRAME_CLOCK_PHASE_PAINT         = 1 << 4,
  53   GDK_FRAME_CLOCK_PHASE_RESUME_EVENTS = 1 << 5,
  54   GDK_FRAME_CLOCK_PHASE_AFTER_PAINT   = 1 << 6
  55 } GdkFrameClockPhase;
  56
  57 struct _GdkFrameClockInterface
  58 {
  59   GTypeInterface                   base_iface;
  60
  61   guint64  (* get_frame_time)            (GdkFrameClock *clock);
  62
  63   void               (* request_phase) (GdkFrameClock      *clock,
  64                                         GdkFrameClockPhase  phase);
  65   GdkFrameClockPhase (* get_requested) (GdkFrameClock      *clock);
  66
  67   void     (* freeze)              (GdkFrameClock *clock);
  68   void     (* thaw)                (GdkFrameClock *clock);
  69
  70   GdkFrameHistory *  (* get_history)   (GdkFrameClock *clock);
  71
  72   /* signals */
  73   /* void (* frame_requested)    (GdkFrameClock *clock); */
  74   /* void (* flush_events)       (GdkFrameClock *clock); */
  75   /* void (* before_paint)       (GdkFrameClock *clock); */
  76   /* void (* update)             (GdkFrameClock *clock); */
  77   /* void (* layout)             (GdkFrameClock *clock); */
  78   /* void (* paint)              (GdkFrameClock *clock); */
  79   /* void (* after_paint)        (GdkFrameClock *clock); */
  80   /* void (* resume_events)      (GdkFrameClock *clock); */
  81 };
  82
  83 GType    gdk_frame_clock_get_type             (void) G_GNUC_CONST;
  84
  85 guint64  gdk_frame_clock_get_frame_time            (GdkFrameClock *clock);
  86
  87 void               gdk_frame_clock_request_phase (GdkFrameClock      *clock,
  88                                                   GdkFrameClockPhase  phase);
  89 GdkFrameClockPhase gdk_frame_clock_get_requested (GdkFrameClock      *clock);
  90
  91 void     gdk_frame_clock_freeze              (GdkFrameClock *clock);
  92 void     gdk_frame_clock_thaw                (GdkFrameClock *clock);
  93
  94 GdkFrameHistory *gdk_frame_clock_get_history (GdkFrameClock *clock);
  95
  96 /* Convenience API */
  97 void  gdk_frame_clock_get_frame_time_val (GdkFrameClock  *clock,
  98                                           GTimeVal       *timeval);
  99
 100 void gdk_frame_clock_get_refresh_info (GdkFrameClock *clock,
 101                                        gint64         base_time,
 102                                        gint64        *refresh_interval_return,
 103                                        gint64        *presentation_time_return);
 104
 105 GdkFrameTimings *gdk_frame_clock_get_current_frame_timings (GdkFrameClock *clock);
 106
 107 /* Signal emitters (used in frame clock implementations) */
 108 void     gdk_frame_clock_frame_requested     (GdkFrameClock *clock);
 109
 110 G_END_DECLS
 111
 112 #endif /* __GDK_FRAME_CLOCK_H__ */