Weston fast forward
weston_fast_forward_manager_v1
A Wayland compositor may have a queue of content updates for a wl_surface. Various protocol extensions may impose readiness constraints on these updates, controlling when each update may be applied: for example, FIFO ordering or target presentation timestamps.
This protocol provides a way to "fast forward" through upcoming updates in a mailbox fashion.
destroy()
Destroys the factory object, but does not affect objects it has created.
get_fast_forward(id: new_id<weston_fast_forward_v1>, surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| id | new_id<weston_fast_forward_v1> | |
| surface | object<wl_surface> |
Create a fast_forward object that may be used to ignore content updates on a specified surface.
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.
error { already_exists }
Argument | Value | Description |
|---|---|---|
| already_exists | 0 | fast forward object already exists for this surface |
These fatal protocol errors may be emitted in response to illegal requests.
weston_fast_forward_v1
A fast_forward object to ignore content update constraints.
destroy()
Informs the server that the client will no longer be using this protocol object.
Surface state changes previously made by this protocol are unaffected by this object's destruction.
fast_forward()
Upon wl_surface.commit of a content update containing a fast forward request, the compositor must immediately ignore all previously committed constraints on that surface.
The content update containing the fast forward request also has its constraints ignored. Normal constraint handling resumes for subsequent commits.
surface_destroyed error will be emitted if associated surface no longer exists.
"fast_forward" is double-buffered state, see wl_surface.commit.
error { surface_destroyed }
Argument | Value | Description |
|---|---|---|
| surface_destroyed | 0 | the associated surface no longer exists |
These fatal protocol errors may be emitted in response to illegal requests.
Compositor Support
Copyright
Copyright (C) 2026 Amazon.com, Inc. or its affiliates
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.