sway

commit 7a15e715b7c5c91b12f82b3e94230b6644d3893d
parent b345d6e5d2f175b0be5c5f2a445291611104c98e
Author: Simon Ser <contact@emersion.fr>
Date:   Thu, 12 Aug 2021 00:15:04 +0200

Document view_map

Diffstat:
M
include/sway/tree/view.h
 | 
9
+++++++++

1 file changed, 9 insertions(+), 0 deletions(-)
diff --git a/include/sway/tree/view.h b/include/sway/tree/view.h
@@ -310,6 +310,15 @@ void view_destroy(struct sway_view *view);
 
 void view_begin_destroy(struct sway_view *view);
 
+/**
+ * Map a view, ie. make it visible in the tree.
+ *
+ * `fullscreen` should be set to true (and optionally `fullscreen_output`
+ * should be populated) if the view should be made fullscreen immediately.
+ *
+ * `decoration` should be set to true if the client prefers CSD. The client's
+ * preference may be ignored.
+ */
 void view_map(struct sway_view *view, struct wlr_surface *wlr_surface,
 	bool fullscreen, struct wlr_output *fullscreen_output, bool decoration);