hyprwm/wlroots-hyprland
1
0
Fork 0
mirror of https://github.com/hyprwm/wlroots-hyprland.git synced 2024-12-23 10:29:49 +01:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #1012 from acrisci/doc-map-unmap

Browse source 
document the map/unmap xdg-shell events
This commit is contained in:
emersion 2018-05-28 20:27:55 +01:00 committed by GitHub
commit 3444f43c16
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 40 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
include/wlr/types/wlr_xdg_shell.h
View file

@ -14,6 +14,12 @@ struct wlr_xdg_shell {
struct wl_listener display_destroy; struct wl_listener display_destroy;
struct { struct {
/**
* The `new_surface` event signals that a client has requested to
* create a new shell surface. At this point, the surface is ready to
* be configured but is not mapped or ready receive input events. The
* surface will be ready to be managed on the `map` event.
*/
struct wl_signal new_surface; struct wl_signal new_surface;
} events; } events;
@ -162,7 +168,21 @@ struct wlr_xdg_surface {
struct wl_signal destroy; struct wl_signal destroy;
struct wl_signal ping_timeout; struct wl_signal ping_timeout;
struct wl_signal new_popup; struct wl_signal new_popup;
/**
* The `map` event signals that the shell surface is ready to be
* managed by the compositor and rendered on the screen. At this point,
* the surface has configured its properties, has had the opportunity
* to bind to the seat to receive input events, and has a buffer that
* is ready to be rendered. You can now safely add this surface to a
* list of views.
*/
struct wl_signal map; struct wl_signal map;
/**
* The `unmap` event signals that the surface is no longer in a state
* where it should be shown on the screen. 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.
*/
struct wl_signal unmap; struct wl_signal unmap;
} events; } events;

20
include/wlr/types/wlr_xdg_shell_v6.h
View file

@ -15,6 +15,12 @@ struct wlr_xdg_shell_v6 {
struct wl_listener display_destroy; struct wl_listener display_destroy;
struct { struct {
/**
* The `new_surface` event signals that a client has requested to
* create a new shell surface. At this point, the surface is ready to
* be configured but is not mapped or ready receive input events. The
* surface will be ready to be managed on the `map` event.
*/
struct wl_signal new_surface; struct wl_signal new_surface;
} events; } events;
@ -160,7 +166,21 @@ struct wlr_xdg_surface_v6 {
struct wl_signal destroy; struct wl_signal destroy;
struct wl_signal ping_timeout; struct wl_signal ping_timeout;
struct wl_signal new_popup; struct wl_signal new_popup;
/**
* The `map` event signals that the shell surface is ready to be
* managed by the compositor and rendered on the screen. At this point,
* the surface has configured its properties, has had the opportunity
* to bind to the seat to receive input events, and has a buffer that
* is ready to be rendered. You can now safely add this surface to a
* list of views.
*/
struct wl_signal map; struct wl_signal map;
/**
* The `unmap` event signals that the surface is no longer in a state
* where it should be shown on the screen. 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.
*/
struct wl_signal unmap; struct wl_signal unmap;
} events; } events;