Package org.freedesktop.wayland.client

Class WpPresentationProxy

java.lang.Object

org.freedesktop.wayland.client.Proxy<WpPresentationEvents>

org.freedesktop.wayland.client.WpPresentationProxy

All Implemented Interfaces:

WaylandObject

public class WpPresentationProxy
extends Proxy<WpPresentationEvents>

timed presentation related wl_surface requests

The main feature of this interface is accurate presentation timing feedback to ensure smooth video playback while maintaining audio/video synchronization. Some features use the concept of a presentation clock, which is defined in the presentation.clock_id event.

A content update for a wl_surface is submitted by a wl_surface.commit request. Request 'feedback' associates with the wl_surface.commit and provides feedback on the content update, particularly the final realized presentation time.

When the final realized presentation time is available, e.g. after a framebuffer flip completes, the requested presentation_feedback.presented events are sent. The final presentation time can differ from the compositor's predicted display update time and the update's target time, especially when the compositor misses its target vertical blanking period.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INTERFACE_NAME

Fields inherited from class org.freedesktop.wayland.client.Proxy

pointer

Constructor Summary

Constructors

Constructor	Description
WpPresentationProxy(MemorySegment pointer)
WpPresentationProxy(MemorySegment pointer, WpPresentationEvents implementation, int version)

Method Summary

Modifier and Type	Method	Description
void	destroy()	unbind from the presentation interface
WpPresentationFeedbackProxy	feedback(WlSurfaceProxy surface, WpPresentationFeedbackEvents implementation)	request presentation feedback information

Methods inherited from class org.freedesktop.wayland.client.Proxy

equals, getId, getImplementation, getPointer, getVersion, hashCode, marshal, marshal, marshalConstructor, setQueue

Methods inherited from class java.lang.Object

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

Field Details

INTERFACE_NAME

public static final String INTERFACE_NAME

See Also:

• Constant Field Values

Constructor Details

WpPresentationProxy

public WpPresentationProxy(MemorySegment pointer,
 WpPresentationEvents implementation,
 int version)

WpPresentationProxy

public WpPresentationProxy(MemorySegment pointer)

Method Details

destroy

public void destroy()

unbind from the presentation interface

Informs the server that the client will no longer be using this protocol object. Existing objects created by this object are not affected.

Overrides:

destroy in class Proxy<WpPresentationEvents>

feedback

public WpPresentationFeedbackProxy feedback(@Nonnull
 WlSurfaceProxy surface,
 WpPresentationFeedbackEvents implementation)

request presentation feedback information

Request presentation feedback for the current content submission on the given surface. This creates a new presentation_feedback object, which will deliver the feedback information once. If multiple presentation_feedback objects are created for the same submission, they will all deliver the same information.

For details on what information is returned, see the presentation_feedback interface.

Parameters:

surface - target surface

implementation - A protocol event listener for the newly created proxy.