mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2025-11-02 09:01:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

protocol: wl_surface.frame needs wl_surface.commit

Browse source 
Clarify, when frame request takes effect.
Explain when to send/receive the callback.

Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
This commit is contained in:
Pekka Paalanen 2012-10-10 12:47:49 +03:00 • committed by Kristian Høgsberg
parent b61c0f47d5
commit a4fd9e6583
1 changed files with 11 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

12
protocol/wayland.xml
View file

@ -705,10 +705,20 @@
<request name="frame"> <request name="frame">
<description summary="request repaint feedback"> <description summary="request repaint feedback">
Request notification when the next frame is displayed. Useful Request notification when the next frame is displayed. Useful
for throttling redrawing operations, and driving animations. 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 The notification will only be posted for one frame unless
requested again. 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.
</description> </description>
<arg name="callback" type="new_id" interface="wl_callback"/> <arg name="callback" type="new_id" interface="wl_callback"/>