mirrors/wlroots
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wlroots/wlroots.git synced 2025-11-12 13:29:45 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

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.

(cherry picked from commit 6219d7b819)
This commit is contained in:
Isaac Freund 2024-05-15 15:28:28 +02:00 • committed by Simon Zeni
parent 8fe2dd82b1
commit ea7083784b
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -288,8 +288,9 @@ bool wlr_surface_has_buffer(struct wlr_surface *surface);
struct wlr_texture *wlr_surface_get_texture(struct wlr_surface *surface); 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 * Get the root of the subsurface tree for this surface.
* a surface in the tree has been destroyed. * 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); struct wlr_surface *wlr_surface_get_root_surface(struct wlr_surface *surface);