docs: wlr_surface_from_resource cannot return NULL

Surfaces never become inert.
This commit is contained in:
Isaac Freund 2021-01-05 12:03:01 +01:00 committed by Simon Ser
parent 5d24f6e098
commit 83fdfa511d

View file

@ -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); 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); struct wlr_surface *wlr_surface_from_resource(struct wl_resource *resource);
/** /**