Gjsify LogoGjsify Logo

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

To retrieve GdkFrameTimings objects, use [methodGdk.FrameClock.get_timings] or [methodGdk.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.

record

Hierarchy

  • FrameTimings

Index

Constructors

Properties

name: string

Methods

  • getComplete(): boolean
  • 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.

    Returns boolean

  • getFrameCounter(): number
  • Gets the frame counter value of the GdkFrameClock when this frame was drawn.

    Returns number

  • getFrameTime(): number
  • Returns the frame time for the frame.

    This is the time value that is typically used to time animations for the frame. See [methodGdk.FrameClock.get_frame_time].

    Returns number

  • getPredictedPresentationTime(): number
  • 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 [methodGdk.FrameTimings.get_presentation_time], which is only available after the frame has been presented.

    In general, if you are simply animating, you should use [methodGdk.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.

    Returns number

  • getPresentationTime(): number
  • Reurns the presentation time.

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

    Returns number

  • getRefreshInterval(): number
  • 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”.

    Returns number

  • unref(): void
  • Decreases the reference count of timings.

    If timings is no longer referenced, it will be freed.

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method