Hyprland toplevel mapping
This protocol allows clients to retrieve the mapping of toplevels to hyprland window addresses.
hyprland_toplevel_mapping_manager_v1
This object is a manager which offers requests to retrieve a window address for a toplevel.
get_window_for_toplevel(handle: new_id<hyprland_toplevel_window_mapping_handle_v1>, toplevel: object<ext_foreign_toplevel_handle_v1>)
Argument | Type | Description |
|---|---|---|
| handle | new_id<hyprland_toplevel_window_mapping_handle_v1> | |
| toplevel | object<ext_foreign_toplevel_handle_v1> | toplevel to get the window address for |
Get the window address for a toplevel.
get_window_for_toplevel_wlr(handle: new_id<hyprland_toplevel_window_mapping_handle_v1>, toplevel: object<zwlr_foreign_toplevel_handle_v1>)
Argument | Type | Description |
|---|---|---|
| handle | new_id<hyprland_toplevel_window_mapping_handle_v1> | |
| toplevel | object<zwlr_foreign_toplevel_handle_v1> | wlr toplevel to get the window address for |
Get the window address for a wlr toplevel.
destroy()
All objects created by the manager will still remain valid, until their appropriate destroy request has been called.
This object represents a mapping of a (wlr) toplevel to a window address.
Once created, the `window_address` event will be sent containing the address of the window associated with the toplevel. Should the mapping fail, the `failed` event will be sent.
destroy()
Destroy the handle. This request can be sent at any time by the client.
window_address(address_hi: uint, address: uint)
Argument | Type | Description |
|---|---|---|
| address_hi | uint | upper 32 bits of the window address |
| address | uint | lower 32 bits of the window address |
The full 64bit window address. The `address` field contains the lower 32 bits whilst the `address_hi` contains the upper 32 bits
failed()
The mapping of the toplevel to a window address failed. Most likely the window does not exist (anymore).
Compositor Support
Copyright
Copyright © 2025 WhySoBad All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.