Package ch.bailu.gtk.gdk

Class FrameTimings

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.type.Record
ch.bailu.gtk.gdk.FrameTimings
All Implemented Interfaces:
PointerInterface
public class FrameTimings extends Record
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.

https://docs.gtk.org/gdk4/struct.FrameTimings.html

  • Constructor Details

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • getComplete

      public boolean getComplete()
      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:
      %TRUE if all information that will be available for the frame has been filled in.

    • getFrameCounter

      public long getFrameCounter()
      Gets the frame counter value of the `GdkFrameClock` when
      this frame was drawn.
      Returns:
      the frame counter value for this frame

    • getFrameTime

      public long getFrameTime()
      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].
      Returns:
      the frame time for the frame, in the timescale of g_get_monotonic_time()

    • getPredictedPresentationTime

      public long getPredictedPresentationTime()
      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.
      Returns:
      The predicted time at which the frame will be presented, in the timescale of g_get_monotonic_time(), or 0 if no predicted presentation time is available.

    • getPresentationTime

      public long getPresentationTime()
      Reurns the presentation time.

      This is the time at which the frame became visible to the user.
      Returns:
      the time the frame was displayed to the user, in the timescale of g_get_monotonic_time(), or 0 if no presentation time is available. See [method@Gdk.FrameTimings.get_complete]

    • getRefreshInterval

      public long getRefreshInterval()
      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:
      the refresh interval of the display, in microseconds, or 0 if the refresh interval is not available. See [method@Gdk.FrameTimings.get_complete].

    • ref

      public FrameTimings ref()
      Increases the reference count of @timings.
      Returns:
      @timings

    • unref

      public void unref()
      Decreases the reference count of @timings.

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

    • getTypeID

      public static long getTypeID()

    • getParentTypeID

      public static long getParentTypeID()

    • getTypeSize

      public static TypeSystem.TypeSize getTypeSize()

    • getParentTypeSize

      public static TypeSystem.TypeSize getParentTypeSize()

    • getInstanceSize

      public static int getInstanceSize()