nordic-dev.net/wlroots
2
0
Fork 0
mirror of https://gitlab.freedesktop.org/wlroots/wlroots.git synced 2024-11-25 08:32:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

wlr_surface: update get_root_surface() docs

Browse Source 
Since destroying a wlr_surface now makes all subsurfaces inert, this
function can no longer fail and return NULL. Document this.
This commit is contained in:
Isaac Freund 2024-05-15 15:28:28 +02:00
parent 2c4d3ad12d
commit 6219d7b819
No known key found for this signature in database
GPG Key ID: 86DED400DDFD7A11
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
include/wlr/types/wlr_compositor.h
View File

@ -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);