30 lines
No EOL
16 KiB
HTML
30 lines
No EOL
16 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="Functionality shared by all `wl_surface::WlSurface` backed shell role objects."><title>WaylandSurface in cosmic::cctk::sctk::shell - 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="#">Wayland<wbr>Surface</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.wl_surface" title="wl_surface">wl_surface</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.attach" title="attach">attach</a></li><li><a href="#method.commit" title="commit">commit</a></li><li><a href="#method.offset" title="offset">offset</a></li><li><a href="#method.set_buffer_scale" title="set_buffer_scale">set_buffer_scale</a></li><li><a href="#method.set_buffer_transform" title="set_buffer_transform">set_buffer_transform</a></li><li><a href="#method.set_input_region" title="set_input_region">set_input_region</a></li><li><a href="#method.set_opaque_region" title="set_opaque_region">set_opaque_region</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>shell</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">shell</a></div><h1>Trait <span class="trait">WaylandSurface</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 WaylandSurface: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|
// Required method
|
|
fn <a href="#tymethod.wl_surface" class="fn">wl_surface</a>(&self) -> &<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>;
|
|
|
|
// Provided methods
|
|
fn <a href="#method.attach" class="fn">attach</a>(&self, buffer: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../reexports/client/protocol/wl_buffer/struct.WlBuffer.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_buffer::WlBuffer">WlBuffer</a>>, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.set_opaque_region" class="fn">set_opaque_region</a>(&self, region: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../reexports/client/protocol/wl_region/struct.WlRegion.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_region::WlRegion">WlRegion</a>>) { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.set_input_region" class="fn">set_input_region</a>(&self, region: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../reexports/client/protocol/wl_region/struct.WlRegion.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_region::WlRegion">WlRegion</a>>) { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.set_buffer_transform" class="fn">set_buffer_transform</a>(
|
|
&self,
|
|
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>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="struct.Unsupported.html" title="struct cosmic::cctk::sctk::shell::Unsupported">Unsupported</a>> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.set_buffer_scale" class="fn">set_buffer_scale</a>(&self, scale: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="struct.Unsupported.html" title="struct cosmic::cctk::sctk::shell::Unsupported">Unsupported</a>> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.offset" class="fn">offset</a>(&self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="struct.Unsupported.html" title="struct cosmic::cctk::sctk::shell::Unsupported">Unsupported</a>> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.commit" class="fn">commit</a>(&self) { ... }
|
|
}</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>Functionality shared by all <a href="../reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_surface::WlSurface"><code>wl_surface::WlSurface</code></a> backed shell role objects.</p>
|
|
</div></details><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.wl_surface" class="method"><h4 class="code-header">fn <a href="#tymethod.wl_surface" class="fn">wl_surface</a>(&self) -> &<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></h4></section></summary><div class="docblock"><p>The underlying <a href="../reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_surface::WlSurface"><code>WlSurface</code></a>.</p>
|
|
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><section id="method.attach" class="method"><h4 class="code-header">fn <a href="#method.attach" class="fn">attach</a>(&self, buffer: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../reexports/client/protocol/wl_buffer/struct.WlBuffer.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_buffer::WlBuffer">WlBuffer</a>>, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>)</h4></section><section id="method.set_opaque_region" class="method"><h4 class="code-header">fn <a href="#method.set_opaque_region" class="fn">set_opaque_region</a>(&self, region: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../reexports/client/protocol/wl_region/struct.WlRegion.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_region::WlRegion">WlRegion</a>>)</h4></section><section id="method.set_input_region" class="method"><h4 class="code-header">fn <a href="#method.set_input_region" class="fn">set_input_region</a>(&self, region: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../reexports/client/protocol/wl_region/struct.WlRegion.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_region::WlRegion">WlRegion</a>>)</h4></section><section id="method.set_buffer_transform" class="method"><h4 class="code-header">fn <a href="#method.set_buffer_transform" class="fn">set_buffer_transform</a>(&self, 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>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="struct.Unsupported.html" title="struct cosmic::cctk::sctk::shell::Unsupported">Unsupported</a>></h4></section><section id="method.set_buffer_scale" class="method"><h4 class="code-header">fn <a href="#method.set_buffer_scale" class="fn">set_buffer_scale</a>(&self, scale: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="struct.Unsupported.html" title="struct cosmic::cctk::sctk::shell::Unsupported">Unsupported</a>></h4></section><section id="method.offset" class="method"><h4 class="code-header">fn <a href="#method.offset" class="fn">offset</a>(&self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="struct.Unsupported.html" title="struct cosmic::cctk::sctk::shell::Unsupported">Unsupported</a>></h4></section><details class="toggle method-toggle" open><summary><section id="method.commit" class="method"><h4 class="code-header">fn <a href="#method.commit" class="fn">commit</a>(&self)</h4></section></summary><div class="docblock"><p>Commits pending surface state.</p>
|
|
<p>On commit, the pending double buffered state from the surface, including role dependent state is
|
|
applied.</p>
|
|
<h5 id="initial-commit"><a class="doc-anchor" href="#initial-commit">§</a>Initial commit</h5>
|
|
<p>In many protocol extensions, the concept of an initial commit is used. A initial commit provides the
|
|
initial state of a surface to the compositor. For example with the <a href="xdg/index.html" title="mod cosmic::cctk::sctk::shell::xdg">xdg shell</a>,
|
|
creating a window requires an initial commit.</p>
|
|
<h5 id="protocol-errors"><a class="doc-anchor" href="#protocol-errors">§</a>Protocol Errors</h5>
|
|
<p>If the commit is the initial commit, no buffers must have been attached to the surface. This rule
|
|
applies whether attaching the buffer was done using <a href="trait.WaylandSurface.html#method.attach" title="method cosmic::cctk::sctk::shell::WaylandSurface::attach"><code>WaylandSurface::attach</code></a> or under the hood in
|
|
via window system integration in graphics APIs such as Vulkan (using <code>vkQueuePresentKHR</code>) and EGL
|
|
(using <code>eglSwapBuffers</code>).</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"><section id="impl-WaylandSurface-for-LayerSurface" class="impl"><a href="#impl-WaylandSurface-for-LayerSurface" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.WaylandSurface.html" title="trait cosmic::cctk::sctk::shell::WaylandSurface">WaylandSurface</a> for <a class="struct" href="wlr_layer/struct.LayerSurface.html" title="struct cosmic::cctk::sctk::shell::wlr_layer::LayerSurface">LayerSurface</a></h3></section><section id="impl-WaylandSurface-for-XdgShellSurface" class="impl"><a href="#impl-WaylandSurface-for-XdgShellSurface" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.WaylandSurface.html" title="trait cosmic::cctk::sctk::shell::WaylandSurface">WaylandSurface</a> for <a class="struct" href="xdg/struct.XdgShellSurface.html" title="struct cosmic::cctk::sctk::shell::xdg::XdgShellSurface">XdgShellSurface</a></h3></section><section id="impl-WaylandSurface-for-Window" class="impl"><a href="#impl-WaylandSurface-for-Window" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.WaylandSurface.html" title="trait cosmic::cctk::sctk::shell::WaylandSurface">WaylandSurface</a> for <a class="struct" href="xdg/window/struct.Window.html" title="struct cosmic::cctk::sctk::shell::xdg::window::Window">Window</a></h3></section></div><script src="../../../../trait.impl/smithay_client_toolkit/shell/trait.WaylandSurface.js" data-ignore-extern-crates="smithay_client_toolkit" async></script></section></div></main></body></html> |