wlr input inhibitor
zwlr_input_inhibit_manager_v1
Clients can use this interface to prevent input events from being sent to any surfaces but its own, which is useful for example in lock screen software. It is assumed that access to this interface will be locked down to whitelisted clients by the compositor.
Note! This protocol is deprecated and not intended for production use. For screen lockers, use the ext-session-lock-v1 protocol.
get_inhibitor(id: new_id<zwlr_input_inhibitor_v1>)
Argument | Type | Description |
|---|---|---|
| id | new_id<zwlr_input_inhibitor_v1> |
Activates the input inhibitor. As long as the inhibitor is active, the compositor will not send input events to other clients.
error { already_inhibited }
Argument | Value | Description |
|---|---|---|
| already_inhibited | 0 | an input inhibitor is already in use on the compositor |
zwlr_input_inhibitor_v1
While this resource exists, input to clients other than the owner of the inhibitor resource will not receive input events. Any client which previously had focus will receive a leave event and will not be given focus again. The client that owns this resource will receive all input events normally. The compositor will also disable all of its own input processing (such as keyboard shortcuts) while the inhibitor is active.
The compositor may continue to send input events to selected clients, such as an on-screen keyboard (via the input-method protocol).
destroy()
Destroy the inhibitor and allow other clients to receive input.
Compositor Support
Mutter  46 | KWin  6.2 | Sway  1.9 | COSMIC  1.0.0 | Hyprland  0.42.0 | niri 0.1.8 | Weston  13 | Mir  2.18 | GameScope  3.15.14 | Jay 1.7.0 | |
|---|---|---|---|---|---|---|---|---|---|---|
| zwlr_input_inhibit_manager_v1 | x | x | 1 | x | x | x | x | x | x | x |
Copyright
Copyright © 2018 Drew DeVault
Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of the copyright holders not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. The copyright holders make no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.
THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.