Skip to content

wp_fifo_manager_v1¤

wayland.wp_fifo_manager_v1 ¤

Protocol for fifo constraints

When a Wayland compositor considers applying a content update, it must ensure all the update's readiness constraints (fences, etc) are met.

This protocol provides a way to use the completion of a display refresh cycle as an additional readiness constraint.

Warning! The protocol described in this file is currently in the testing phase. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes can only be done by creating a new major version of the extension.

Methods:

  • destroy

    Unbind from the manager interface

  • get_fifo

    Request fifo interface for surface

error ¤

Fatal presentation error

These fatal protocol errors may be emitted in response to illegal requests.

destroy ¤

destroy() -> None

Unbind from the manager interface

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

get_fifo ¤

get_fifo(surface: wl_surface) -> wp_fifo_v1

Request fifo interface for surface

Establish a fifo object for a surface that may be used to add display refresh constraints to content updates.

Only one such object may exist for a surface and attempting to create more than one will result in an already_exists protocol error. If a surface is acted on by multiple software components, general best practice is that only the component performing wl_surface.attach operations should use this protocol.

Returns:

  • wp_fifo_v1 ( wp_fifo_v1 ) –

    The created object