mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 19:18:44 +00:00
40 lines
11 KiB
HTML
40 lines
11 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 `Window` trait in crate `window`."><meta name="keywords" content="rust, rustlang, rust-lang, Window"><title>window::Window - 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 Window</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.set_should_close">set_should_close</a><a href="#tymethod.should_close">should_close</a><a href="#tymethod.size">size</a><a href="#tymethod.swap_buffers">swap_buffers</a><a href="#tymethod.wait_event">wait_event</a><a href="#tymethod.wait_event_timeout">wait_event_timeout</a><a href="#tymethod.poll_event">poll_event</a><a href="#tymethod.draw_size">draw_size</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: 'Window', 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=''>Window</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#166-205' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait Window {
|
||
fn <a href='#tymethod.set_should_close' class='fnname'>set_should_close</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.should_close' class='fnname'>should_close</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.size' class='fnname'>size</a>(&self) -> <a class="struct" href="../window/struct.Size.html" title="struct window::Size">Size</a>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.swap_buffers' class='fnname'>swap_buffers</a>(&mut self);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.wait_event' class='fnname'>wait_event</a>(&mut self) -> <a class="enum" href="../input/enum.Input.html" title="enum input::Input">Input</a>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.wait_event_timeout' class='fnname'>wait_event_timeout</a>(&mut self, timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../input/enum.Input.html" title="enum input::Input">Input</a>>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.poll_event' class='fnname'>poll_event</a>(&mut 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="enum" href="../input/enum.Input.html" title="enum input::Input">Input</a>>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.draw_size' class='fnname'>draw_size</a>(&self) -> <a class="struct" href="../window/struct.Size.html" title="struct window::Size">Size</a>;
|
||
}</pre></div><div class='docblock'><p>Trait representing the minimum requirements for defining a window.</p>
|
||
<p>This trait defines all the behavior needed for making an event loop.</p>
|
||
<p>An example of a working event loop can be found in the Piston-Tutorials
|
||
repository under getting-started, or in the event loop examples.</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.set_should_close' class='method'><span id='set_should_close.v' class='invisible'><code>fn <a href='#tymethod.set_should_close' class='fnname'>set_should_close</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>Tells the window to close or stay open.</p>
|
||
</div><h3 id='tymethod.should_close' class='method'><span id='should_close.v' class='invisible'><code>fn <a href='#tymethod.should_close' class='fnname'>should_close</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>Returns true if the window should close.</p>
|
||
</div><h3 id='tymethod.size' class='method'><span id='size.v' class='invisible'><code>fn <a href='#tymethod.size' class='fnname'>size</a>(&self) -> <a class="struct" href="../window/struct.Size.html" title="struct window::Size">Size</a></code></span></h3><div class='docblock'><p>Gets the size of the window.</p>
|
||
</div><h3 id='tymethod.swap_buffers' class='method'><span id='swap_buffers.v' class='invisible'><code>fn <a href='#tymethod.swap_buffers' class='fnname'>swap_buffers</a>(&mut self)</code></span></h3><div class='docblock'><p>Swaps render buffers.</p>
|
||
<p>When this is set to false, this method must be called manually
|
||
or through the window backend. By default it is set to true, so
|
||
usually it is not needed in application code.</p>
|
||
</div><h3 id='tymethod.wait_event' class='method'><span id='wait_event.v' class='invisible'><code>fn <a href='#tymethod.wait_event' class='fnname'>wait_event</a>(&mut self) -> <a class="enum" href="../input/enum.Input.html" title="enum input::Input">Input</a></code></span></h3><div class='docblock'><p>Wait indefinitely for an input event to be available from the window.</p>
|
||
</div><h3 id='tymethod.wait_event_timeout' class='method'><span id='wait_event_timeout.v' class='invisible'><code>fn <a href='#tymethod.wait_event_timeout' class='fnname'>wait_event_timeout</a>(&mut self, timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../input/enum.Input.html" title="enum input::Input">Input</a>></code></span></h3><div class='docblock'><p>Wait for an input event to be available from the window or for the
|
||
specified timeout to be reached.</p>
|
||
<p>Returns <code>None</code> only if there is no input event within the timeout.</p>
|
||
</div><h3 id='tymethod.poll_event' class='method'><span id='poll_event.v' class='invisible'><code>fn <a href='#tymethod.poll_event' class='fnname'>poll_event</a>(&mut 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="enum" href="../input/enum.Input.html" title="enum input::Input">Input</a>></code></span></h3><div class='docblock'><p>Polls an input event from the window.</p>
|
||
<p>Return <code>None</code> if no events available.</p>
|
||
</div><h3 id='tymethod.draw_size' class='method'><span id='draw_size.v' class='invisible'><code>fn <a href='#tymethod.draw_size' class='fnname'>draw_size</a>(&self) -> <a class="struct" href="../window/struct.Size.html" title="struct window::Size">Size</a></code></span></h3><div class='docblock'><p>Gets the draw size of the window.</p>
|
||
<p>This is equal to the size of the frame buffer of the inner window,
|
||
excluding the title bar and borders.</p>
|
||
<p>This information is given to the client code through the
|
||
<a href="../input/enum.Event.html"><code>Render</code></a> event.</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 Window 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#39-69' 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.Window.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> |