COSMIC a11y
This protocols provides way to toggle various accessibility features in the COSMIC desktop environment for shell components.
cosmic_a11y_manager_v1
Manager to toggle accessibility features.
set_magnifier(active: uint<cosmic_a11y_manager_v1.active_state>)
Argument | Type | Description |
|---|---|---|
| active | uint<cosmic_a11y_manager_v1.active_state> | If the screen magnifier should be enabled |
Sets the state of the screen magnifier.
The client must not assume any requested changes are actually applied and should wait until the next magnifier event before updating it's UI.
set_screen_filter(inverted: uint<cosmic_a11y_manager_v1.active_state>, filter: uint<cosmic_a11y_manager_v1.filter>)
Argument | Type | Description |
|---|---|---|
| inverted | uint<cosmic_a11y_manager_v1.active_state> | If the screen colors should be inverted |
| filter | uint<cosmic_a11y_manager_v1.filter> | Which if any filter should be used |
Set the parameters for screen filtering.
If the filter is set to unknown, the compositor MUST not change the current state of the filter. This is to allow clients to update the inverted state, even if they don't know about the current active filter.
The client must not assume any requested changes are actually applied and should wait until the next screen_filter event before updating it's UI.
Send this request will raised a "deprecated" protocol error, if version 3 or higher was bound. Use `set_screen_filter2` instead.
set_screen_filter2(inverted: uint<cosmic_a11y_manager_v1.active_state>, filter: uint<cosmic_a11y_manager_v1.filter>, filter_state: uint<cosmic_a11y_manager_v1.active_state>)
Argument | Type | Description |
|---|---|---|
| inverted | uint<cosmic_a11y_manager_v1.active_state> | If the screen colors should be inverted |
| filter | uint<cosmic_a11y_manager_v1.filter> | Which if filter should be used |
| filter_state | uint<cosmic_a11y_manager_v1.active_state> | If the screen filter should be active |
Set the parameters for screen filtering.
If the filter is set to unknown, the compositor MUST not change the currently set filter. This is to allow clients to update the inverted state or toggle the screen filter, even if they don't know about the currently selected filter.
The client must not assume any requested changes are actually applied and should wait until the next screen_filter event before updating it's UI.
The "deprecated" protocol error is raised, if "disabled" is set for "filter".
magnifier(active: uint<cosmic_a11y_manager_v1.active_state>)
Argument | Type | Description |
|---|---|---|
| active | uint<cosmic_a11y_manager_v1.active_state> | If the screen magnifier is enabled |
State of the screen magnifier.
This event will be emitted by the compositor when binding the protocol and whenever the state changes.
screen_filter(inverted: uint<cosmic_a11y_manager_v1.active_state>, filter: uint<cosmic_a11y_manager_v1.filter>)
Argument | Type | Description |
|---|---|---|
| inverted | uint<cosmic_a11y_manager_v1.active_state> | If the screen colors are inverted |
| filter | uint<cosmic_a11y_manager_v1.filter> | Which if any screen filter is enabled |
Parameters used for screen filtering.
This event will be emitted by the compositor when binding the protocol and whenever the state changes.
If a screen filter is used not known to the protocol or the bound version filter will be set to unknown.
Since version 3 this event will not be emitted anymore, instead use `screen_filter2`.
screen_filter2(inverted: uint<cosmic_a11y_manager_v1.active_state>, filter: uint<cosmic_a11y_manager_v1.filter>, filter_state: uint<cosmic_a11y_manager_v1.active_state>)
Argument | Type | Description |
|---|---|---|
| inverted | uint<cosmic_a11y_manager_v1.active_state> | If the screen colors are inverted |
| filter | uint<cosmic_a11y_manager_v1.filter> | Which if any screen filter is selected |
| filter_state | uint<cosmic_a11y_manager_v1.active_state> | If the screen filter is active |
Parameters used for screen filtering.
This event will be emitted by the compositor when binding the protocol and whenever the state changes.
If a screen filter is used not known to the protocol or the bound version filter will be set to unknown.
The compositor must never send "disabled" as the "filter" argument.
filter { disabled, unknown, greyscale, daltonize_protanopia, daltonize_deuteranopia, daltonize_tritanopia }
Argument | Value | Description |
|---|---|---|
| disabledDeprecated since 3 | 0 | No screen filter is set |
| unknown | 1 | A custom or unknown screen filter |
| greyscale | 2 | Greyscale colors |
| daltonize_protanopia | 3 | Daltonize for Protanopia |
| daltonize_deuteranopia | 4 | Daltonize for Deuteranopia |
| daltonize_tritanopia | 5 | Daltonize for Tritanopia |
error { deprecated }
Argument | Value | Description |
|---|---|---|
| deprecated | 0 | A deprecated request or value was used |
Compositor Support
Mutter  | KWin  | Sway  | COSMIC  | Hyprland  | niri | Weston  | Labwc  | Cage  | Wayfire  | GameScope  | Jay | Mir  | Treeland  | Louvre  | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| cosmic_a11y_manager_v1 | x | x | x | 2 | x | x | x | x | x | x | x | x | x | x | x |
Copyright
Copyright © 2025 System76
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.