forked from AuroraMiddleware/gtk
Include GdkFrameClock in the docs
Make GdkFrameClock and GdkFrameTimings show up in the docs. A couple of minor doc fixes are also included.
This commit is contained in:
parent
d7184d6500
commit
67635e9177
@ -31,6 +31,8 @@
|
||||
<xi:include href="xml/visuals.xml" />
|
||||
<xi:include href="xml/cursors.xml" />
|
||||
<xi:include href="xml/windows.xml" />
|
||||
<xi:include href="xml/gdkframeclock.xml" />
|
||||
<xi:include href="xml/gdkframetimings.xml" />
|
||||
<xi:include href="xml/events.xml" />
|
||||
<xi:include href="xml/event_structs.xml" />
|
||||
<xi:include href="xml/keys.xml" />
|
||||
|
@ -404,6 +404,7 @@ gdk_window_process_updates
|
||||
gdk_window_set_debug_updates
|
||||
gdk_window_enable_synchronized_configure
|
||||
gdk_window_configure_finished
|
||||
gdk_window_get_frame_clock
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_window_set_user_data
|
||||
@ -1154,3 +1155,38 @@ gdk_test_render_sync
|
||||
gdk_test_simulate_button
|
||||
gdk_test_simulate_key
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>GdkFrameClock</TITLE>
|
||||
<FILE>gdkframeclock</FILE>
|
||||
GdkFrameClock
|
||||
gdk_frame_clock_get_frame_time
|
||||
GdkFrameClockPhase
|
||||
gdk_frame_clock_request_phase
|
||||
gdk_frame_clock_begin_updating
|
||||
gdk_frame_clock_end_updating
|
||||
gdk_frame_clock_get_frame_counter
|
||||
gdk_frame_clock_get_history_start
|
||||
gdk_frame_clock_get_timings
|
||||
gdk_frame_clock_get_current_timings
|
||||
gdk_frame_clock_get_refresh_info
|
||||
<SUBSECTION Private>
|
||||
GdkFrameClockPrivate
|
||||
gdk_frame_clock_get_type
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>GdkFrameTimings</TITLE>
|
||||
<FILE>gdkframetimings</FILE>
|
||||
GdkFrameTimings
|
||||
gdk_frame_timings_ref
|
||||
gdk_frame_timings_unref
|
||||
gdk_frame_timings_get_frame_counter
|
||||
gdk_frame_timings_get_complete
|
||||
gdk_frame_timings_get_frame_time
|
||||
gdk_frame_timings_get_presentation_time
|
||||
gdk_frame_timings_get_refresh_interval
|
||||
gdk_frame_timings_get_predicted_presentation_time
|
||||
<SUBSECTION Private>
|
||||
gdk_frame_get_type
|
||||
</SECTION>
|
||||
|
@ -30,7 +30,7 @@
|
||||
#include "gdkinternals.h"
|
||||
|
||||
/**
|
||||
* SECTION:frameclock
|
||||
* SECTION:gdkframeclock
|
||||
* @Short_description: Frame clock syncs painting to a window or display
|
||||
* @Title: Frame clock
|
||||
*
|
||||
@ -52,10 +52,10 @@
|
||||
* sense for the synchronization being implemented, the clock will
|
||||
* process a frame and emit signals for each phase that has been
|
||||
* requested. (See the signals of the #GdkFrameClock class for
|
||||
* documentation of the phases. GDK_FRAME_CLOCK_PHASE_UPDATE and the
|
||||
* ::update signal are most interesting for application writers, and
|
||||
* are used to update the animations, using the frame time given by
|
||||
* gdk_frame_clock_get_frame_time().
|
||||
* documentation of the phases. %GDK_FRAME_CLOCK_PHASE_UPDATE and the
|
||||
* #GdkFrameClock::update signal are most interesting for application
|
||||
* writers, and are used to update the animations, using the frame time
|
||||
* given by gdk_frame_clock_get_frame_time().
|
||||
*
|
||||
* The frame time is reported in microseconds and generally in the same
|
||||
* timescale as g_get_monotonic_time(), however, it is not the same
|
||||
@ -65,8 +65,8 @@
|
||||
* are called at a "similar" time get the same value. This means that
|
||||
* if different animations are timed by looking at the difference in
|
||||
* time between an initial value from gdk_frame_clock_get_frame_time()
|
||||
* and the value inside the ::update signal of the clock, they will
|
||||
* stay exactly synchronized.
|
||||
* and the value inside the #GdkFrameClock::update signal of the clock,
|
||||
* they will stay exactly synchronized.
|
||||
*/
|
||||
|
||||
G_DEFINE_ABSTRACT_TYPE (GdkFrameClock, gdk_frame_clock, G_TYPE_OBJECT)
|
||||
@ -174,7 +174,7 @@ gdk_frame_clock_class_init (GdkFrameClockClass *klass)
|
||||
* This signal is emitted as the second step of toolkit and
|
||||
* application processing of the frame. Any work to update
|
||||
* sizes and positions of application elements should be
|
||||
* performed. GTK normally handles this internally.
|
||||
* performed. GTK+ normally handles this internally.
|
||||
*/
|
||||
signals[LAYOUT] =
|
||||
g_signal_new (g_intern_static_string ("layout"),
|
||||
@ -192,8 +192,8 @@ gdk_frame_clock_class_init (GdkFrameClockClass *klass)
|
||||
* This signal is emitted as the third step of toolkit and
|
||||
* application processing of the frame. The frame is
|
||||
* repainted. GDK normally handles this internally and
|
||||
* produce expose events, which are turned into GTK
|
||||
* GtkWidget::draw signals.
|
||||
* produces expose events, which are turned into GTK+
|
||||
* #GtkWidget::draw signals.
|
||||
*/
|
||||
signals[PAINT] =
|
||||
g_signal_new (g_intern_static_string ("paint"),
|
||||
@ -284,7 +284,7 @@ gdk_frame_clock_get_frame_time (GdkFrameClock *frame_clock)
|
||||
* Asks the frame clock to run a particular phase. The signal
|
||||
* corresponding the requested phase will be emitted the next
|
||||
* time the frame clock processes. Multiple calls to
|
||||
* gdk_frame_clock_request_phase() will be combined togethe
|
||||
* gdk_frame_clock_request_phase() will be combined together
|
||||
* and only one frame processed. If you are displaying animated
|
||||
* content and want to continually request the
|
||||
* %GDK_FRAME_CLOCK_PHASE_UPDATE phase for a period of time,
|
||||
|
@ -58,7 +58,7 @@ typedef struct _GdkFrameClockClass GdkFrameClockClass;
|
||||
* @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
|
||||
* phases that can be requested. The elements of the enumeration
|
||||
* correspond to the signals of #GdkPaintClock.
|
||||
*
|
||||
* Since: 3.8
|
||||
|
@ -20,7 +20,7 @@
|
||||
#include "gdkframeclockprivate.h"
|
||||
|
||||
/**
|
||||
* SECTION:frametimings
|
||||
* SECTION:gdkframetimings
|
||||
* @Short_description: Object holding timing information for a single frame
|
||||
* @Title: Frame timings
|
||||
*
|
||||
|
Loading…
Reference in New Issue
Block a user