From 7a15e715b7c5c91b12f82b3e94230b6644d3893d Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Thu, 12 Aug 2021 00:15:04 +0200 Subject: [PATCH] Document view_map --- include/sway/tree/view.h | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/include/sway/tree/view.h b/include/sway/tree/view.h index 923498ec..11ac74c9 100644 --- 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);