From 7ce966a5d4c73cfe37f3538e887f2ec915b1a1dc Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Thu, 20 Jan 2022 09:55:21 +0100 Subject: [PATCH] subcompositor: document subsurface_from_resource --- types/wlr_subcompositor.c | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/types/wlr_subcompositor.c b/types/wlr_subcompositor.c index 397baf8c..e9d53f53 100644 --- a/types/wlr_subcompositor.c +++ b/types/wlr_subcompositor.c @@ -61,6 +61,12 @@ static void subsurface_destroy(struct wlr_subsurface *subsurface) { static const struct wl_subsurface_interface subsurface_implementation; +/** + * Get a wlr_subsurface from a wl_subsurface resource. + * + * Returns NULL if the subsurface is inert (e.g. the wl_surface object got + * destroyed). + */ static struct wlr_subsurface *subsurface_from_resource( struct wl_resource *resource) { assert(wl_resource_instance_of(resource, &wl_subsurface_interface,