From c4727240afce2ba62f6059b8724fba6af9306107 Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Mon, 5 Sep 2022 15:37:49 +0200 Subject: [PATCH] compositor: document wlr_surface_{enter,leave,send_frame_done} --- include/wlr/types/wlr_compositor.h | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/include/wlr/types/wlr_compositor.h b/include/wlr/types/wlr_compositor.h index 5a6755c7..55d83fe8 100644 --- a/include/wlr/types/wlr_compositor.h +++ b/include/wlr/types/wlr_compositor.h @@ -231,12 +231,28 @@ bool wlr_surface_point_accepts_input(struct wlr_surface *surface, struct wlr_surface *wlr_surface_surface_at(struct wlr_surface *surface, double sx, double sy, double *sub_x, double *sub_y); +/** + * Notify the client that the surface has entered an output. + * + * This is a no-op if the surface has already entered the output. + */ void wlr_surface_send_enter(struct wlr_surface *surface, struct wlr_output *output); +/** + * Notify the client that the surface has left an output. + * + * This is a no-op if the surface has already left the output. + */ void wlr_surface_send_leave(struct wlr_surface *surface, struct wlr_output *output); +/** + * Complete the queued frame callbacks for this surface. + * + * This will send an event to the client indicating that now is a good time to + * draw its next frame. + */ void wlr_surface_send_frame_done(struct wlr_surface *surface, const struct timespec *when);