1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT
use crate::FrameClockPhase;
use crate::FrameTimings;
use glib::object::ObjectType as ObjectType_;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem::transmute;
glib::wrapper! {
/// A [`FrameClock`][crate::FrameClock] tells the application when to update and repaint a
/// window. This may be synced to the vertical refresh rate of the
/// monitor, for example. Even when the frame clock uses a simple timer
/// rather than a hardware-based vertical sync, the frame clock helps
/// because it ensures everything paints at the same time (reducing the
/// total number of frames). The frame clock can also automatically
/// stop painting when it knows the frames will not be visible, or
/// scale back animation framerates.
///
/// [`FrameClock`][crate::FrameClock] is designed to be compatible with an OpenGL-based
/// implementation or with mozRequestAnimationFrame in Firefox,
/// for example.
///
/// A frame clock is idle until someone requests a frame with
/// [`request_phase()`][Self::request_phase()]. At some later point that makes
/// 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 [`FrameClock`][crate::FrameClock] class for
/// documentation of the phases. [`FrameClockPhase::UPDATE`][crate::FrameClockPhase::UPDATE] and the
/// `signal::FrameClock::update` signal are most interesting for application
/// writers, and are used to update the animations, using the frame time
/// given by [`frame_time()`][Self::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
/// as `g_get_monotonic_time()`. The frame time does not advance during
/// the time a frame is being painted, and outside of a frame, an attempt
/// is made so that all calls to [`frame_time()`][Self::frame_time()] that
/// 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 [`frame_time()`][Self::frame_time()]
/// and the value inside the `signal::FrameClock::update` signal of the clock,
/// they will stay exactly synchronized.
///
/// This is an Abstract Base Class, you cannot instantiate it.
#[doc(alias = "GdkFrameClock")]
pub struct FrameClock(Object<ffi::GdkFrameClock, ffi::GdkFrameClockClass>);
match fn {
type_ => || ffi::gdk_frame_clock_get_type(),
}
}
impl FrameClock {
/// Starts updates for an animation. Until a matching call to
/// [`end_updating()`][Self::end_updating()] is made, the frame clock will continually
/// request a new frame with the [`FrameClockPhase::UPDATE`][crate::FrameClockPhase::UPDATE] phase.
/// This function may be called multiple times and frames will be
/// requested until [`end_updating()`][Self::end_updating()] is called the same
/// number of times.
#[doc(alias = "gdk_frame_clock_begin_updating")]
pub fn begin_updating(&self) {
unsafe {
ffi::gdk_frame_clock_begin_updating(self.to_glib_none().0);
}
}
/// Stops updates for an animation. See the documentation for
/// [`begin_updating()`][Self::begin_updating()].
#[doc(alias = "gdk_frame_clock_end_updating")]
pub fn end_updating(&self) {
unsafe {
ffi::gdk_frame_clock_end_updating(self.to_glib_none().0);
}
}
/// Gets the frame timings for the current frame.
///
/// # Returns
///
/// the [`FrameTimings`][crate::FrameTimings] for the
/// frame currently being processed, or even no frame is being
/// processed, for the previous frame. Before any frames have been
/// processed, returns [`None`].
#[doc(alias = "gdk_frame_clock_get_current_timings")]
#[doc(alias = "get_current_timings")]
pub fn current_timings(&self) -> Option<FrameTimings> {
unsafe {
from_glib_none(ffi::gdk_frame_clock_get_current_timings(
self.to_glib_none().0,
))
}
}
/// A [`FrameClock`][crate::FrameClock] maintains a 64-bit counter that increments for
/// each frame drawn.
///
/// # Returns
///
/// inside frame processing, the value of the frame counter
/// for the current frame. Outside of frame processing, the frame
/// counter for the last frame.
#[doc(alias = "gdk_frame_clock_get_frame_counter")]
#[doc(alias = "get_frame_counter")]
pub fn frame_counter(&self) -> i64 {
unsafe { ffi::gdk_frame_clock_get_frame_counter(self.to_glib_none().0) }
}
/// Gets the time that should currently be used for animations. Inside
/// the processing of a frame, it’s the time used to compute the
/// animation position of everything in a frame. Outside of a frame, it's
/// the time of the conceptual “previous frame,” which may be either
/// the actual previous frame time, or if that’s too old, an updated
/// time.
///
/// # Returns
///
/// a timestamp in microseconds, in the timescale of
/// of `g_get_monotonic_time()`.
#[doc(alias = "gdk_frame_clock_get_frame_time")]
#[doc(alias = "get_frame_time")]
pub fn frame_time(&self) -> i64 {
unsafe { ffi::gdk_frame_clock_get_frame_time(self.to_glib_none().0) }
}
/// [`FrameClock`][crate::FrameClock] internally keeps a history of [`FrameTimings`][crate::FrameTimings]
/// objects for recent frames that can be retrieved with
/// [`timings()`][Self::timings()]. The set of stored frames
/// is the set from the counter values given by
/// [`history_start()`][Self::history_start()] and
/// [`frame_counter()`][Self::frame_counter()], inclusive.
///
/// # Returns
///
/// the frame counter value for the oldest frame
/// that is available in the internal frame history of the
/// [`FrameClock`][crate::FrameClock].
#[doc(alias = "gdk_frame_clock_get_history_start")]
#[doc(alias = "get_history_start")]
pub fn history_start(&self) -> i64 {
unsafe { ffi::gdk_frame_clock_get_history_start(self.to_glib_none().0) }
}
/// Retrieves a [`FrameTimings`][crate::FrameTimings] object holding timing information
/// for the current frame or a recent frame. The [`FrameTimings`][crate::FrameTimings]
/// object may not yet be complete: see [`FrameTimings::is_complete()`][crate::FrameTimings::is_complete()].
/// ## `frame_counter`
/// the frame counter value identifying the frame to
/// be received.
///
/// # Returns
///
/// the [`FrameTimings`][crate::FrameTimings] object for
/// the specified frame, or [`None`] if it is not available. See
/// [`history_start()`][Self::history_start()].
#[doc(alias = "gdk_frame_clock_get_timings")]
#[doc(alias = "get_timings")]
pub fn timings(&self, frame_counter: i64) -> Option<FrameTimings> {
unsafe {
from_glib_none(ffi::gdk_frame_clock_get_timings(
self.to_glib_none().0,
frame_counter,
))
}
}
/// 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
/// [`request_phase()`][Self::request_phase()] will be combined together
/// and only one frame processed. If you are displaying animated
/// content and want to continually request the
/// [`FrameClockPhase::UPDATE`][crate::FrameClockPhase::UPDATE] phase for a period of time,
/// you should use [`begin_updating()`][Self::begin_updating()] instead, since
/// this allows GTK+ to adjust system parameters to get maximally
/// smooth animations.
/// ## `phase`
/// the phase that is requested
#[doc(alias = "gdk_frame_clock_request_phase")]
pub fn request_phase(&self, phase: FrameClockPhase) {
unsafe {
ffi::gdk_frame_clock_request_phase(self.to_glib_none().0, phase.into_glib());
}
}
/// This signal ends processing of the frame. Applications
/// should generally not handle this signal.
#[doc(alias = "after-paint")]
pub fn connect_after_paint<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn after_paint_trampoline<F: Fn(&FrameClock) + 'static>(
this: *mut ffi::GdkFrameClock,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"after-paint\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
after_paint_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
/// This signal begins processing of the frame. Applications
/// should generally not handle this signal.
#[doc(alias = "before-paint")]
pub fn connect_before_paint<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn before_paint_trampoline<F: Fn(&FrameClock) + 'static>(
this: *mut ffi::GdkFrameClock,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"before-paint\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
before_paint_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
/// This signal is used to flush pending motion events that
/// are being batched up and compressed together. Applications
/// should not handle this signal.
#[doc(alias = "flush-events")]
pub fn connect_flush_events<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn flush_events_trampoline<F: Fn(&FrameClock) + 'static>(
this: *mut ffi::GdkFrameClock,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"flush-events\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
flush_events_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
/// 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.
#[doc(alias = "layout")]
pub fn connect_layout<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn layout_trampoline<F: Fn(&FrameClock) + 'static>(
this: *mut ffi::GdkFrameClock,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"layout\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
layout_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
/// 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
/// produces expose events, which are turned into GTK+
/// `GtkWidget::draw` signals.
#[doc(alias = "paint")]
pub fn connect_paint<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn paint_trampoline<F: Fn(&FrameClock) + 'static>(
this: *mut ffi::GdkFrameClock,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"paint\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
paint_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
/// This signal is emitted after processing of the frame is
/// finished, and is handled internally by GTK+ to resume normal
/// event processing. Applications should not handle this signal.
#[doc(alias = "resume-events")]
pub fn connect_resume_events<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn resume_events_trampoline<F: Fn(&FrameClock) + 'static>(
this: *mut ffi::GdkFrameClock,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"resume-events\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
resume_events_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
/// This signal is emitted as the first step of toolkit and
/// application processing of the frame. Animations should
/// be updated using [`frame_time()`][Self::frame_time()].
/// Applications can connect directly to this signal, or
/// use `gtk_widget_add_tick_callback()` as a more convenient
/// interface.
#[doc(alias = "update")]
pub fn connect_update<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn update_trampoline<F: Fn(&FrameClock) + 'static>(
this: *mut ffi::GdkFrameClock,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"update\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
update_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl fmt::Display for FrameClock {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("FrameClock")
}
}