35 lines
No EOL
7.8 KiB
HTML
35 lines
No EOL
7.8 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="This crate provides bindings to the official wayland protocol extensions provided in https://gitlab.freedesktop.org/wayland/wayland-protocols"><title>cosmic::cctk::sctk::reexports::protocols - 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="../../../../../crates.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 crate"><!--[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"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#protocol-categories" title="Protocol categories">Protocol categories</a></li><li><a href="#staging-protocols" title="Staging protocols">Staging protocols</a></li><li><a href="#unstable-protocols" title="Unstable protocols">Unstable protocols</a></li><li><a href="#other-protocols" title="Other protocols">Other protocols</a></li></ul><h3><a href="#modules">Crate 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</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></div><h1>Crate <span>protocols</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>This crate provides bindings to the official wayland protocol extensions
|
||
provided in <a href="https://gitlab.freedesktop.org/wayland/wayland-protocols">https://gitlab.freedesktop.org/wayland/wayland-protocols</a></p>
|
||
<p>These bindings are built on top of the crates wayland-client and wayland-server.</p>
|
||
<p>Each protocol module contains a <code>client</code> and a <code>server</code> submodules, for each side of the
|
||
protocol. The creation of these modules (and the dependency on the associated crate) is
|
||
controlled by the two cargo features <code>client</code> and <code>server</code>.</p>
|
||
<h3 id="protocol-categories"><a class="doc-anchor" href="#protocol-categories">§</a>Protocol categories</h3>
|
||
<p>The protocols provided in this crate are grouped in 4 main categories:</p>
|
||
<ul>
|
||
<li>The <a href="wp/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp"><code>wp</code></a> module contains general purpose wayland protocols</li>
|
||
<li>The <a href="xdg/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::xdg"><code>xdg</code></a> module contains protocols specifically related to window management</li>
|
||
<li>The <a href="xwayland/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::xwayland"><code>xwayland</code></a> module contains protocols used by xwayland.</li>
|
||
<li>The <a href="ext/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::ext"><code>ext</code></a> module contains protocols that do not fit into the three previous categories.</li>
|
||
</ul>
|
||
<h3 id="staging-protocols"><a class="doc-anchor" href="#staging-protocols">§</a>Staging protocols</h3>
|
||
<p>The cargo feature <code>staging</code> enables the generation of the staging protocols.</p>
|
||
<p>These protocols are ready for wider adoption and clients and compositors are encouraged to
|
||
implement staging protocol extensions where a protocol’s functionality is desired.</p>
|
||
<p>Although these protocols should be stable, the protocols may still be completely replaced in a new
|
||
major version or with a completely different protocol.</p>
|
||
<h3 id="unstable-protocols"><a class="doc-anchor" href="#unstable-protocols">§</a>Unstable protocols</h3>
|
||
<p>The <code>wayland-protocols</code> project previously had a notion of “unstable protocols” representing protocols
|
||
that are still being worked on and evolving. These protocols are recognized by the use of the prefix <code>z</code>
|
||
in their interface names.</p>
|
||
<p>This category has now been deprecated and is no longer supposed to be used, however several protocols
|
||
are still under that umbrella. We can expect them to be replaced by staging and stable protocols in the
|
||
long term, but in the meantime you can enable them with the <code>unstable</code> cargo feature.</p>
|
||
<h3 id="other-protocols"><a class="doc-anchor" href="#other-protocols">§</a>Other protocols</h3>
|
||
<p>Additionally, more protocol extensions are provided here:</p>
|
||
<ul>
|
||
<li><a href="https://docs.rs/wayland-protocols-wlr">wayland-protocols-wlr</a></li>
|
||
<li><a href="https://docs.rs/wayland-protocols-plasma">wayland-protocols-plasma</a></li>
|
||
<li><a href="https://docs.rs/wayland-protocols-misc">wayland-protocols-misc</a></li>
|
||
</ul>
|
||
</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="ext/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::ext">ext</a></dt><dd>Miscellaneous protocols</dd><dt><a class="mod" href="wp/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::wp">wp</a></dt><dd>Generic wayland protocols</dd><dt><a class="mod" href="xdg/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::xdg">xdg</a></dt><dd>Protocols related to window management</dd><dt><a class="mod" href="xwayland/index.html" title="mod cosmic::cctk::sctk::reexports::protocols::xwayland">xwayland</a></dt><dd>XWayland related protocols</dd></dl></section></div></main></body></html> |