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/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 /**
  50  * GdkFrameClockPhase:
  51  * @GDK_FRAME_CLOCK_PHASE_NONE: no phase
  52  * @GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS: corresponds to GdkFrameClock::flush-events. Should not be handled by applications.
  53  * @GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT: corresponds to GdkFrameClock::before-paint. Should not be handled by applications.
  54  * @GDK_FRAME_CLOCK_PHASE_UPDATE: corresponds to GdkFrameClock::update.
  55  * @GDK_FRAME_CLOCK_PHASE_LAYOUT: corresponds to GdkFrameClock::layout.
  56  * @GDK_FRAME_CLOCK_PHASE_PAINT: corresponds to GdkFrameClock::paint.
  57  * @GDK_FRAME_CLOCK_PHASE_RESUME_EVENTS: corresponds to GdkFrameClock::resume-events. Should not be handled by applications.
  58  * @GDK_FRAME_CLOCK_PHASE_AFTER_PAINT: corresponds to GdkFrameClock::after-paint. Should not be handled by applications.
  59  *
  60  * #GdkFrameClockPhase is used to represent the different paint clock
  61  * phases that can be requested. The elements of the enumeration
  62  * correspond to the signals of #GdkPaintClock.
  63  *
  64  * Since: 3.8
  65  **/
  66 typedef enum {
  67   GDK_FRAME_CLOCK_PHASE_NONE          = 0,
  68   GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS  = 1 << 0,
  69   GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT  = 1 << 1,
  70   GDK_FRAME_CLOCK_PHASE_UPDATE        = 1 << 2,
  71   GDK_FRAME_CLOCK_PHASE_LAYOUT        = 1 << 3,
  72   GDK_FRAME_CLOCK_PHASE_PAINT         = 1 << 4,
  73   GDK_FRAME_CLOCK_PHASE_RESUME_EVENTS = 1 << 5,
  74   GDK_FRAME_CLOCK_PHASE_AFTER_PAINT   = 1 << 6
  75 } GdkFrameClockPhase;
  76
  77 GType    gdk_frame_clock_get_type             (void) G_GNUC_CONST;
  78
  79 GDK_AVAILABLE_IN_3_8
  80 gint64   gdk_frame_clock_get_frame_time            (GdkFrameClock *frame_clock);
  81
  82 GDK_AVAILABLE_IN_3_8
  83 void               gdk_frame_clock_request_phase (GdkFrameClock      *frame_clock,
  84                                                   GdkFrameClockPhase  phase);
  85
  86 GDK_AVAILABLE_IN_3_8
  87 void               gdk_frame_clock_begin_updating (GdkFrameClock      *frame_clock);
  88 GDK_AVAILABLE_IN_3_8
  89 void               gdk_frame_clock_end_updating   (GdkFrameClock      *frame_clock);
  90
  91 /* Frame history */
  92 GDK_AVAILABLE_IN_3_8
  93 gint64           gdk_frame_clock_get_frame_counter (GdkFrameClock *frame_clock);
  94 GDK_AVAILABLE_IN_3_8
  95 gint64           gdk_frame_clock_get_history_start (GdkFrameClock *frame_clock);
  96 GDK_AVAILABLE_IN_3_8
  97 GdkFrameTimings *gdk_frame_clock_get_timings       (GdkFrameClock *frame_clock,
  98                                                     gint64         frame_counter);
  99
 100 GDK_AVAILABLE_IN_3_8
 101 GdkFrameTimings *gdk_frame_clock_get_current_timings (GdkFrameClock *frame_clock);
 102
 103 GDK_AVAILABLE_IN_3_8
 104 void gdk_frame_clock_get_refresh_info (GdkFrameClock *frame_clock,
 105                                        gint64         base_time,
 106                                        gint64        *refresh_interval_return,
 107                                        gint64        *presentation_time_return);
 108
 109 G_END_DECLS
 110
 111 #endif /* __GDK_FRAME_CLOCK_H__ */