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