24 lines
No EOL
4.7 KiB
HTML
24 lines
No EOL
4.7 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="Delegates the handling of `wl_shm` to some `Shm`."><title>delegate_shm in cosmic::cctk::sctk - 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 macro"><!--[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"><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>Macro <span class="macro">delegate_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><pre class="rust item-decl"><code>macro_rules! delegate_shm {
|
|
($(@<$( $lt:tt $( : $clt:tt $(+ $dlt:tt )* )? ),+>)? $ty: ty) => { ... };
|
|
}</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>Delegates the handling of <a href="reexports/client/protocol/wl_shm/index.html" title="mod cosmic::cctk::sctk::reexports::client::protocol::wl_shm"><code>wl_shm</code></a> to some <a href="shm/struct.Shm.html" title="struct cosmic::cctk::sctk::shm::Shm"><code>Shm</code></a>.</p>
|
|
<p>This macro requires two things, the type that will delegate to <a href="shm/struct.Shm.html" title="struct cosmic::cctk::sctk::shm::Shm"><code>Shm</code></a> and a closure specifying how
|
|
to obtain the state object.</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>smithay_client_toolkit::shm::{ShmHandler, Shm};
|
|
<span class="kw">use </span>smithay_client_toolkit::delegate_shm;
|
|
|
|
<span class="kw">struct </span>ExampleApp {
|
|
<span class="doccomment">/// The state object that will be our delegate.
|
|
</span>shm: Shm,
|
|
}
|
|
|
|
<span class="comment">// Use the macro to delegate wl_shm to Shm.
|
|
</span><span class="macro">delegate_shm!</span>(ExampleApp);
|
|
|
|
<span class="comment">// You must implement the ShmHandler trait to provide a way to access the Shm from your data type.
|
|
</span><span class="kw">impl </span>ShmHandler <span class="kw">for </span>ExampleApp {
|
|
<span class="kw">fn </span>shm_state(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>Shm {
|
|
<span class="kw-2">&mut </span><span class="self">self</span>.shm
|
|
}
|
|
}</code></pre></div>
|
|
</div></details></section></div></main></body></html> |