aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorAlexander Orzechowski <alex@ozal.ski>2023-10-07 13:31:20 -0400
committerAlexander Orzechowski <alex@ozal.ski>2023-10-07 13:31:20 -0400
commite1e911d425fde6ce85475de95b44aa1340725224 (patch)
tree89387092679013d8d88c044ce2c8f09308f906a6 /include
parent5fb0007e0249388792f3772c30bfabf8d551dec0 (diff)
scene_output_layout: Don't destroy output when output layout is destroyed
There were a couple of problems with this: 1. The behavior is unexpected. Typically objects in wlroots won't also destroy objects that they depend on. For instance, wlr_scene_output will not destroy the wlr_output when it's destroyed. It shouldn't be any different for scene layouts. 2. This fixes a crash where because wlr_output_layout and wlr_scene_output are both addons to wlr_output, we might get into a situation where wl_list_for_each_safe might malfunction. See [1] This means that the compositor needs to manually destroy the output when they destroy the layout, hence ~breaking. Compositors can just call `wlr_scene_output_destroy()` if they want to destroy both at the same time. [1] https://gitlab.freedesktop.org/wlroots/wlroots/-/merge_requests/4358#note_2106260 This reverts commit 1a731596c5bcd252d8796cacb59af8b20ceb914f. Co-authored-by: Kirill Primak <vyivel@eclair.cafe>
Diffstat (limited to 'include')
-rw-r--r--include/wlr/types/wlr_scene.h14
1 files changed, 6 insertions, 8 deletions
diff --git a/include/wlr/types/wlr_scene.h b/include/wlr/types/wlr_scene.h
index a756e88e..1fa60b65 100644
--- a/include/wlr/types/wlr_scene.h
+++ b/include/wlr/types/wlr_scene.h
@@ -517,21 +517,19 @@ struct wlr_scene_output *wlr_scene_get_scene_output(struct wlr_scene *scene,
/**
* Attach an output layout to a scene.
*
- * With an attached `wlr_scene_output_layout`, removing or repositioning an output in the output
- * layout will respectively remove or reposition a corresponding scene-graph output. When the output
- * layout is destroyed, scene-graph outputs which were attached to this helper will be destroyed.
+ * The resulting scene output layout allows to synchronize the positions of scene
+ * outputs with the positions of corresponding layout outputs.
*
- * When adding an output to the output_layout, users must also create a `wlr_scene_output` and pass
- * it to wlr_scene_output_layout_add_output().
+ * It is automatically destroyed when the scene or the output layout is destroyed.
*/
struct wlr_scene_output_layout *wlr_scene_attach_output_layout(struct wlr_scene *scene,
struct wlr_output_layout *output_layout);
/**
- * Add an output to the scene, with its positioning defined by the output layout.
+ * Add an output to the scene output layout.
*
- * The `wlr_scene_output_layout` takes ownership of the `wlr_scene_output`, which will be destroyed
- * when either the `wlr_scene_output_layout` or the `wlr_output_layout_output` is destroyed.
+ * When the layout output is repositioned, the scene output will be repositioned
+ * accordingly.
*/
void wlr_scene_output_layout_add_output(struct wlr_scene_output_layout *sol,
struct wlr_output_layout_output *lo, struct wlr_scene_output *so);