Package org.freedesktop.wayland.server

Interface WpPresentationRequests

public interface WpPresentationRequests

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 int	VERSION

Method Summary

Modifier and Type	Method	Description
void	destroy(WpPresentationResource requester)	unbind from the presentation interface
void	feedback(WpPresentationResource requester, WlSurfaceResource surface, int callback)	request presentation feedback information

Field Details

VERSION

static final int VERSION

See Also:

• Constant Field Values

Method Details

destroy

void destroy(WpPresentationResource requester)

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.

Parameters:

requester - The protocol object that made the request.

feedback

void feedback(WpPresentationResource requester,
 @Nonnull
 WlSurfaceResource surface,
 int callback)

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:

requester - The protocol object that made the request.

surface - target surface

callback - new feedback object