Commit a4fd9e65 authored by Pekka Paalanen's avatar Pekka Paalanen Committed by Kristian Høgsberg
Browse files

protocol: wl_surface.frame needs wl_surface.commit

Clarify, when frame request takes effect.
Explain when to send/receive the callback.
Signed-off-by: Pekka Paalanen's avatarPekka Paalanen <>
parent b61c0f47
......@@ -707,8 +707,18 @@
<description summary="request repaint feedback">
Request notification when the next frame is displayed. Useful
for throttling redrawing operations, and driving animations.
The frame request will take effect on the next wl_surface.commit.
The notification will only be posted for one frame unless
requested again.
A server should avoid signalling the frame callbacks if the
surface is not visible in any way, e.g. the surface is off-screen,
or completely obscured by other opaque surfaces.
A client can request a frame callback even without an attach,
damage, or any other state changes. wl_surface.commit triggers a
repaint, so the callback event will arrive after the next output
refresh where the surface is visible.
<arg name="callback" type="new_id" interface="wl_callback"/>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment