From 83fdfa511d2d3eca6f37187e735e209e8421da6f Mon Sep 17 00:00:00 2001 From: Isaac Freund Date: Tue, 5 Jan 2021 12:03:01 +0100 Subject: docs: wlr_surface_from_resource cannot return NULL Surfaces never become inert. --- include/wlr/types/wlr_surface.h | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'include/wlr') diff --git a/include/wlr/types/wlr_surface.h b/include/wlr/types/wlr_surface.h index 175150f9..ef2f2dac 100644 --- a/include/wlr/types/wlr_surface.h +++ b/include/wlr/types/wlr_surface.h @@ -256,6 +256,11 @@ void wlr_surface_send_frame_done(struct wlr_surface *surface, */ void wlr_surface_get_extends(struct wlr_surface *surface, struct wlr_box *box); +/** + * Get the wlr_surface corresponding to a wl_surface resource. This asserts + * that the resource is a valid wl_surface resource created by wlroots and + * will never return NULL. + */ struct wlr_surface *wlr_surface_from_resource(struct wl_resource *resource); /** -- cgit v1.2.3