31 lines
No EOL
11 KiB
HTML
31 lines
No EOL
11 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Generic wayland protocols"><title>cosmic::cctk::sctk::reexports::protocols::wp - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../../static.files/rustdoc-aa0817cf.css"><meta name="rustdoc-vars" data-root-path="../../../../../../" data-static-root-path="../../../../../../static.files/" data-current-crate="cosmic" data-themes="" data-resource-suffix="" data-rustdoc-version="1.90.0-nightly (3048886e5 2025-07-30)" data-channel="nightly" data-search-js="search-fa3e91e5.js" data-settings-js="settings-5514c975.js" ><script src="../../../../../../static.files/storage-68b7e25d.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../../../../static.files/main-eebb9057.js"></script><noscript><link rel="stylesheet" href="../../../../../../static.files/noscript-32bb7600.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../../../cosmic/index.html">cosmic</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module wp</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In cosmic::<wbr>cctk::<wbr>sctk::<wbr>reexports::<wbr>protocols</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../../../../index.html">cosmic</a>::<wbr><a href="../../../../index.html">cctk</a>::<wbr><a href="../../../index.html">sctk</a>::<wbr><a href="../../index.html">reexports</a>::<wbr><a href="../index.html">protocols</a></div><h1>Module <span>wp</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>wayland</code> and Linux</strong> only.</div></span><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Generic wayland protocols</p>
|
||
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="alpha_modifier/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::alpha_modifier">alpha_<wbr>modifier</a></dt><dd>This interface allows a client to set a factor for the alpha values on a
|
||
surface, which can be used to offload such operations to the compositor,
|
||
which can in turn for example offload them to KMS.</dd><dt><a class="mod" href="color_management/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::color_management">color_<wbr>management</a></dt><dd>The aim of the color management extension is to allow clients to know
|
||
the color properties of outputs, and to tell the compositor about the color
|
||
properties of their content on surfaces. Doing this enables a compositor
|
||
to perform automatic color management of content for different outputs
|
||
according to how content is intended to look like.</dd><dt><a class="mod" href="color_representation/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::color_representation">color_<wbr>representation</a></dt><dd>This protocol extension delivers the metadata required to define alpha mode,
|
||
the color model, sub-sampling and quantization range used when interpreting
|
||
buffer contents. The main use case is defining how the YCbCr family of pixel
|
||
formats convert to RGB.</dd><dt><a class="mod" href="commit_timing/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::commit_timing">commit_<wbr>timing</a></dt><dd>When a compositor latches on to new content updates it will check for
|
||
any number of requirements of the available content updates (such as
|
||
fences of all buffers being signalled) to consider the update ready.</dd><dt><a class="mod" href="content_type/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::content_type">content_<wbr>type</a></dt><dd>This protocol allows a client to describe the kind of content a surface
|
||
will display, to allow the compositor to optimize its behavior for it.</dd><dt><a class="mod" href="cursor_shape/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::cursor_shape">cursor_<wbr>shape</a></dt><dd>This protocol extension offers a simpler way for clients to set a cursor.</dd><dt><a class="mod" href="drm_lease/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::drm_lease">drm_<wbr>lease</a></dt><dd>This protocol is used by Wayland compositors which act as Direct
|
||
Renderering Manager (DRM) masters to lease DRM resources to Wayland
|
||
clients.</dd><dt><a class="mod" href="fifo/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::fifo">fifo</a></dt><dd>When a Wayland compositor considers applying a content update,
|
||
it must ensure all the update’s readiness constraints (fences, etc)
|
||
are met.</dd><dt><a class="mod" href="fractional_scale/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::fractional_scale">fractional_<wbr>scale</a></dt><dd>This protocol allows a compositor to suggest for surfaces to render at
|
||
fractional scales.</dd><dt><a class="mod" href="fullscreen_shell/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::fullscreen_shell">fullscreen_<wbr>shell</a></dt><dd>Fullscreen shell protocol</dd><dt><a class="mod" href="idle_inhibit/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::idle_inhibit">idle_<wbr>inhibit</a></dt><dd>Screensaver inhibition protocol</dd><dt><a class="mod" href="input_method/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::input_method">input_<wbr>method</a></dt><dd>Input method protocol</dd><dt><a class="mod" href="input_timestamps/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::input_timestamps">input_<wbr>timestamps</a></dt><dd>Input timestamps protocol</dd><dt><a class="mod" href="keyboard_shortcuts_inhibit/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::keyboard_shortcuts_inhibit">keyboard_<wbr>shortcuts_<wbr>inhibit</a></dt><dd>Protocol for inhibiting the compositor keyboard shortcuts</dd><dt><a class="mod" href="linux_dmabuf/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::linux_dmabuf">linux_<wbr>dmabuf</a></dt><dd>Linux DMA-BUF protocol</dd><dt><a class="mod" href="linux_drm_syncobj/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::linux_drm_syncobj">linux_<wbr>drm_<wbr>syncobj</a></dt><dd>This protocol allows clients to request explicit synchronization for
|
||
buffers. It is tied to the Linux DRM synchronization object framework.</dd><dt><a class="mod" href="linux_explicit_synchronization/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::linux_explicit_synchronization">linux_<wbr>explicit_<wbr>synchronization</a></dt><dd>Linux explicit synchronization protocol</dd><dt><a class="mod" href="pointer_constraints/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::pointer_constraints">pointer_<wbr>constraints</a></dt><dd>protocol for constraining pointer motions</dd><dt><a class="mod" href="pointer_gestures/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::pointer_gestures">pointer_<wbr>gestures</a></dt><dd>Pointer gestures protocol</dd><dt><a class="mod" href="pointer_warp/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::pointer_warp">pointer_<wbr>warp</a></dt><dd>This global interface allows applications to request the pointer to be
|
||
moved to a position relative to a wl_surface.
|
||
Note that if the desired behavior is to constrain the pointer to an area
|
||
or lock it to a position, this protocol does not provide a reliable way
|
||
to do that. The pointer constraint and pointer lock protocols should be
|
||
used for those use cases instead.
|
||
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.</dd><dt><a class="mod" href="presentation_time/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::presentation_time">presentation_<wbr>time</a></dt><dd>Presentation time protocol</dd><dt><a class="mod" href="primary_selection/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::primary_selection">primary_<wbr>selection</a></dt><dd>Primary selection protocol</dd><dt><a class="mod" href="relative_pointer/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::relative_pointer">relative_<wbr>pointer</a></dt><dd>protocol for relative pointer motion events</dd><dt><a class="mod" href="security_context/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::security_context">security_<wbr>context</a></dt><dd>This interface allows a client to register a new Wayland connection to
|
||
the compositor and attach a security context to it.</dd><dt><a class="mod" href="single_pixel_buffer/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::single_pixel_buffer">single_<wbr>pixel_<wbr>buffer</a></dt><dd>This protocol extension allows clients to create single-pixel buffers.</dd><dt><a class="mod" href="tablet/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::tablet">tablet</a></dt><dd>Wayland protocol for graphics tablets</dd><dt><a class="mod" href="tearing_control/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::tearing_control">tearing_<wbr>control</a></dt><dd>This protocol provides a way for clients to indicate whether
|
||
or not their content is suitable for this kind of presentation.</dd><dt><a class="mod" href="text_input/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::text_input">text_<wbr>input</a></dt><dd>Text input protocol</dd><dt><a class="mod" href="viewporter/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp::viewporter">viewporter</a></dt><dd>Viewporter protocol</dd></dl></section></div></main></body></html> |