sensitive_content_v1
This protocol allows clients to tag wl_surface(s) or wl_region(s), as sensitive with a specific type. This tag serves as a hint for the compositor to perform actions based on it. Whether the compositor takes action based on the tag is compositor policy. By default, compositors should blur, black out, or otherwise obscure tagged surfaces and regions in screen captures. Additionally, privacy screen features may be toggled based on this tag. Features like these should be overridable by the user.
This document adheres to RFC 2119 when using words like "must", "should", "may", etc.
Warning! The protocol described in this file is experimental and may change in future revisions. Backward-compatible changes may be introduced with a version bump. Incompatible changes require a new major version.
wp_sensitive_content_manager_v1
This interface allows clients to inform the compositor whether they contain sensitive information. Each tagged surface or region can include metadata describing the type of sensitive content.
destroy()
Destroy the manager object. Objects created by this manager are unaffected.
get_surface_sensitive_content(id: new_id<wp_sensitive_content_v1>, surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| id | new_id<wp_sensitive_content_v1> | |
| surface | object<wl_surface> |
Create a new sensitive content object associated with a given surface.
If a surface already has an wp_sensitive_content_v1 attached, the already_constructed error must be raised.
error { already_constructed }
Argument | Value | Description |
|---|---|---|
| already_constructed | 0 | the surface or region already has a sensitive content object |
wp_sensitive_content_v1
This interface allows a client to tag a surface or region as sensitive.
Clients must specify the type of sensitive content (e.g., personal, adult) using an enum.
destroy()
Destroy this extension object. The surface and all regions will no longer be tagged as sensitive and handled as such.
set_sensitive_surface(id: new_id, type: uint<wp_sensitive_content_v1.type>)
Argument | Type | Description |
|---|---|---|
| id | new_id | id associated with the surface |
| type | uint<wp_sensitive_content_v1.type> | type of sensitive content |
Note
Keep in mind that new_id without defined interface has custom serialization rules
Tag a surface as sensitive.
It is not an error to call this request on a surface already tagged as sensitive.
add_sensitive_region(id: new_id)
Argument | Type | Description |
|---|---|---|
| id | new_id | id associated with the region |
Note
Keep in mind that new_id without defined interface has custom serialization rules
Tag a specific region of a surface as sensitive.
The sensitive region is specified in the surface-local coordinates.
If the specified region is invalid or out of bounds, the invalid_region error must be raised.
The initial value for the sensitive region is empty. Setting the pending sensitive region has copy semantics, and the wl_region object can be destroyed immediately. A NULL wl_region causes the sensitive region to be set to infinite.
It is not an error to call this request on a region already tagged as sensitive.
error { invalid_region }
Argument | Value | Description |
|---|---|---|
| invalid_region | 0 | specified region is invalid or out of bounds |
type { unspecified, personal, adult }
Argument | Value | Description |
|---|---|---|
| unspecified | 0 | no sensitive content type specified This value indicates that the content of the area is unknown, or unspecified. |
| personal | 1 | area contains personal content This value indicates that the area contains personal information, such as names, addresses, phone numbers, or other personal details. |
| adult | 2 | area contains adult content This value indicates that the area contains adult content, such as violence, sexual content, drugs, gambling, or other adult material. |
These values specify the type of sensitive content in a tagged surface or region.
Compositor Support
Copyright
Copyright © 2025 (TBD)
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.