mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-05 03:28:41 +00:00
18 lines
21 KiB
HTML
18 lines
21 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 `BasicFrame` struct in crate `smithay_client_toolkit`."><meta name="keywords" content="rust, rustlang, rust-lang, BasicFrame"><title>smithay_client_toolkit::window::BasicFrame - 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 struct"><!--[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'>Struct BasicFrame</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Frame">Frame</a><a href="#impl-Drop">Drop</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>smithay_client_toolkit</a>::<wbr><a href='index.html'>window</a></p><script>window.sidebarCurrent = {name: 'BasicFrame', ty: 'struct', 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'>Struct <a href='../index.html'>smithay_client_toolkit</a>::<wbr><a href='index.html'>window</a>::<wbr><a class="struct" href=''>BasicFrame</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/basic_frame.rs.html#214-222' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct BasicFrame { /* fields omitted */ }</pre></div><div class='docblock'><p>A minimalistic set of decorations</p>
|
|||
|
|
<p>This class draws minimalistic decorations, which are arguably not very
|
|||
|
|
beautiful, but functional.</p>
|
|||
|
|
</div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Frame' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../smithay_client_toolkit/window/trait.Frame.html" title="trait smithay_client_toolkit::window::Frame">Frame</a> for <a class="struct" href="../../smithay_client_toolkit/window/struct.BasicFrame.html" title="struct smithay_client_toolkit::window::BasicFrame">BasicFrame</a></code><a href='#impl-Frame' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/window/basic_frame.rs.html#224-657' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='../../smithay_client_toolkit/window/trait.Frame.html#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></code></span></h4>
|
|||
|
|
<div class='docblock'><p>Type of errors that may occur when attempting to create a frame</p>
|
|||
|
|
</div><h4 id='method.init' class="method"><span id='init.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../smithay_client_toolkit/window/trait.Frame.html#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><<a class="struct" href="../../smithay_client_toolkit/window/struct.BasicFrame.html" title="struct smithay_client_toolkit::window::BasicFrame">BasicFrame</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>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/window/basic_frame.rs.html#226-266' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Initialize the Frame</p>
|
|||
|
|
</div><h4 id='method.new_seat' class="method"><span id='new_seat.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../smithay_client_toolkit/window/trait.Frame.html#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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/window/basic_frame.rs.html#268-357' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Notify that a new wl_seat should be handled</p>
|
|||
|
|
</div><h4 id='method.set_active' class="method"><span id='set_active.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../smithay_client_toolkit/window/trait.Frame.html#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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/window/basic_frame.rs.html#359-366' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set whether the decorations should be drawn as active or not <a href="../../smithay_client_toolkit/window/trait.Frame.html#tymethod.set_active">Read more</a></p>
|
|||
|
|
</div><h4 id='method.set_hidden' class="method"><span id='set_hidden.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../smithay_client_toolkit/window/trait.Frame.html#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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/window/basic_frame.rs.html#368-370' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Hide or show the decorations <a href="../../smithay_client_toolkit/window/trait.Frame.html#tymethod.set_hidden">Read more</a></p>
|
|||
|
|
</div><h4 id='method.set_maximized' class="method"><span id='set_maximized.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../smithay_client_toolkit/window/trait.Frame.html#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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/window/basic_frame.rs.html#372-380' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set whether the decorations should be drawn as maximized or not <a href="../../smithay_client_toolkit/window/trait.Frame.html#tymethod.set_maximized">Read more</a></p>
|
|||
|
|
</div><h4 id='method.set_resizable' class="method"><span id='set_resizable.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../smithay_client_toolkit/window/trait.Frame.html#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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/window/basic_frame.rs.html#382-384' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set whether interactive resize hints should be displayed and reacted to <a href="../../smithay_client_toolkit/window/trait.Frame.html#tymethod.set_resizable">Read more</a></p>
|
|||
|
|
</div><h4 id='method.resize' class="method"><span id='resize.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../smithay_client_toolkit/window/trait.Frame.html#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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/window/basic_frame.rs.html#386-388' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Change the size of the decorations <a href="../../smithay_client_toolkit/window/trait.Frame.html#tymethod.resize">Read more</a></p>
|
|||
|
|
</div><h4 id='method.redraw' class="method"><span id='redraw.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../smithay_client_toolkit/window/trait.Frame.html#tymethod.redraw' class='fnname'>redraw</a>(&mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/window/basic_frame.rs.html#390-632' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Redraw the decorations</p>
|
|||
|
|
</div><h4 id='method.subtract_borders' class="method"><span id='subtract_borders.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../smithay_client_toolkit/window/trait.Frame.html#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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/window/basic_frame.rs.html#634-640' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Subtracts the border dimensions from the given dimensions.</p>
|
|||
|
|
</div><h4 id='method.add_borders' class="method"><span id='add_borders.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../smithay_client_toolkit/window/trait.Frame.html#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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/window/basic_frame.rs.html#642-648' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Adds the border dimensions to the given dimensions.</p>
|
|||
|
|
</div><h4 id='method.location' class="method"><span id='location.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../smithay_client_toolkit/window/trait.Frame.html#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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/window/basic_frame.rs.html#650-656' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the coordinates of the top-left corner of the borders relative to the content <a href="../../smithay_client_toolkit/window/trait.Frame.html#method.location">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-Drop' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../../smithay_client_toolkit/window/struct.BasicFrame.html" title="struct smithay_client_toolkit::window::BasicFrame">BasicFrame</a></code><a href='#impl-Drop' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/window/basic_frame.rs.html#659-669' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.drop' class="method"><span id='drop.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop' class='fnname'>drop</a>(&mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/window/basic_frame.rs.html#660-668' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
|
|||
|
|
</div></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../smithay_client_toolkit/window/struct.BasicFrame.html" title="struct smithay_client_toolkit::window::BasicFrame">BasicFrame</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../smithay_client_toolkit/window/struct.BasicFrame.html" title="struct smithay_client_toolkit::window::BasicFrame">BasicFrame</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></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>
|