mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 19:18:44 +00:00
70 lines
16 KiB
HTML
70 lines
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="API documentation for the Rust `AdvancedWindow` trait in crate `window`."><meta name="keywords" content="rust, rustlang, rust-lang, AdvancedWindow"><title>window::AdvancedWindow - 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 AdvancedWindow</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.get_title">get_title</a><a href="#tymethod.set_title">set_title</a><a href="#tymethod.get_exit_on_esc">get_exit_on_esc</a><a href="#tymethod.set_exit_on_esc">set_exit_on_esc</a><a href="#tymethod.set_capture_cursor">set_capture_cursor</a><a href="#tymethod.show">show</a><a href="#tymethod.hide">hide</a><a href="#tymethod.get_position">get_position</a><a href="#tymethod.set_position">set_position</a><a href="#tymethod.set_size">set_size</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.title">title</a><a href="#method.exit_on_esc">exit_on_esc</a><a href="#method.capture_cursor">capture_cursor</a><a href="#method.position">position</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>window</a></p><script>window.sidebarCurrent = {name: 'AdvancedWindow', 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'>window</a>::<wbr><a class="trait" href=''>AdvancedWindow</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/window/lib.rs.html#213-304' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait AdvancedWindow: <a class="trait" href="../window/trait.Window.html" title="trait window::Window">Window</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
fn <a href='#tymethod.get_title' class='fnname'>get_title</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.set_title' class='fnname'>set_title</a>(&mut self, value: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.get_exit_on_esc' class='fnname'>get_exit_on_esc</a>(&self) -> <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_exit_on_esc' class='fnname'>set_exit_on_esc</a>(&mut self, value: <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_capture_cursor' class='fnname'>set_capture_cursor</a>(&mut self, value: <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.show' class='fnname'>show</a>(&mut self);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.hide' class='fnname'>hide</a>(&mut self);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.get_position' class='fnname'>get_position</a>(&self) -> <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="../window/struct.Position.html" title="struct window::Position">Position</a>>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.set_position' class='fnname'>set_position</a><P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../window/struct.Position.html" title="struct window::Position">Position</a>>>(&mut self, val: P);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.set_size' class='fnname'>set_size</a><S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../window/struct.Size.html" title="struct window::Size">Size</a>>>(&mut self, val: S);
|
||
|
||
fn <a href='#method.title' class='fnname'>title</a>(self, value: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> Self { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.exit_on_esc' class='fnname'>exit_on_esc</a>(self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> Self { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.capture_cursor' class='fnname'>capture_cursor</a>(self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> Self { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.position' class='fnname'>position</a><P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../window/struct.Position.html" title="struct window::Position">Position</a>>>(self, val: P) -> Self { ... }
|
||
}</pre></div><div class='docblock'><p>Trait representing a window with the most features that are still generic.</p>
|
||
<p>This trait is implemented by fully featured window back-ends. When possible,
|
||
reduce the trait constraint to <code>Window</code> to make the code more portable.</p>
|
||
<p>The <code>Sized</code> trait is required for method chaining.</p>
|
||
</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.get_title' class='method'><span id='get_title.v' class='invisible'><code>fn <a href='#tymethod.get_title' class='fnname'>get_title</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span></h3><div class='docblock'><p>Gets a copy of the title of the window.</p>
|
||
</div><h3 id='tymethod.set_title' class='method'><span id='set_title.v' class='invisible'><code>fn <a href='#tymethod.set_title' class='fnname'>set_title</a>(&mut self, value: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></h3><div class='docblock'><p>Sets the title of the window.</p>
|
||
</div><h3 id='tymethod.get_exit_on_esc' class='method'><span id='get_exit_on_esc.v' class='invisible'><code>fn <a href='#tymethod.get_exit_on_esc' class='fnname'>get_exit_on_esc</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h3><div class='docblock'><p>Gets whether to exit when pressing esc.</p>
|
||
<p>Useful when prototyping.</p>
|
||
</div><h3 id='tymethod.set_exit_on_esc' class='method'><span id='set_exit_on_esc.v' class='invisible'><code>fn <a href='#tymethod.set_exit_on_esc' class='fnname'>set_exit_on_esc</a>(&mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>)</code></span></h3><div class='docblock'><p>Sets whether to exit when pressing esc.</p>
|
||
<p>Useful when prototyping.</p>
|
||
</div><h3 id='tymethod.set_capture_cursor' class='method'><span id='set_capture_cursor.v' class='invisible'><code>fn <a href='#tymethod.set_capture_cursor' class='fnname'>set_capture_cursor</a>(&mut self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>)</code></span></h3><div class='docblock'><p>Sets whether to capture/grab the cursor.</p>
|
||
<p>This is used to lock and hide cursor to the window,
|
||
for example in a first-person shooter game.</p>
|
||
</div><h3 id='tymethod.show' class='method'><span id='show.v' class='invisible'><code>fn <a href='#tymethod.show' class='fnname'>show</a>(&mut self)</code></span></h3><div class='docblock'><p>Shows the window.</p>
|
||
<p>If the platform does not support this, it will have no effect.</p>
|
||
</div><h3 id='tymethod.hide' class='method'><span id='hide.v' class='invisible'><code>fn <a href='#tymethod.hide' class='fnname'>hide</a>(&mut self)</code></span></h3><div class='docblock'><p>Hides the window.</p>
|
||
<p>If the platform does not support this, it will have no effect.</p>
|
||
</div><h3 id='tymethod.get_position' class='method'><span id='get_position.v' class='invisible'><code>fn <a href='#tymethod.get_position' class='fnname'>get_position</a>(&self) -> <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="../window/struct.Position.html" title="struct window::Position">Position</a>></code></span></h3><div class='docblock'><p>Gets the position of window.</p>
|
||
</div><h3 id='tymethod.set_position' class='method'><span id='set_position.v' class='invisible'><code>fn <a href='#tymethod.set_position' class='fnname'>set_position</a><P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../window/struct.Position.html" title="struct window::Position">Position</a>>>(&mut self, val: P)</code></span></h3><div class='docblock'><p>Sets the position of window.</p>
|
||
<p>Has no effect if the window no longer has a position.</p>
|
||
</div><h3 id='tymethod.set_size' class='method'><span id='set_size.v' class='invisible'><code>fn <a href='#tymethod.set_size' class='fnname'>set_size</a><S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../window/struct.Size.html" title="struct window::Size">Size</a>>>(&mut self, val: S)</code></span></h3><div class='docblock'><p>Sets the window size.</p>
|
||
<p>Has no effect if the window no longer has a size.</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.title' class='method'><span id='title.v' class='invisible'><code>fn <a href='#method.title' class='fnname'>title</a>(self, value: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> Self</code></span></h3><div class='docblock'><p>Sets title on window.</p>
|
||
<p>This method moves the current window data,
|
||
unlike <a href="#tymethod.set_title"><code>set_title()</code></a>, so
|
||
that it can be used in method chaining.</p>
|
||
</div><h3 id='method.exit_on_esc' class='method'><span id='exit_on_esc.v' class='invisible'><code>fn <a href='#method.exit_on_esc' class='fnname'>exit_on_esc</a>(self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> Self</code></span></h3><div class='docblock'><p>Sets whether to exit when pressing the Esc button.</p>
|
||
<p>Useful when prototyping.</p>
|
||
<p>This method moves the current window data,
|
||
unlike <a href="#tymethod.set_exit_on_esc"><code>set_exit_on_esc()</code></a>, so
|
||
that it can be used in method chaining.</p>
|
||
</div><h3 id='method.capture_cursor' class='method'><span id='capture_cursor.v' class='invisible'><code>fn <a href='#method.capture_cursor' class='fnname'>capture_cursor</a>(self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> Self</code></span></h3><div class='docblock'><p>Sets whether to capture/grab the cursor.</p>
|
||
<p>This method moves the current window data,
|
||
unlike <a href="#tymethod.set_capture_cursor"><code>set_capture_cursor()</code></a>, so
|
||
that it can be used in method chaining.</p>
|
||
</div><h3 id='method.position' class='method'><span id='position.v' class='invisible'><code>fn <a href='#method.position' class='fnname'>position</a><P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../window/struct.Position.html" title="struct window::Position">Position</a>>>(self, val: P) -> Self</code></span></h3><div class='docblock'><p>Sets the position of window.</p>
|
||
<p>Has no effect if the window no longer has a position.</p>
|
||
<p>This method moves the current window data,
|
||
unlike <a href="#tymethod.set_position"><code>set_position()</code></a>, so
|
||
that it can be used in method chaining.</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 AdvancedWindow for <a class="struct" href="../window/struct.NoWindow.html" title="struct window::NoWindow">NoWindow</a></code><td><div class='out-of-band'><a class='srclink' href='../src/window/no_window.rs.html#80-112' 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/window/trait.AdvancedWindow.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 = "window";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |