From 85e299e6c55e5478617cb167eea316cfe7ee430c Mon Sep 17 00:00:00 2001 From: Isaac Freund Date: Fri, 17 Apr 2020 15:11:59 +0200 Subject: Document the events of wlr_layer_surface --- include/wlr/types/wlr_layer_shell_v1.h | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/include/wlr/types/wlr_layer_shell_v1.h b/include/wlr/types/wlr_layer_shell_v1.h index 4e5f969b..7c6a5cd2 100644 --- a/include/wlr/types/wlr_layer_shell_v1.h +++ b/include/wlr/types/wlr_layer_shell_v1.h @@ -86,9 +86,30 @@ struct wlr_layer_surface_v1 { struct wl_listener surface_destroy; struct { + /** + * The destroy signal indicates that the wlr_layer_surface is about to be + * freed. It is guaranteed that the unmap signal is raised before the destroy + * signal if the layer surface is destroyed while mapped. + */ struct wl_signal destroy; + /** + * The map signal indicates that the client has configured itself and is + * ready to be rendered by the compositor. + */ struct wl_signal map; + /** + * The unmap signal indicates that the surface is no longer in a state where + * it should be rendered by the compositor. This might happen if the surface + * no longer has a displayable buffer because either the surface has been + * hidden or is about to be destroyed. It is guaranteed that the unmap signal + * is raised before the destroy signal if the layer surface is destroyed + * while mapped. + */ struct wl_signal unmap; + /** + * The new_popup signal is raised when a new popup is created. The data + * parameter passed to the listener is a pointer to the new wlr_xdg_popup. + */ struct wl_signal new_popup; } events; -- cgit v1.2.3