Package org.gnome.gdk

Class FrameTimings

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gdk.FrameTimings

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class FrameTimings
extends ProxyInstance

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

To retrieve GdkFrameTimings objects, use FrameClock.getTimings(long) or FrameClock.getCurrentTimings(). 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.

Constructor Summary

Constructors

Constructor	Description
FrameTimings(MemorySegment address)	Create a FrameTimings proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
boolean	getComplete()	Returns whether this FrameTimings are complete.
long	getFrameCounter()	Gets the frame counter value of the GdkFrameClock when this frame was drawn.
long	getFrameTime()	Returns the frame time for the frame.
long	getPredictedPresentationTime()	Gets the predicted time at which this frame will be displayed.
long	getPresentationTime()	Reurns the presentation time.
long	getRefreshInterval()	Gets the natural interval between presentation times for the display that this frame was displayed on.
static Type	getType()	Get the GType of the FrameTimings class
FrameTimings	ref()	Increases the reference count of this FrameTimings.
void	unref()	Decreases the reference count of this FrameTimings.

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FrameTimings

public FrameTimings(MemorySegment address)

Create a FrameTimings proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the FrameTimings class

Returns:

the GType

getComplete

public boolean getComplete()

Returns whether this FrameTimings 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 FrameClock.getFrameTime().

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 getPresentationTime(), which is only available after the frame has been presented.

In general, if you are simply animating, you should use FrameClock.getFrameTime() 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 getComplete()

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

ref

public FrameTimings ref()

Increases the reference count of this FrameTimings.

Returns:

this FrameTimings

unref

public void unref()

Decreases the reference count of this FrameTimings.

If this FrameTimings is no longer referenced, it will be freed.