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

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"struct":["CompositorState","Region","Surface","SurfaceData"],"trait":["CompositorHandler","SurfaceDataExt"]};

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,80 @@
<!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 `CompositorHandler` trait in crate `cosmic`."><title>CompositorHandler in cosmic::cctk::sctk::compositor - 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="#">Compositor<wbr>Handler</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.frame" title="frame">frame</a></li><li><a href="#tymethod.scale_factor_changed" title="scale_factor_changed">scale_factor_changed</a></li><li><a href="#tymethod.surface_enter" title="surface_enter">surface_enter</a></li><li><a href="#tymethod.surface_leave" title="surface_leave">surface_leave</a></li><li><a href="#tymethod.transform_changed" title="transform_changed">transform_changed</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In cosmic::<wbr>cctk::<wbr>sctk::<wbr>compositor</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">compositor</a></div><h1>Trait <span class="trait">CompositorHandler</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 CompositorHandler: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
// Required methods
fn <a href="#tymethod.scale_factor_changed" class="fn">scale_factor_changed</a>(
&amp;mut self,
conn: &amp;<a class="struct" href="../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
qh: &amp;<a class="struct" href="../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a>&lt;Self&gt;,
surface: &amp;<a class="struct" href="../reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_surface::WlSurface">WlSurface</a>,
new_factor: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>,
);
<span class="item-spacer"></span> fn <a href="#tymethod.transform_changed" class="fn">transform_changed</a>(
&amp;mut self,
conn: &amp;<a class="struct" href="../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
qh: &amp;<a class="struct" href="../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a>&lt;Self&gt;,
surface: &amp;<a class="struct" href="../reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_surface::WlSurface">WlSurface</a>,
new_transform: <a class="enum" href="../reexports/client/protocol/wl_output/enum.Transform.html" title="enum cosmic::cctk::sctk::reexports::client::protocol::wl_output::Transform">Transform</a>,
);
<span class="item-spacer"></span> fn <a href="#tymethod.frame" class="fn">frame</a>(
&amp;mut self,
conn: &amp;<a class="struct" href="../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
qh: &amp;<a class="struct" href="../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a>&lt;Self&gt;,
surface: &amp;<a class="struct" href="../reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_surface::WlSurface">WlSurface</a>,
time: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
);
<span class="item-spacer"></span> fn <a href="#tymethod.surface_enter" class="fn">surface_enter</a>(
&amp;mut self,
conn: &amp;<a class="struct" href="../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
qh: &amp;<a class="struct" href="../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a>&lt;Self&gt;,
surface: &amp;<a class="struct" href="../reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_surface::WlSurface">WlSurface</a>,
output: &amp;<a class="struct" href="../reexports/client/protocol/wl_output/struct.WlOutput.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_output::WlOutput">WlOutput</a>,
);
<span class="item-spacer"></span> fn <a href="#tymethod.surface_leave" class="fn">surface_leave</a>(
&amp;mut self,
conn: &amp;<a class="struct" href="../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
qh: &amp;<a class="struct" href="../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a>&lt;Self&gt;,
surface: &amp;<a class="struct" href="../reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_surface::WlSurface">WlSurface</a>,
output: &amp;<a class="struct" href="../reexports/client/protocol/wl_output/struct.WlOutput.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_output::WlOutput">WlOutput</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"><details class="toggle method-toggle" open><summary><section id="tymethod.scale_factor_changed" class="method"><h4 class="code-header">fn <a href="#tymethod.scale_factor_changed" class="fn">scale_factor_changed</a>(
&amp;mut self,
conn: &amp;<a class="struct" href="../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
qh: &amp;<a class="struct" href="../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a>&lt;Self&gt;,
surface: &amp;<a class="struct" href="../reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_surface::WlSurface">WlSurface</a>,
new_factor: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>,
)</h4></section></summary><div class="docblock"><p>The surface has either been moved into or out of an output and the output has a different scale factor.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.transform_changed" class="method"><h4 class="code-header">fn <a href="#tymethod.transform_changed" class="fn">transform_changed</a>(
&amp;mut self,
conn: &amp;<a class="struct" href="../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
qh: &amp;<a class="struct" href="../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a>&lt;Self&gt;,
surface: &amp;<a class="struct" href="../reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_surface::WlSurface">WlSurface</a>,
new_transform: <a class="enum" href="../reexports/client/protocol/wl_output/enum.Transform.html" title="enum cosmic::cctk::sctk::reexports::client::protocol::wl_output::Transform">Transform</a>,
)</h4></section></summary><div class="docblock"><p>The surface has either been moved into or out of an output and the output has different transform.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.frame" class="method"><h4 class="code-header">fn <a href="#tymethod.frame" class="fn">frame</a>(
&amp;mut self,
conn: &amp;<a class="struct" href="../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
qh: &amp;<a class="struct" href="../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a>&lt;Self&gt;,
surface: &amp;<a class="struct" href="../reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_surface::WlSurface">WlSurface</a>,
time: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
)</h4></section></summary><div class="docblock"><p>A frame callback has been completed.</p>
<p>Frame callbacks are used to avoid updating surfaces that are not currently visible. If a
frame callback is requested prior to committing a surface, the client should avoid drawing
to that surface until the callback completes. See the
<a href="../reexports/client/protocol/wl_surface/struct.WlSurface.html#method.frame" title="method cosmic::cctk::sctk::reexports::client::protocol::wl_surface::WlSurface::frame"><code>WlSurface::frame</code></a> request for more details.</p>
<p>This function will be called if you request a frame callback by passing the surface itself
as the userdata (<code>surface.frame(&amp;queue, &amp;surface)</code>); you can also implement <a href="../reexports/client/trait.Dispatch.html" title="trait cosmic::cctk::sctk::reexports::client::Dispatch"><code>Dispatch</code></a>
for other values to more easily dispatch rendering for specific surface types.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.surface_enter" class="method"><h4 class="code-header">fn <a href="#tymethod.surface_enter" class="fn">surface_enter</a>(
&amp;mut self,
conn: &amp;<a class="struct" href="../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
qh: &amp;<a class="struct" href="../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a>&lt;Self&gt;,
surface: &amp;<a class="struct" href="../reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_surface::WlSurface">WlSurface</a>,
output: &amp;<a class="struct" href="../reexports/client/protocol/wl_output/struct.WlOutput.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_output::WlOutput">WlOutput</a>,
)</h4></section></summary><div class="docblock"><p>The surface has entered an output.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.surface_leave" class="method"><h4 class="code-header">fn <a href="#tymethod.surface_leave" class="fn">surface_leave</a>(
&amp;mut self,
conn: &amp;<a class="struct" href="../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
qh: &amp;<a class="struct" href="../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a>&lt;Self&gt;,
surface: &amp;<a class="struct" href="../reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_surface::WlSurface">WlSurface</a>,
output: &amp;<a class="struct" href="../reexports/client/protocol/wl_output/struct.WlOutput.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_output::WlOutput">WlOutput</a>,
)</h4></section></summary><div class="docblock"><p>The surface has left an output.</p>
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></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/compositor/trait.CompositorHandler.js" async></script></section></div></main></body></html>

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 `SurfaceDataExt` trait in crate `cosmic`."><title>SurfaceDataExt in cosmic::cctk::sctk::compositor - 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="#">Surface<wbr>Data<wbr>Ext</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.surface_data" title="surface_data">surface_data</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>compositor</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">compositor</a></div><h1>Trait <span class="trait">SurfaceDataExt</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 SurfaceDataExt: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> {
// Required method
fn <a href="#tymethod.surface_data" class="fn">surface_data</a>(&amp;self) -&gt; &amp;<a class="struct" href="struct.SurfaceData.html" title="struct cosmic::cctk::sctk::compositor::SurfaceData">SurfaceData</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.surface_data" class="method"><h4 class="code-header">fn <a href="#tymethod.surface_data" class="fn">surface_data</a>(&amp;self) -&gt; &amp;<a class="struct" href="struct.SurfaceData.html" title="struct cosmic::cctk::sctk::compositor::SurfaceData">SurfaceData</a></h4></section></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-SurfaceDataExt-for-SurfaceData" class="impl"><a href="#impl-SurfaceDataExt-for-SurfaceData" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SurfaceDataExt.html" title="trait cosmic::cctk::sctk::compositor::SurfaceDataExt">SurfaceDataExt</a> for <a class="struct" href="struct.SurfaceData.html" title="struct cosmic::cctk::sctk::compositor::SurfaceData">SurfaceData</a></h3></section></div><script src="../../../../trait.impl/smithay_client_toolkit/compositor/trait.SurfaceDataExt.js" data-ignore-extern-crates="smithay_client_toolkit" async></script></section></div></main></body></html>