surface content type manager
Interface
Version 1
This interface allows a client to describe the kind of content a surface
will display, to allow the compositor to optimize its behavior for it.
Warning! The protocol described in this file is currently in the testing
phase. Backward compatible changes may be added together with the
corresponding interface version bump. Backward incompatible changes can
only be done by creating a new major version of the extension.
destroy the content type manager object
Destructor
Request
Since Version 1
Destroy the content type manager. This doesn't destroy objects created
with the manager.
create a new content type object
Request
Since Version 1
Create a new content type object associated with the given surface.
Creating a wp_content_type_v1 from a wl_surface which already has one
attached is a client error: already_constructed.
| Entry | Value | Since | Description |
|---|
| already_constructed | 0 | 1 | wl_surface already has a content type object |
content type object for a surface
Interface
Version 1
The content type object allows the compositor to optimize for the kind
of content shown on the surface. A compositor may for example use it to
set relevant drm properties like "content type".
The client may request to switch to another content type at any time.
When the associated surface gets destroyed, this object becomes inert and
the client should destroy it.
destroy the content type object
Destructor
Request
Since Version 1
Switch back to not specifying the content type of this surface. This is
equivalent to setting the content type to none, including double
buffering semantics. See set_content_type for details.
Set the surface content type. This informs the compositor that the
client believes it is displaying buffers matching this content type.
This is purely a hint for the compositor, which can be used to adjust
its behavior or hardware settings to fit the presented content best.
The content type is double-buffered state, see wl_surface.commit for
details.
| Argument | Type | Description |
|---|
| content_type | uint<type> | the content type |
These values describe the available content types for a surface.
| Entry | Value | Since | Description |
|---|
| none | 0 | 1 | no content type applies The content type none means that either the application has no data
about the content type, or that the content doesn't fit into one of
the other categories. |
| photo | 1 | 1 | photo content type The content type photo describes content derived from digital still
pictures and may be presented with minimal processing. |
| video | 2 | 1 | video content type The content type video describes a video or animation and may be
presented with more accurate timing to avoid stutter. Where scaling
is needed, scaling methods more appropriate for video may be used. |
| game | 3 | 1 | game content type The content type game describes a running game. Its content may be
presented with reduced latency. |
Copyright
Copyright © 2021 Emmanuel Gil Peyrot
Copyright © 2022 Xaver Hugl
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.