wlr_scene: clarify wlr_scene_output ownership semantics

wlr_scene_output_layout_add_output() was made public by f5917f0247
("scene_output_layout: make output adding explicit") but the ownership
semantics are not obvious and should be clarified.
This commit is contained in:
John Lindgren 2023-09-22 21:13:20 -04:00
parent 98a745d926
commit 1a731596c5
1 changed files with 3 additions and 0 deletions

View File

@ -529,6 +529,9 @@ struct wlr_scene_output_layout *wlr_scene_attach_output_layout(struct wlr_scene
/**
* Add an output to the scene, with its positioning defined by the 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.
*/
void wlr_scene_output_layout_add_output(struct wlr_scene_output_layout *sol,
struct wlr_output_layout_output *lo, struct wlr_scene_output *so);