leyoda/libcosmic
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

deploy: 95756b1a57

Browse source
This commit is contained in:
wash2 2026-04-18 20:11:25 +00:00
commit 0fa87f2b35
16382 changed files with 734838 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

73
cosmic/cctk/sctk/shm/enum.CreatePoolError.html Normal file
View file

File diff suppressed because one or more lines are too long

1
cosmic/cctk/sctk/shm/index.html Normal file
View file

@ -0,0 +1 @@
<!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="API documentation for the Rust `shm` mod in crate `cosmic`."><title>cosmic::cctk::sctk::shm - 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 shm</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In cosmic::<wbr>cctk::<wbr>sctk</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></div><h1>Module <span>shm</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><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="multi/index.html" title="mod cosmic::cctk::sctk::shm::multi">multi</a></dt><dd>A pool implementation which automatically manage buffers.</dd><dt><a class="mod" href="raw/index.html" title="mod cosmic::cctk::sctk::shm::raw">raw</a></dt><dd>A raw shared memory pool handler.</dd><dt><a class="mod" href="slot/index.html" title="mod cosmic::cctk::sctk::shm::slot">slot</a></dt><dd>A pool implementation based on buffer slots</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Shm.html" title="struct cosmic::cctk::sctk::shm::Shm">Shm</a></dt></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.CreatePoolError.html" title="enum cosmic::cctk::sctk::shm::CreatePoolError">Create<wbr>Pool<wbr>Error</a></dt><dd>An error that may occur when creating a pool.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.ShmHandler.html" title="trait cosmic::cctk::sctk::shm::ShmHandler">ShmHandler</a></dt></dl></section></div></main></body></html>

71
cosmic/cctk/sctk/shm/multi/enum.PoolError.html Normal file
View file

File diff suppressed because one or more lines are too long

59
cosmic/cctk/sctk/shm/multi/index.html Normal file
View file

@ -0,0 +1,59 @@
<!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="A pool implementation which automatically manage buffers."><title>cosmic::cctk::sctk::shm::multi - 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 multi</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In cosmic::<wbr>cctk::<wbr>sctk::<wbr>shm</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">shm</a></div><h1>Module <span>multi</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>A pool implementation which automatically manage buffers.</p>
<p>This pool is built on the <a href="../raw/struct.RawPool.html" title="struct cosmic::cctk::sctk::shm::raw::RawPool"><code>RawPool</code></a>.</p>
<p>The <a href="struct.MultiPool.html" title="struct cosmic::cctk::sctk::shm::multi::MultiPool"><code>MultiPool</code></a> takes a key which is used to identify buffers and tries to return the buffer associated to the key
if possible. If no buffer in the pool is associated to the key, it will create a new one.</p>
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>smithay_client_toolkit::reexports::client::{
QueueHandle,
protocol::wl_surface::WlSurface,
protocol::wl_shm::Format,
};
<span class="kw">use </span>smithay_client_toolkit::shm::multi::MultiPool;
<span class="kw">struct </span>WlFoo {
<span class="comment">// The surface we'll draw on and the index of buffer associated to it
</span>surface: (WlSurface, usize),
pool: MultiPool&lt;(WlSurface, usize)&gt;
}
<span class="kw">impl </span>WlFoo {
<span class="kw">fn </span>draw(<span class="kw-2">&amp;mut </span><span class="self">self</span>, qh: <span class="kw-2">&amp;</span>QueueHandle&lt;WlFoo&gt;) {
<span class="kw">let </span>surface = <span class="kw-2">&amp;</span><span class="self">self</span>.surface.<span class="number">0</span>;
<span class="comment">// We'll increment "i" until the pool can create a new buffer
// if there's no buffer associated with our surface and "i" or if
// a buffer with the obuffer associated with our surface and "i" is free for use.
//
// There's no limit to the amount of buffers we can allocate to our surface but since
// shm buffers are released fairly fast, it's unlikely we'll need more than double buffering.
</span><span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="number">2 </span>{
<span class="self">self</span>.surface.<span class="number">1 </span>= i;
<span class="kw">if let </span><span class="prelude-val">Ok</span>((offset, buffer, slice)) = <span class="self">self</span>.pool.create_buffer(
<span class="number">100</span>,
<span class="number">100 </span>* <span class="number">4</span>,
<span class="number">100</span>,
<span class="kw-2">&amp;</span><span class="self">self</span>.surface,
Format::Argb8888,
) {
<span class="comment">/*
insert drawing code here
*/
</span>surface.attach(<span class="prelude-val">Some</span>(buffer), <span class="number">0</span>, <span class="number">0</span>);
surface.commit();
<span class="comment">// We exit the function after the draw.
</span><span class="kw">return</span>;
}
}
<span class="comment">/*
If there's no buffer available we can for example request a frame callback
and trigger a redraw when it fires.
(not shown in this example)
*/
</span>}
}
<span class="kw">fn </span>draw(slice: <span class="kw-2">&amp;mut </span>[u8]) {
<span class="macro">todo!</span>()
}
</code></pre></div>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.BufferSlot.html" title="struct cosmic::cctk::sctk::shm::multi::BufferSlot">Buffer<wbr>Slot</a></dt><dt><a class="struct" href="struct.MultiPool.html" title="struct cosmic::cctk::sctk::shm::multi::MultiPool">Multi<wbr>Pool</a></dt><dd>This pool manages buffers associated with keys.
Only one buffer can be attributed to a given key.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.PoolError.html" title="enum cosmic::cctk::sctk::shm::multi::PoolError">Pool<wbr>Error</a></dt></dl></section></div></main></body></html>

1
cosmic/cctk/sctk/shm/multi/sidebar-items.js Normal file
View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"enum":["PoolError"],"struct":["BufferSlot","MultiPool"]};

71
cosmic/cctk/sctk/shm/multi/struct.BufferSlot.html Normal file
View file

File diff suppressed because one or more lines are too long

135
cosmic/cctk/sctk/shm/multi/struct.MultiPool.html Normal file
View file

File diff suppressed because one or more lines are too long

4
cosmic/cctk/sctk/shm/raw/index.html Normal file
View file

@ -0,0 +1,4 @@
<!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="A raw shared memory pool handler."><title>cosmic::cctk::sctk::shm::raw - 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 raw</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In cosmic::<wbr>cctk::<wbr>sctk::<wbr>shm</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">shm</a></div><h1>Module <span>raw</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>A raw shared memory pool handler.</p>
<p>This is intended as a safe building block for higher level shared memory pool abstractions and is not
encouraged for most library users.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.RawPool.html" title="struct cosmic::cctk::sctk::shm::raw::RawPool">RawPool</a></dt><dd>A raw handler for file backed shared memory pools.</dd></dl></section></div></main></body></html>

1
cosmic/cctk/sctk/shm/raw/sidebar-items.js Normal file
View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"struct":["RawPool"]};

145
cosmic/cctk/sctk/shm/raw/struct.RawPool.html Normal file
View file

File diff suppressed because one or more lines are too long

1
cosmic/cctk/sctk/shm/sidebar-items.js Normal file
View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"enum":["CreatePoolError"],"mod":["multi","raw","slot"],"struct":["Shm"],"trait":["ShmHandler"]};

70
cosmic/cctk/sctk/shm/slot/enum.ActivateSlotError.html Normal file
View file

File diff suppressed because one or more lines are too long

74
cosmic/cctk/sctk/shm/slot/enum.CreateBufferError.html Normal file
View file

File diff suppressed because one or more lines are too long

2
cosmic/cctk/sctk/shm/slot/index.html Normal file
View file

@ -0,0 +1,2 @@
<!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="A pool implementation based on buffer slots"><title>cosmic::cctk::sctk::shm::slot - 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 slot</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In cosmic::<wbr>cctk::<wbr>sctk::<wbr>shm</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">shm</a></div><h1>Module <span>slot</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>A pool implementation based on buffer slots</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Buffer.html" title="struct cosmic::cctk::sctk::shm::slot::Buffer">Buffer</a></dt><dd>A wrapper around a <a href="../../reexports/client/protocol/wl_buffer/struct.WlBuffer.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_buffer::WlBuffer"><code>wl_buffer::WlBuffer</code></a> which has been allocated via a <a href="struct.SlotPool.html" title="struct cosmic::cctk::sctk::shm::slot::SlotPool">SlotPool</a>.</dd><dt><a class="struct" href="struct.Slot.html" title="struct cosmic::cctk::sctk::shm::slot::Slot">Slot</a></dt><dd>A chunk of memory allocated from a <a href="struct.SlotPool.html" title="struct cosmic::cctk::sctk::shm::slot::SlotPool">SlotPool</a></dd><dt><a class="struct" href="struct.SlotPool.html" title="struct cosmic::cctk::sctk::shm::slot::SlotPool">Slot<wbr>Pool</a></dt></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.ActivateSlotError.html" title="enum cosmic::cctk::sctk::shm::slot::ActivateSlotError">Activate<wbr>Slot<wbr>Error</a></dt><dt><a class="enum" href="enum.CreateBufferError.html" title="enum cosmic::cctk::sctk::shm::slot::CreateBufferError">Create<wbr>Buffer<wbr>Error</a></dt></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.CanvasKey.html" title="trait cosmic::cctk::sctk::shm::slot::CanvasKey">Canvas<wbr>Key</a></dt><dd>A helper trait for <a href="struct.SlotPool.html#method.canvas" title="method cosmic::cctk::sctk::shm::slot::SlotPool::canvas">SlotPool::canvas</a>.</dd></dl></section></div></main></body></html>

1
cosmic/cctk/sctk/shm/slot/sidebar-items.js Normal file
View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"enum":["ActivateSlotError","CreateBufferError"],"struct":["Buffer","Slot","SlotPool"],"trait":["CanvasKey"]};

88
cosmic/cctk/sctk/shm/slot/struct.Buffer.html Normal file
View file

File diff suppressed because one or more lines are too long

79
cosmic/cctk/sctk/shm/slot/struct.Slot.html Normal file
View file

File diff suppressed because one or more lines are too long

117
cosmic/cctk/sctk/shm/slot/struct.SlotPool.html Normal file
View file

File diff suppressed because one or more lines are too long

8
cosmic/cctk/sctk/shm/slot/trait.CanvasKey.html Normal file
View file

@ -0,0 +1,8 @@
<!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="A helper trait for SlotPool::canvas."><title>CanvasKey in cosmic::cctk::sctk::shm::slot - 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 trait"><!--[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="#">Canvas<wbr>Key</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.canvas" title="canvas">canvas</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In cosmic::<wbr>cctk::<wbr>sctk::<wbr>shm::<wbr>slot</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">shm</a>::<wbr><a href="index.html">slot</a></div><h1>Trait <span class="trait">CanvasKey</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><pre class="rust item-decl"><code>pub trait CanvasKey {
// Required method
fn <a href="#tymethod.canvas" class="fn">canvas</a>&lt;'pool&gt;(
&amp;self,
pool: &amp;'pool mut <a class="struct" href="struct.SlotPool.html" title="struct cosmic::cctk::sctk::shm::slot::SlotPool">SlotPool</a>,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;'pool mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]&gt;;
}</code></pre><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>A helper trait for <a href="struct.SlotPool.html#method.canvas" title="method cosmic::cctk::sctk::shm::slot::SlotPool::canvas">SlotPool::canvas</a>.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><section id="tymethod.canvas" class="method"><h4 class="code-header">fn <a href="#tymethod.canvas" class="fn">canvas</a>&lt;'pool&gt;(&amp;self, pool: &amp;'pool mut <a class="struct" href="struct.SlotPool.html" title="struct cosmic::cctk::sctk::shm::slot::SlotPool">SlotPool</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;'pool mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]&gt;</h4></section></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-CanvasKey-for-Buffer" class="impl"><a href="#impl-CanvasKey-for-Buffer" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CanvasKey.html" title="trait cosmic::cctk::sctk::shm::slot::CanvasKey">CanvasKey</a> for <a class="struct" href="struct.Buffer.html" title="struct cosmic::cctk::sctk::shm::slot::Buffer">Buffer</a></h3></section><section id="impl-CanvasKey-for-Slot" class="impl"><a href="#impl-CanvasKey-for-Slot" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.CanvasKey.html" title="trait cosmic::cctk::sctk::shm::slot::CanvasKey">CanvasKey</a> for <a class="struct" href="struct.Slot.html" title="struct cosmic::cctk::sctk::shm::slot::Slot">Slot</a></h3></section></div><script src="../../../../../trait.impl/smithay_client_toolkit/shm/slot/trait.CanvasKey.js" data-ignore-extern-crates="smithay_client_toolkit" async></script></section></div></main></body></html>

81
cosmic/cctk/sctk/shm/struct.Shm.html Normal file
View file

File diff suppressed because one or more lines are too long

4
cosmic/cctk/sctk/shm/trait.ShmHandler.html Normal file
View file

@ -0,0 +1,4 @@
<!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="API documentation for the Rust `ShmHandler` trait in crate `cosmic`."><title>ShmHandler in cosmic::cctk::sctk::shm - 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 trait"><!--[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="#">ShmHandler</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.shm_state" title="shm_state">shm_state</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In cosmic::<wbr>cctk::<wbr>sctk::<wbr>shm</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">shm</a></div><h1>Trait <span class="trait">ShmHandler</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><pre class="rust item-decl"><code>pub trait ShmHandler {
// Required method
fn <a href="#tymethod.shm_state" class="fn">shm_state</a>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="struct.Shm.html" title="struct cosmic::cctk::sctk::shm::Shm">Shm</a>;
}</code></pre><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>wayland</code> and Linux</strong> only.</div></span><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><section id="tymethod.shm_state" class="method"><h4 class="code-header">fn <a href="#tymethod.shm_state" class="fn">shm_state</a>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="struct.Shm.html" title="struct cosmic::cctk::sctk::shm::Shm">Shm</a></h4></section></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../../../trait.impl/smithay_client_toolkit/shm/trait.ShmHandler.js" async></script></section></div></main></body></html>