diff options
| author | mac <ra@afu.re> | 2025-08-28 13:52:50 -0400 |
|---|---|---|
| committer | mac <ra@afu.re> | 2025-08-28 13:52:50 -0400 |
| commit | e55ead5328ac1216a585144d1fc56ffedf2d556c (patch) | |
| tree | 9514aa8f71996916daff301d16ece49ebeea3790 | |
| parent | ff7bfc16f67c9afd20ae65e9d0457fc6fbf1178f (diff) | |
cleanup
| -rw-r--r-- | .gitea/issue_template/bug_report.yml | 62 | ||||
| -rw-r--r-- | .gitea/issue_template/enhancement-idea.yml | 9 | ||||
| -rw-r--r-- | .mailmap | 3 | ||||
| -rw-r--r-- | protocols/dwl-ipc-unstable-v2.xml | 181 | ||||
| -rw-r--r-- | protocols/wlr-layer-shell-unstable-v1.xml | 390 | ||||
| -rw-r--r-- | protocols/wlr-output-power-management-unstable-v1.xml | 128 |
6 files changed, 0 insertions, 773 deletions
diff --git a/.gitea/issue_template/bug_report.yml b/.gitea/issue_template/bug_report.yml deleted file mode 100644 index 77ce108..0000000 --- a/.gitea/issue_template/bug_report.yml +++ /dev/null @@ -1,62 +0,0 @@ -name: Bug Report -about: Something in dwl isn't working correctly -title: -labels: - - 'Kind/Bug' -body: - - type: markdown - attributes: - value: | - - Only report bugs that can be reproduced on the main (or wlroots-next) branch without patches. - - Proprietary graphics drivers, including nvidia, are not supported. Please use the open source equivalents, such as nouveau, if you would like to use dwl. - - Report patch issues to their respective authors. - - - type: input - id: dwl_version - attributes: - label: 'dwl version:' - placeholder: '`dwl -v`' - validations: - required: true - - - type: input - id: wlroots_version - attributes: - label: 'wlroots version:' - validations: - required: true - - - type: input - id: distro - attributes: - label: What distro (and version) are you using? - validations: - required: false - - - type: textarea - attributes: - label: Description - value: | - The steps you took to reproduce the problem. - validations: - required: false - - - type: textarea - id: debug_log - attributes: - label: Debug Log - value: | - Run `dwl -d 2> ~/dwl.log` from a TTY and attach the **full** (do not truncate it) file here, or upload it to a pastebin. - Please try to keep the reproduction as brief as possible and exit dwl. - validations: - required: false - - - type: textarea - id: backtrace - attributes: - label: Stack Trace - value: | - - Only required if dwl crashes. - - If the lines mentioning dwl or wlroots have `??`. Please compile both dwl and wlroots from source (enabling debug symbols) and try to reproduce. - validations: - required: false diff --git a/.gitea/issue_template/enhancement-idea.yml b/.gitea/issue_template/enhancement-idea.yml deleted file mode 100644 index be1bbf2..0000000 --- a/.gitea/issue_template/enhancement-idea.yml +++ /dev/null @@ -1,9 +0,0 @@ -name: Enhancement idea -about: Suggest a feature or improvement -title: -labels: - - 'Kind/Feature' -body: - - type: textarea - attributes: - label: Description diff --git a/.mailmap b/.mailmap deleted file mode 100644 index 1778cb9..0000000 --- a/.mailmap +++ /dev/null @@ -1,3 +0,0 @@ -Lennart Jablonka <humm@ljabl.com> <hummsmith42@gmail.com> -Leonardo Hernández Hernández <leohdz172@proton.me> <leohdz172@outlook.com> -Leonardo Hernández Hernández <leohdz172@proton.me> <leohdz172@protonmail.com> diff --git a/protocols/dwl-ipc-unstable-v2.xml b/protocols/dwl-ipc-unstable-v2.xml deleted file mode 100644 index 0a6e7e5..0000000 --- a/protocols/dwl-ipc-unstable-v2.xml +++ /dev/null @@ -1,181 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- -This is largely ripped from somebar's ipc patchset; just with some personal modifications. -I would probably just submit raphi's patchset but I don't think that would be polite. ---> -<protocol name="dwl_ipc_unstable_v2"> - <description summary="inter-proccess-communication about dwl's state"> - This protocol allows clients to update and get updates from dwl. - - Warning! The protocol described in this file is experimental and - backward incompatible changes may be made. Backward compatible - changes may be added together with the corresponding interface - version bump. - Backward incompatible changes are done by bumping the version - number in the protocol and interface names and resetting the - interface version. Once the protocol is to be declared stable, - the 'z' prefix and the version number in the protocol and - interface names are removed and the interface version number is - reset. - </description> - - <interface name="zdwl_ipc_manager_v2" version="2"> - <description summary="manage dwl state"> - This interface is exposed as a global in wl_registry. - - Clients can use this interface to get a dwl_ipc_output. - After binding the client will recieve the dwl_ipc_manager.tags and dwl_ipc_manager.layout events. - The dwl_ipc_manager.tags and dwl_ipc_manager.layout events expose tags and layouts to the client. - </description> - - <request name="release" type="destructor"> - <description summary="release dwl_ipc_manager"> - Indicates that the client will not the dwl_ipc_manager object anymore. - Objects created through this instance are not affected. - </description> - </request> - - <request name="get_output"> - <description summary="get a dwl_ipc_outout for a wl_output"> - Get a dwl_ipc_outout for the specified wl_output. - </description> - <arg name="id" type="new_id" interface="zdwl_ipc_output_v2"/> - <arg name="output" type="object" interface="wl_output"/> - </request> - - <event name="tags"> - <description summary="Announces tag amount"> - This event is sent after binding. - A roundtrip after binding guarantees the client recieved all tags. - </description> - <arg name="amount" type="uint"/> - </event> - - <event name="layout"> - <description summary="Announces a layout"> - This event is sent after binding. - A roundtrip after binding guarantees the client recieved all layouts. - </description> - <arg name="name" type="string"/> - </event> - </interface> - - <interface name="zdwl_ipc_output_v2" version="2"> - <description summary="control dwl output"> - Observe and control a dwl output. - - Events are double-buffered: - Clients should cache events and redraw when a dwl_ipc_output.frame event is sent. - - Request are not double-buffered: - The compositor will update immediately upon request. - </description> - - <enum name="tag_state"> - <entry name="none" value="0" summary="no state"/> - <entry name="active" value="1" summary="tag is active"/> - <entry name="urgent" value="2" summary="tag has at least one urgent client"/> - </enum> - - <request name="release" type="destructor"> - <description summary="release dwl_ipc_outout"> - Indicates to that the client no longer needs this dwl_ipc_output. - </description> - </request> - - <event name="toggle_visibility"> - <description summary="Toggle client visibilty"> - Indicates the client should hide or show themselves. - If the client is visible then hide, if hidden then show. - </description> - </event> - - <event name="active"> - <description summary="Update the selected output."> - Indicates if the output is active. Zero is invalid, nonzero is valid. - </description> - <arg name="active" type="uint"/> - </event> - - <event name="tag"> - <description summary="Update the state of a tag."> - Indicates that a tag has been updated. - </description> - <arg name="tag" type="uint" summary="Index of the tag"/> - <arg name="state" type="uint" enum="tag_state" summary="The state of the tag."/> - <arg name="clients" type="uint" summary="The number of clients in the tag."/> - <arg name="focused" type="uint" summary="If there is a focused client. Nonzero being valid, zero being invalid."/> - </event> - - <event name="layout"> - <description summary="Update the layout."> - Indicates a new layout is selected. - </description> - <arg name="layout" type="uint" summary="Index of the layout."/> - </event> - - <event name="title"> - <description summary="Update the title."> - Indicates the title has changed. - </description> - <arg name="title" type="string" summary="The new title name."/> - </event> - - <event name="appid" since="1"> - <description summary="Update the appid."> - Indicates the appid has changed. - </description> - <arg name="appid" type="string" summary="The new appid."/> - </event> - - <event name="layout_symbol" since="1"> - <description summary="Update the current layout symbol"> - Indicates the layout has changed. Since layout symbols are dynamic. - As opposed to the zdwl_ipc_manager.layout event, this should take precendence when displaying. - You can ignore the zdwl_ipc_output.layout event. - </description> - <arg name="layout" type="string" summary="The new layout"/> - </event> - - <event name="frame"> - <description summary="The update sequence is done."> - Indicates that a sequence of status updates have finished and the client should redraw. - </description> - </event> - - <request name="set_tags"> - <description summary="Set the active tags of this output"/> - <arg name="tagmask" type="uint" summary="bitmask of the tags that should be set."/> - <arg name="toggle_tagset" type="uint" summary="toggle the selected tagset, zero for invalid, nonzero for valid."/> - </request> - - <request name="set_client_tags"> - <description summary="Set the tags of the focused client."> - The tags are updated as follows: - new_tags = (current_tags AND and_tags) XOR xor_tags - </description> - <arg name="and_tags" type="uint"/> - <arg name="xor_tags" type="uint"/> - </request> - - <request name="set_layout"> - <description summary="Set the layout of this output"/> - <arg name="index" type="uint" summary="index of a layout recieved by dwl_ipc_manager.layout"/> - </request> - - <!-- Version 2 --> - <event name="fullscreen" since="2"> - <description summary="Update fullscreen status"> - Indicates if the selected client on this output is fullscreen. - </description> - <arg name="is_fullscreen" type="uint" summary="If the selected client is fullscreen. Nonzero is valid, zero invalid"/> - </event> - - <event name="floating" since="2"> - <description summary="Update the floating status"> - Indicates if the selected client on this output is floating. - </description> - <arg name="is_floating" type="uint" summary="If the selected client is floating. Nonzero is valid, zero invalid"/> - </event> - </interface> -</protocol> diff --git a/protocols/wlr-layer-shell-unstable-v1.xml b/protocols/wlr-layer-shell-unstable-v1.xml deleted file mode 100644 index d62fd51..0000000 --- a/protocols/wlr-layer-shell-unstable-v1.xml +++ /dev/null @@ -1,390 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<protocol name="wlr_layer_shell_unstable_v1"> - <copyright> - Copyright © 2017 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. - </copyright> - - <interface name="zwlr_layer_shell_v1" version="4"> - <description summary="create surfaces that are layers of the desktop"> - Clients can use this interface to assign the surface_layer role to - wl_surfaces. Such surfaces are assigned to a "layer" of the output and - rendered with a defined z-depth respective to each other. They may also be - anchored to the edges and corners of a screen and specify input handling - semantics. This interface should be suitable for the implementation of - many desktop shell components, and a broad number of other applications - that interact with the desktop. - </description> - - <request name="get_layer_surface"> - <description summary="create a layer_surface from a surface"> - Create a layer surface for an existing surface. This assigns the role of - layer_surface, or raises a protocol error if another role is already - assigned. - - Creating a layer surface from a wl_surface which has a buffer attached - or committed is a client error, and any attempts by a client to attach - or manipulate a buffer prior to the first layer_surface.configure call - must also be treated as errors. - - After creating a layer_surface object and setting it up, the client - must perform an initial commit without any buffer attached. - The compositor will reply with a layer_surface.configure event. - The client must acknowledge it and is then allowed to attach a buffer - to map the surface. - - You may pass NULL for output to allow the compositor to decide which - output to use. Generally this will be the one that the user most - recently interacted with. - - Clients can specify a namespace that defines the purpose of the layer - surface. - </description> - <arg name="id" type="new_id" interface="zwlr_layer_surface_v1"/> - <arg name="surface" type="object" interface="wl_surface"/> - <arg name="output" type="object" interface="wl_output" allow-null="true"/> - <arg name="layer" type="uint" enum="layer" summary="layer to add this surface to"/> - <arg name="namespace" type="string" summary="namespace for the layer surface"/> - </request> - - <enum name="error"> - <entry name="role" value="0" summary="wl_surface has another role"/> - <entry name="invalid_layer" value="1" summary="layer value is invalid"/> - <entry name="already_constructed" value="2" summary="wl_surface has a buffer attached or committed"/> - </enum> - - <enum name="layer"> - <description summary="available layers for surfaces"> - These values indicate which layers a surface can be rendered in. They - are ordered by z depth, bottom-most first. Traditional shell surfaces - will typically be rendered between the bottom and top layers. - Fullscreen shell surfaces are typically rendered at the top layer. - Multiple surfaces can share a single layer, and ordering within a - single layer is undefined. - </description> - - <entry name="background" value="0"/> - <entry name="bottom" value="1"/> - <entry name="top" value="2"/> - <entry name="overlay" value="3"/> - </enum> - - <!-- Version 3 additions --> - - <request name="destroy" type="destructor" since="3"> - <description summary="destroy the layer_shell object"> - This request indicates that the client will not use the layer_shell - object any more. Objects that have been created through this instance - are not affected. - </description> - </request> - </interface> - - <interface name="zwlr_layer_surface_v1" version="4"> - <description summary="layer metadata interface"> - An interface that may be implemented by a wl_surface, for surfaces that - are designed to be rendered as a layer of a stacked desktop-like - environment. - - Layer surface state (layer, size, anchor, exclusive zone, - margin, interactivity) is double-buffered, and will be applied at the - time wl_surface.commit of the corresponding wl_surface is called. - - Attaching a null buffer to a layer surface unmaps it. - - Unmapping a layer_surface means that the surface cannot be shown by the - compositor until it is explicitly mapped again. The layer_surface - returns to the state it had right after layer_shell.get_layer_surface. - The client can re-map the surface by performing a commit without any - buffer attached, waiting for a configure event and handling it as usual. - </description> - - <request name="set_size"> - <description summary="sets the size of the surface"> - Sets the size of the surface in surface-local coordinates. The - compositor will display the surface centered with respect to its - anchors. - - If you pass 0 for either value, the compositor will assign it and - inform you of the assignment in the configure event. You must set your - anchor to opposite edges in the dimensions you omit; not doing so is a - protocol error. Both values are 0 by default. - - Size is double-buffered, see wl_surface.commit. - </description> - <arg name="width" type="uint"/> - <arg name="height" type="uint"/> - </request> - - <request name="set_anchor"> - <description summary="configures the anchor point of the surface"> - Requests that the compositor anchor the surface to the specified edges - and corners. If two orthogonal edges are specified (e.g. 'top' and - 'left'), then the anchor point will be the intersection of the edges - (e.g. the top left corner of the output); otherwise the anchor point - will be centered on that edge, or in the center if none is specified. - - Anchor is double-buffered, see wl_surface.commit. - </description> - <arg name="anchor" type="uint" enum="anchor"/> - </request> - - <request name="set_exclusive_zone"> - <description summary="configures the exclusive geometry of this surface"> - Requests that the compositor avoids occluding an area with other - surfaces. The compositor's use of this information is - implementation-dependent - do not assume that this region will not - actually be occluded. - - A positive value is only meaningful if the surface is anchored to one - edge or an edge and both perpendicular edges. If the surface is not - anchored, anchored to only two perpendicular edges (a corner), anchored - to only two parallel edges or anchored to all edges, a positive value - will be treated the same as zero. - - A positive zone is the distance from the edge in surface-local - coordinates to consider exclusive. - - Surfaces that do not wish to have an exclusive zone may instead specify - how they should interact with surfaces that do. If set to zero, the - surface indicates that it would like to be moved to avoid occluding - surfaces with a positive exclusive zone. If set to -1, the surface - indicates that it would not like to be moved to accommodate for other - surfaces, and the compositor should extend it all the way to the edges - it is anchored to. - - For example, a panel might set its exclusive zone to 10, so that - maximized shell surfaces are not shown on top of it. A notification - might set its exclusive zone to 0, so that it is moved to avoid - occluding the panel, but shell surfaces are shown underneath it. A - wallpaper or lock screen might set their exclusive zone to -1, so that - they stretch below or over the panel. - - The default value is 0. - - Exclusive zone is double-buffered, see wl_surface.commit. - </description> - <arg name="zone" type="int"/> - </request> - - <request name="set_margin"> - <description summary="sets a margin from the anchor point"> - Requests that the surface be placed some distance away from the anchor - point on the output, in surface-local coordinates. Setting this value - for edges you are not anchored to has no effect. - - The exclusive zone includes the margin. - - Margin is double-buffered, see wl_surface.commit. - </description> - <arg name="top" type="int"/> - <arg name="right" type="int"/> - <arg name="bottom" type="int"/> - <arg name="left" type="int"/> - </request> - - <enum name="keyboard_interactivity"> - <description summary="types of keyboard interaction possible for a layer shell surface"> - Types of keyboard interaction possible for layer shell surfaces. The - rationale for this is twofold: (1) some applications are not interested - in keyboard events and not allowing them to be focused can improve the - desktop experience; (2) some applications will want to take exclusive - keyboard focus. - </description> - - <entry name="none" value="0"> - <description summary="no keyboard focus is possible"> - This value indicates that this surface is not interested in keyboard - events and the compositor should never assign it the keyboard focus. - - This is the default value, set for newly created layer shell surfaces. - - This is useful for e.g. desktop widgets that display information or - only have interaction with non-keyboard input devices. - </description> - </entry> - <entry name="exclusive" value="1"> - <description summary="request exclusive keyboard focus"> - Request exclusive keyboard focus if this surface is above the shell surface layer. - - For the top and overlay layers, the seat will always give - exclusive keyboard focus to the top-most layer which has keyboard - interactivity set to exclusive. If this layer contains multiple - surfaces with keyboard interactivity set to exclusive, the compositor - determines the one receiving keyboard events in an implementation- - defined manner. In this case, no guarantee is made when this surface - will receive keyboard focus (if ever). - - For the bottom and background layers, the compositor is allowed to use - normal focus semantics. - - This setting is mainly intended for applications that need to ensure - they receive all keyboard events, such as a lock screen or a password - prompt. - </description> - </entry> - <entry name="on_demand" value="2" since="4"> - <description summary="request regular keyboard focus semantics"> - This requests the compositor to allow this surface to be focused and - unfocused by the user in an implementation-defined manner. The user - should be able to unfocus this surface even regardless of the layer - it is on. - - Typically, the compositor will want to use its normal mechanism to - manage keyboard focus between layer shell surfaces with this setting - and regular toplevels on the desktop layer (e.g. click to focus). - Nevertheless, it is possible for a compositor to require a special - interaction to focus or unfocus layer shell surfaces (e.g. requiring - a click even if focus follows the mouse normally, or providing a - keybinding to switch focus between layers). - - This setting is mainly intended for desktop shell components (e.g. - panels) that allow keyboard interaction. Using this option can allow - implementing a desktop shell that can be fully usable without the - mouse. - </description> - </entry> - </enum> - - <request name="set_keyboard_interactivity"> - <description summary="requests keyboard events"> - Set how keyboard events are delivered to this surface. By default, - layer shell surfaces do not receive keyboard events; this request can - be used to change this. - - This setting is inherited by child surfaces set by the get_popup - request. - - Layer surfaces receive pointer, touch, and tablet events normally. If - you do not want to receive them, set the input region on your surface - to an empty region. - - Keyboard interactivity is double-buffered, see wl_surface.commit. - </description> - <arg name="keyboard_interactivity" type="uint" enum="keyboard_interactivity"/> - </request> - - <request name="get_popup"> - <description summary="assign this layer_surface as an xdg_popup parent"> - This assigns an xdg_popup's parent to this layer_surface. This popup - should have been created via xdg_surface::get_popup with the parent set - to NULL, and this request must be invoked before committing the popup's - initial state. - - See the documentation of xdg_popup for more details about what an - xdg_popup is and how it is used. - </description> - <arg name="popup" type="object" interface="xdg_popup"/> - </request> - - <request name="ack_configure"> - <description summary="ack a configure event"> - When a configure event is received, if a client commits the - surface in response to the configure event, then the client - must make an ack_configure request sometime before the commit - request, passing along the serial of the configure event. - - If the client receives multiple configure events before it - can respond to one, it only has to ack the last configure event. - - A client is not required to commit immediately after sending - an ack_configure request - it may even ack_configure several times - before its next surface commit. - - A client may send multiple ack_configure requests before committing, but - only the last request sent before a commit indicates which configure - event the client really is responding to. - </description> - <arg name="serial" type="uint" summary="the serial from the configure event"/> - </request> - - <request name="destroy" type="destructor"> - <description summary="destroy the layer_surface"> - This request destroys the layer surface. - </description> - </request> - - <event name="configure"> - <description summary="suggest a surface change"> - The configure event asks the client to resize its surface. - - Clients should arrange their surface for the new states, and then send - an ack_configure request with the serial sent in this configure event at - some point before committing the new surface. - - The client is free to dismiss all but the last configure event it - received. - - The width and height arguments specify the size of the window in - surface-local coordinates. - - The size is a hint, in the sense that the client is free to ignore it if - it doesn't resize, pick a smaller size (to satisfy aspect ratio or - resize in steps of NxM pixels). If the client picks a smaller size and - is anchored to two opposite anchors (e.g. 'top' and 'bottom'), the - surface will be centered on this axis. - - If the width or height arguments are zero, it means the client should - decide its own window dimension. - </description> - <arg name="serial" type="uint"/> - <arg name="width" type="uint"/> - <arg name="height" type="uint"/> - </event> - - <event name="closed"> - <description summary="surface should be closed"> - The closed event is sent by the compositor when the surface will no - longer be shown. The output may have been destroyed or the user may - have asked for it to be removed. Further changes to the surface will be - ignored. The client should destroy the resource after receiving this - event, and create a new surface if they so choose. - </description> - </event> - - <enum name="error"> - <entry name="invalid_surface_state" value="0" summary="provided surface state is invalid"/> - <entry name="invalid_size" value="1" summary="size is invalid"/> - <entry name="invalid_anchor" value="2" summary="anchor bitfield is invalid"/> - <entry name="invalid_keyboard_interactivity" value="3" summary="keyboard interactivity is invalid"/> - </enum> - - <enum name="anchor" bitfield="true"> - <entry name="top" value="1" summary="the top edge of the anchor rectangle"/> - <entry name="bottom" value="2" summary="the bottom edge of the anchor rectangle"/> - <entry name="left" value="4" summary="the left edge of the anchor rectangle"/> - <entry name="right" value="8" summary="the right edge of the anchor rectangle"/> - </enum> - - <!-- Version 2 additions --> - - <request name="set_layer" since="2"> - <description summary="change the layer of the surface"> - Change the layer that the surface is rendered on. - - Layer is double-buffered, see wl_surface.commit. - </description> - <arg name="layer" type="uint" enum="zwlr_layer_shell_v1.layer" summary="layer to move this surface to"/> - </request> - </interface> -</protocol> diff --git a/protocols/wlr-output-power-management-unstable-v1.xml b/protocols/wlr-output-power-management-unstable-v1.xml deleted file mode 100644 index a977839..0000000 --- a/protocols/wlr-output-power-management-unstable-v1.xml +++ /dev/null @@ -1,128 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<protocol name="wlr_output_power_management_unstable_v1"> - <copyright> - Copyright © 2019 Purism SPC - - Permission is hereby granted, free of charge, to any person obtaining a - copy of this software and associated documentation files (the "Software"), - to deal in the Software without restriction, including without limitation - the rights to use, copy, modify, merge, publish, distribute, sublicense, - and/or sell copies of the Software, and to permit persons to whom the - Software is furnished to do so, subject to the following conditions: - - The above copyright notice and this permission notice (including the next - paragraph) shall be included in all copies or substantial portions of the - Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL - THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING - FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER - DEALINGS IN THE SOFTWARE. - </copyright> - - <description summary="Control power management modes of outputs"> - This protocol allows clients to control power management modes - of outputs that are currently part of the compositor space. The - intent is to allow special clients like desktop shells to power - down outputs when the system is idle. - - To modify outputs not currently part of the compositor space see - wlr-output-management. - - Warning! The protocol described in this file is experimental and - backward incompatible changes may be made. Backward compatible changes - may be added together with the corresponding interface version bump. - Backward incompatible changes are done by bumping the version number in - the protocol and interface names and resetting the interface version. - Once the protocol is to be declared stable, the 'z' prefix and the - version number in the protocol and interface names are removed and the - interface version number is reset. - </description> - - <interface name="zwlr_output_power_manager_v1" version="1"> - <description summary="manager to create per-output power management"> - This interface is a manager that allows creating per-output power - management mode controls. - </description> - - <request name="get_output_power"> - <description summary="get a power management for an output"> - Create a output power management mode control that can be used to - adjust the power management mode for a given output. - </description> - <arg name="id" type="new_id" interface="zwlr_output_power_v1"/> - <arg name="output" type="object" interface="wl_output"/> - </request> - - <request name="destroy" type="destructor"> - <description summary="destroy the manager"> - All objects created by the manager will still remain valid, until their - appropriate destroy request has been called. - </description> - </request> - </interface> - - <interface name="zwlr_output_power_v1" version="1"> - <description summary="adjust power management mode for an output"> - This object offers requests to set the power management mode of - an output. - </description> - - <enum name="mode"> - <entry name="off" value="0" - summary="Output is turned off."/> - <entry name="on" value="1" - summary="Output is turned on, no power saving"/> - </enum> - - <enum name="error"> - <entry name="invalid_mode" value="1" summary="inexistent power save mode"/> - </enum> - - <request name="set_mode"> - <description summary="Set an outputs power save mode"> - Set an output's power save mode to the given mode. The mode change - is effective immediately. If the output does not support the given - mode a failed event is sent. - </description> - <arg name="mode" type="uint" enum="mode" summary="the power save mode to set"/> - </request> - - <event name="mode"> - <description summary="Report a power management mode change"> - Report the power management mode change of an output. - - The mode event is sent after an output changed its power - management mode. The reason can be a client using set_mode or the - compositor deciding to change an output's mode. - This event is also sent immediately when the object is created - so the client is informed about the current power management mode. - </description> - <arg name="mode" type="uint" enum="mode" - summary="the output's new power management mode"/> - </event> - - <event name="failed"> - <description summary="object no longer valid"> - This event indicates that the output power management mode control - is no longer valid. This can happen for a number of reasons, - including: - - The output doesn't support power management - - Another client already has exclusive power management mode control - for this output - - The output disappeared - - Upon receiving this event, the client should destroy this object. - </description> - </event> - - <request name="destroy" type="destructor"> - <description summary="destroy this power management"> - Destroys the output power management mode control object. - </description> - </request> - </interface> -</protocol> |
