wlr_surface: update get_root_surface() docs

Since destroying a wlr_surface now makes all subsurfaces inert, this
function can no longer fail and return NULL. Document this.
master
Isaac Freund 7 months ago
parent 2c4d3ad12d
commit 6219d7b819
No known key found for this signature in database
GPG Key ID: 86DED400DDFD7A11

@ -329,8 +329,9 @@ bool wlr_surface_state_has_buffer(const struct wlr_surface_state *state);
struct wlr_texture *wlr_surface_get_texture(struct wlr_surface *surface);
/**
* Get the root of the subsurface tree for this surface. Can return NULL if
* a surface in the tree has been destroyed.
* Get the root of the subsurface tree for this surface.
* May return the same surface passed if that surface is the root.
* Never returns NULL.
*/
struct wlr_surface *wlr_surface_get_root_surface(struct wlr_surface *surface);

Loading…
Cancel
Save