67635e9177
Make GdkFrameClock and GdkFrameTimings show up in the docs. A couple of minor doc fixes are also included.
112 lines
4.9 KiB
C
112 lines
4.9 KiB
C
/* GDK - The GIMP Drawing Kit
|
|
* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the
|
|
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
* Boston, MA 02111-1307, USA.
|
|
*/
|
|
|
|
/*
|
|
* Modified by the GTK+ Team and others 1997-2010. See the AUTHORS
|
|
* file for a list of people on the GTK+ Team. See the ChangeLog
|
|
* files for a list of changes. These files are distributed with
|
|
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
|
|
*/
|
|
|
|
#if !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
|
|
#error "Only <gdk/gdk.h> can be included directly."
|
|
#endif
|
|
|
|
#ifndef __GDK_FRAME_CLOCK_H__
|
|
#define __GDK_FRAME_CLOCK_H__
|
|
|
|
#include <gdk/gdkframetimings.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#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 elements 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,
|
|
GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT = 1 << 1,
|
|
GDK_FRAME_CLOCK_PHASE_UPDATE = 1 << 2,
|
|
GDK_FRAME_CLOCK_PHASE_LAYOUT = 1 << 3,
|
|
GDK_FRAME_CLOCK_PHASE_PAINT = 1 << 4,
|
|
GDK_FRAME_CLOCK_PHASE_RESUME_EVENTS = 1 << 5,
|
|
GDK_FRAME_CLOCK_PHASE_AFTER_PAINT = 1 << 6
|
|
} GdkFrameClockPhase;
|
|
|
|
GType gdk_frame_clock_get_type (void) G_GNUC_CONST;
|
|
|
|
GDK_AVAILABLE_IN_3_8
|
|
gint64 gdk_frame_clock_get_frame_time (GdkFrameClock *frame_clock);
|
|
|
|
GDK_AVAILABLE_IN_3_8
|
|
void gdk_frame_clock_request_phase (GdkFrameClock *frame_clock,
|
|
GdkFrameClockPhase phase);
|
|
|
|
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);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __GDK_FRAME_CLOCK_H__ */
|