diff options
| author | Isaac Freund <ifreund@ifreund.xyz> | 2021-01-05 12:03:01 +0100 |
|---|---|---|
| committer | Simon Ser <contact@emersion.fr> | 2021-01-05 12:22:47 +0100 |
| commit | 83fdfa511d2d3eca6f37187e735e209e8421da6f (patch) | |
| tree | 0b6b10475d6aabc87257c80778cb3e18511f68e3 /include | |
| parent | 5d24f6e09861e32837afb5f36c41f21edf0fc900 (diff) | |
docs: wlr_surface_from_resource cannot return NULL
Surfaces never become inert.
Diffstat (limited to 'include')
| -rw-r--r-- | include/wlr/types/wlr_surface.h | 5 |
1 files changed, 5 insertions, 0 deletions
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); /** |