package ocgtk

  1. Overview
  2. Docs
OCaml bindings for GTK 4

Install 

dune-project
 Dependency

github.com Edit opam file Versions (2)

Authors

  1. C
    Chris Armstrong

Maintainers

  1. H
    hello@chrisarmstrong.dev

Sources

v0.1-preview2.tar.gz
sha256=4e50fdb5093136a10fc8ffbe388e44cbcb70d52f8afdd48863ec7e22580ff054

doc/ocgtk.gdk/Ocgtk_gdk/Gdk/Wrappers/Frame_timings/index.html

Module Wrappers.Frame_timings

type t = [ `frame_timings ] Gobject.obj

A `GdkFrameTimings` object holds timing information for a single frame of the application’s displays.

To retrieve `GdkFrameTimings` objects, use method@Gdk.FrameClock.get_timings or method@Gdk.FrameClock.get_current_timings. The information in `GdkFrameTimings` is useful for precise synchronization of video with the event or audio streams, and for measuring quality metrics for the application’s display, such as latency and jitter.

val ref : t -> t

Increases the reference count of @timings.

val get_refresh_interval : t -> int64

Gets the natural interval between presentation times for the display that this frame was displayed on.

Frame presentation usually happens during the “vertical blanking interval”.

val get_presentation_time : t -> int64

Reurns the presentation time.

This is the time at which the frame became visible to the user.

val get_predicted_presentation_time : t -> int64

Gets the predicted time at which this frame will be displayed.

Although no predicted time may be available, if one is available, it will be available while the frame is being generated, in contrast to method@Gdk.FrameTimings.get_presentation_time, which is only available after the frame has been presented.

In general, if you are simply animating, you should use method@Gdk.FrameClock.get_frame_time rather than this function, but this function is useful for applications that want exact control over latency. For example, a movie player may want this information for Audio/Video synchronization.

val get_frame_time : t -> int64

Returns the frame time for the frame.

This is the time value that is typically used to time animations for the frame. See method@Gdk.FrameClock.get_frame_time.

val get_frame_counter : t -> int64

Gets the frame counter value of the `GdkFrameClock` when this frame was drawn.

val get_complete : t -> bool

Returns whether @timings are complete.

The timing information in a `GdkFrameTimings` is filled in incrementally as the frame as drawn and passed off to the window system for processing and display to the user. The accessor functions for `GdkFrameTimings` can return 0 to indicate an unavailable value for two reasons: either because the information is not yet available, or because it isn't available at all.

Once this function returns %TRUE for a frame, you can be certain that no further values will become available and be stored in the `GdkFrameTimings`.

val get_type : unit -> Gobject.Type.t