mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 19:18:44 +00:00
57 lines
23 KiB
HTML
57 lines
23 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="API documentation for the Rust `Frame` trait in crate `smithay_client_toolkit`."><meta name="keywords" content="rust, rustlang, rust-lang, Frame"><title>smithay_client_toolkit::window::Frame - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><p class='location'>Trait Frame</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Error">Error</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.init">init</a><a href="#tymethod.set_active">set_active</a><a href="#tymethod.set_maximized">set_maximized</a><a href="#tymethod.set_hidden">set_hidden</a><a href="#tymethod.set_resizable">set_resizable</a><a href="#tymethod.new_seat">new_seat</a><a href="#tymethod.resize">resize</a><a href="#tymethod.redraw">redraw</a><a href="#tymethod.subtract_borders">subtract_borders</a><a href="#tymethod.add_borders">add_borders</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.location">location</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>smithay_client_toolkit</a>::<wbr><a href='index.html'>window</a></p><script>window.sidebarCurrent = {name: 'Frame', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Trait <a href='../index.html'>smithay_client_toolkit</a>::<wbr><a href='index.html'>window</a>::<wbr><a class="trait" href=''>Frame</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#542-588' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait Frame: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> {
|
||
type <a href='#associatedtype.Error' class="type">Error</a>;
|
||
fn <a href='#tymethod.init' class='fnname'>init</a>(<br> base_surface: &<a class="struct" href="../../smithay_client_toolkit/reexports/client/struct.Proxy.html" title="struct smithay_client_toolkit::reexports::client::Proxy">Proxy</a><<a class="struct" href="../../smithay_client_toolkit/reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct smithay_client_toolkit::reexports::client::protocol::wl_surface::WlSurface">WlSurface</a>>, <br> compositor: &<a class="struct" href="../../smithay_client_toolkit/reexports/client/struct.Proxy.html" title="struct smithay_client_toolkit::reexports::client::Proxy">Proxy</a><<a class="struct" href="../../smithay_client_toolkit/reexports/client/protocol/wl_compositor/struct.WlCompositor.html" title="struct smithay_client_toolkit::reexports::client::protocol::wl_compositor::WlCompositor">WlCompositor</a>>, <br> subcompositor: &<a class="struct" href="../../smithay_client_toolkit/reexports/client/struct.Proxy.html" title="struct smithay_client_toolkit::reexports::client::Proxy">Proxy</a><<a class="struct" href="../../smithay_client_toolkit/reexports/client/protocol/wl_subcompositor/struct.WlSubcompositor.html" title="struct smithay_client_toolkit::reexports::client::protocol::wl_subcompositor::WlSubcompositor">WlSubcompositor</a>>, <br> shm: &<a class="struct" href="../../smithay_client_toolkit/reexports/client/struct.Proxy.html" title="struct smithay_client_toolkit::reexports::client::Proxy">Proxy</a><<a class="struct" href="../../smithay_client_toolkit/reexports/client/protocol/wl_shm/struct.WlShm.html" title="struct smithay_client_toolkit::reexports::client::protocol::wl_shm::WlShm">WlShm</a>>, <br> implementation: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><<a class="trait" href="../../smithay_client_toolkit/reexports/client/commons/trait.Implementation.html" title="trait smithay_client_toolkit::reexports::client::commons::Implementation">Implementation</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="enum" href="../../smithay_client_toolkit/window/enum.FrameRequest.html" title="enum smithay_client_toolkit::window::FrameRequest">FrameRequest</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="type" href="../../smithay_client_toolkit/window/trait.Frame.html#associatedtype.Error" title="type smithay_client_toolkit::window::Frame::Error">Error</a>>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.set_active' class='fnname'>set_active</a>(&mut self, active: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.set_maximized' class='fnname'>set_maximized</a>(&mut self, maximized: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.set_hidden' class='fnname'>set_hidden</a>(&mut self, hidden: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.set_resizable' class='fnname'>set_resizable</a>(&mut self, resizable: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.new_seat' class='fnname'>new_seat</a>(&mut self, seat: &<a class="struct" href="../../smithay_client_toolkit/reexports/client/struct.Proxy.html" title="struct smithay_client_toolkit::reexports::client::Proxy">Proxy</a><<a class="struct" href="../../smithay_client_toolkit/reexports/client/protocol/wl_seat/struct.WlSeat.html" title="struct smithay_client_toolkit::reexports::client::protocol::wl_seat::WlSeat">WlSeat</a>>);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.resize' class='fnname'>resize</a>(&mut self, newsize: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.redraw' class='fnname'>redraw</a>(&mut self);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.subtract_borders' class='fnname'>subtract_borders</a>(&self, width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.add_borders' class='fnname'>add_borders</a>(&self, width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;
|
||
|
||
fn <a href='#method.location' class='fnname'>location</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a> { ... }
|
||
}</pre></div><div class='docblock'><p>Interface for defining the drawing of decorations</p>
|
||
<p>A type implementing this trait can be used to define custom
|
||
decorations additionnaly to the ones provided by this crate
|
||
and be used with <code>Window</code>.</p>
|
||
</div>
|
||
<h2 id='associated-types' class='small-section-header'>
|
||
Associated Types<a href='#associated-types' class='anchor'></a>
|
||
</h2>
|
||
<div class='methods'>
|
||
<h3 id='associatedtype.Error' class='method'><span id='Error.t' class='invisible'><code>type <a href='#associatedtype.Error' class="type">Error</a></code></span></h3><div class='docblock'><p>Type of errors that may occur when attempting to create a frame</p>
|
||
</div></div>
|
||
<h2 id='required-methods' class='small-section-header'>
|
||
Required Methods<a href='#required-methods' class='anchor'></a>
|
||
</h2>
|
||
<div class='methods'>
|
||
<h3 id='tymethod.init' class='method'><span id='init.v' class='invisible'><code>fn <a href='#tymethod.init' class='fnname'>init</a>(<br> base_surface: &<a class="struct" href="../../smithay_client_toolkit/reexports/client/struct.Proxy.html" title="struct smithay_client_toolkit::reexports::client::Proxy">Proxy</a><<a class="struct" href="../../smithay_client_toolkit/reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct smithay_client_toolkit::reexports::client::protocol::wl_surface::WlSurface">WlSurface</a>>, <br> compositor: &<a class="struct" href="../../smithay_client_toolkit/reexports/client/struct.Proxy.html" title="struct smithay_client_toolkit::reexports::client::Proxy">Proxy</a><<a class="struct" href="../../smithay_client_toolkit/reexports/client/protocol/wl_compositor/struct.WlCompositor.html" title="struct smithay_client_toolkit::reexports::client::protocol::wl_compositor::WlCompositor">WlCompositor</a>>, <br> subcompositor: &<a class="struct" href="../../smithay_client_toolkit/reexports/client/struct.Proxy.html" title="struct smithay_client_toolkit::reexports::client::Proxy">Proxy</a><<a class="struct" href="../../smithay_client_toolkit/reexports/client/protocol/wl_subcompositor/struct.WlSubcompositor.html" title="struct smithay_client_toolkit::reexports::client::protocol::wl_subcompositor::WlSubcompositor">WlSubcompositor</a>>, <br> shm: &<a class="struct" href="../../smithay_client_toolkit/reexports/client/struct.Proxy.html" title="struct smithay_client_toolkit::reexports::client::Proxy">Proxy</a><<a class="struct" href="../../smithay_client_toolkit/reexports/client/protocol/wl_shm/struct.WlShm.html" title="struct smithay_client_toolkit::reexports::client::protocol::wl_shm::WlShm">WlShm</a>>, <br> implementation: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><<a class="trait" href="../../smithay_client_toolkit/reexports/client/commons/trait.Implementation.html" title="trait smithay_client_toolkit::reexports::client::commons::Implementation">Implementation</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="enum" href="../../smithay_client_toolkit/window/enum.FrameRequest.html" title="enum smithay_client_toolkit::window::FrameRequest">FrameRequest</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, Self::<a class="type" href="../../smithay_client_toolkit/window/trait.Frame.html#associatedtype.Error" title="type smithay_client_toolkit::window::Frame::Error">Error</a>></code></span></h3><div class='docblock'><p>Initialize the Frame</p>
|
||
</div><h3 id='tymethod.set_active' class='method'><span id='set_active.v' class='invisible'><code>fn <a href='#tymethod.set_active' class='fnname'>set_active</a>(&mut self, active: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h3><div class='docblock'><p>Set whether the decorations should be drawn as active or not</p>
|
||
<p>Calling this should <em>not</em> trigger a redraw, but return <code>true</code> if
|
||
a redraw is needed.</p>
|
||
</div><h3 id='tymethod.set_maximized' class='method'><span id='set_maximized.v' class='invisible'><code>fn <a href='#tymethod.set_maximized' class='fnname'>set_maximized</a>(&mut self, maximized: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h3><div class='docblock'><p>Set whether the decorations should be drawn as maximized or not</p>
|
||
<p>Calling this should <em>not</em> trigger a redraw, but return <code>true</code> if
|
||
a redraw is needed.</p>
|
||
</div><h3 id='tymethod.set_hidden' class='method'><span id='set_hidden.v' class='invisible'><code>fn <a href='#tymethod.set_hidden' class='fnname'>set_hidden</a>(&mut self, hidden: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>)</code></span></h3><div class='docblock'><p>Hide or show the decorations</p>
|
||
<p>Calling this should <em>not</em> trigger a redraw</p>
|
||
</div><h3 id='tymethod.set_resizable' class='method'><span id='set_resizable.v' class='invisible'><code>fn <a href='#tymethod.set_resizable' class='fnname'>set_resizable</a>(&mut self, resizable: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>)</code></span></h3><div class='docblock'><p>Set whether interactive resize hints should be displayed
|
||
and reacted to</p>
|
||
</div><h3 id='tymethod.new_seat' class='method'><span id='new_seat.v' class='invisible'><code>fn <a href='#tymethod.new_seat' class='fnname'>new_seat</a>(&mut self, seat: &<a class="struct" href="../../smithay_client_toolkit/reexports/client/struct.Proxy.html" title="struct smithay_client_toolkit::reexports::client::Proxy">Proxy</a><<a class="struct" href="../../smithay_client_toolkit/reexports/client/protocol/wl_seat/struct.WlSeat.html" title="struct smithay_client_toolkit::reexports::client::protocol::wl_seat::WlSeat">WlSeat</a>>)</code></span></h3><div class='docblock'><p>Notify that a new wl_seat should be handled</p>
|
||
</div><h3 id='tymethod.resize' class='method'><span id='resize.v' class='invisible'><code>fn <a href='#tymethod.resize' class='fnname'>resize</a>(&mut self, newsize: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>)</code></span></h3><div class='docblock'><p>Change the size of the decorations</p>
|
||
<p>Calling this should <em>not</em> trigger a redraw</p>
|
||
</div><h3 id='tymethod.redraw' class='method'><span id='redraw.v' class='invisible'><code>fn <a href='#tymethod.redraw' class='fnname'>redraw</a>(&mut self)</code></span></h3><div class='docblock'><p>Redraw the decorations</p>
|
||
</div><h3 id='tymethod.subtract_borders' class='method'><span id='subtract_borders.v' class='invisible'><code>fn <a href='#tymethod.subtract_borders' class='fnname'>subtract_borders</a>(&self, width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></span></h3><div class='docblock'><p>Subtracts the border dimensions from the given dimensions.</p>
|
||
</div><h3 id='tymethod.add_borders' class='method'><span id='add_borders.v' class='invisible'><code>fn <a href='#tymethod.add_borders' class='fnname'>add_borders</a>(&self, width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></span></h3><div class='docblock'><p>Adds the border dimensions to the given dimensions.</p>
|
||
</div></div>
|
||
<h2 id='provided-methods' class='small-section-header'>
|
||
Provided Methods<a href='#provided-methods' class='anchor'></a>
|
||
</h2>
|
||
<div class='methods'>
|
||
<h3 id='method.location' class='method'><span id='location.v' class='invisible'><code>fn <a href='#method.location' class='fnname'>location</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></span></h3><div class='docblock'><p>Returns the coordinates of the top-left corner of the borders relative to the content</p>
|
||
<p>Values should thus be negative</p>
|
||
</div></div><h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><ul class='item-list' id='implementors-list'><li><table class='table-display'><tbody><tr><td><code>impl Frame for <a class="struct" href="../../smithay_client_toolkit/window/struct.BasicFrame.html" title="struct smithay_client_toolkit::window::BasicFrame">BasicFrame</a><span class="where fmt-newline"> type <a href='#associatedtype.Error' class="type">Error</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>;</span></code><td><div class='out-of-band'><a class='srclink' href='../../src/smithay_client_toolkit/window/basic_frame.rs.html#224-657' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||
src="../../implementors/smithay_client_toolkit/window/trait.Frame.js">
|
||
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "smithay_client_toolkit";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |