mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 19:18:44 +00:00
23 lines
22 KiB
HTML
23 lines
22 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 `Events` struct in crate `event_loop`."><meta name="keywords" content="rust, rustlang, rust-lang, Events"><title>event_loop::Events - 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 Events</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.next">next</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Copy">Copy</a><a href="#impl-Clone">Clone</a><a href="#impl-EventLoop">EventLoop</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'>event_loop</a></p><script>window.sidebarCurrent = {name: 'Events', 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'>event_loop</a>::<wbr><a class="struct" href=''>Events</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/event_loop/lib.rs.html#87-96' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Events { /* fields omitted */ }</pre></div><div class='docblock'><p>An event loop iterator</p>
|
||
<p><em>Warning: Because the iterator polls events from the window back-end,
|
||
it must be used on the same thread as the window back-end (usually main thread),
|
||
unless the window back-end supports multi-thread event polling.</em></p>
|
||
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../event_loop/struct.Events.html" title="struct event_loop::Events">Events</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/event_loop/lib.rs.html#117-374' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>(settings: <a class="struct" href="../event_loop/struct.EventSettings.html" title="struct event_loop::EventSettings">EventSettings</a>) -> <a class="struct" href="../event_loop/struct.Events.html" title="struct event_loop::Events">Events</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/event_loop/lib.rs.html#119-139' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new event iterator with default UPS and FPS settings.</p>
|
||
</div><h4 id='method.next' class="method"><span id='next.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.next' class='fnname'>next</a><W>(&mut self, window: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>W) -> <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.Event.html" title="enum input::Event">Event</a>> <span class="where fmt-newline">where<br> W: <a class="trait" href="../window/trait.Window.html" title="trait window::Window">Window</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/event_loop/lib.rs.html#142-373' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the next event.</p>
|
||
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Copy' 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.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="../event_loop/struct.Events.html" title="struct event_loop::Events">Events</a></code><a href='#impl-Copy' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/event_loop/lib.rs.html#86' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Clone' 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/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../event_loop/struct.Events.html" title="struct event_loop::Events">Events</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/event_loop/lib.rs.html#86' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../event_loop/struct.Events.html" title="struct event_loop::Events">Events</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/event_loop/lib.rs.html#86' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></div><h3 id='impl-EventLoop' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../event_loop/trait.EventLoop.html" title="trait event_loop::EventLoop">EventLoop</a> for <a class="struct" href="../event_loop/struct.Events.html" title="struct event_loop::Events">Events</a></code><a href='#impl-EventLoop' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/event_loop/lib.rs.html#493-501' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.get_event_settings' class="method"><span id='get_event_settings.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../event_loop/trait.EventLoop.html#tymethod.get_event_settings' class='fnname'>get_event_settings</a>(&self) -> <a class="struct" href="../event_loop/struct.EventSettings.html" title="struct event_loop::EventSettings">EventSettings</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/event_loop/lib.rs.html#494-496' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns event loop settings.</p>
|
||
</div><h4 id='method.set_event_settings' class="method"><span id='set_event_settings.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../event_loop/trait.EventLoop.html#tymethod.set_event_settings' class='fnname'>set_event_settings</a>(&mut self, settings: <a class="struct" href="../event_loop/struct.EventSettings.html" title="struct event_loop::EventSettings">EventSettings</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/event_loop/lib.rs.html#497-500' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets event loop settings.</p>
|
||
</div><h4 id='method.set_ups' class="method"><span id='set_ups.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../event_loop/trait.EventLoop.html#method.set_ups' class='fnname'>set_ups</a>(&mut self, frames: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/event_loop/lib.rs.html#388-391' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>The number of updates per second <a href="../event_loop/trait.EventLoop.html#method.set_ups">Read more</a></p>
|
||
</div><h4 id='method.ups' class="method"><span id='ups.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../event_loop/trait.EventLoop.html#method.ups' class='fnname'>ups</a>(self, frames: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/event_loop/lib.rs.html#398-401' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>The number of updates per second <a href="../event_loop/trait.EventLoop.html#method.ups">Read more</a></p>
|
||
</div><h4 id='method.set_ups_reset' class="method"><span id='set_ups_reset.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../event_loop/trait.EventLoop.html#method.set_ups_reset' class='fnname'>set_ups_reset</a>(&mut self, frames: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/event_loop/lib.rs.html#405-408' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>The number of delayed updates before skipping them to catch up. When set to <code>0</code>, it will always try to catch up. <a href="../event_loop/trait.EventLoop.html#method.set_ups_reset">Read more</a></p>
|
||
</div><h4 id='method.ups_reset' class="method"><span id='ups_reset.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../event_loop/trait.EventLoop.html#method.ups_reset' class='fnname'>ups_reset</a>(self, frames: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/event_loop/lib.rs.html#412-415' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>The number of delayed updates before skipping them to catch up. When set to <code>0</code>, it will always try to catch up. <a href="../event_loop/trait.EventLoop.html#method.ups_reset">Read more</a></p>
|
||
</div><h4 id='method.set_max_fps' class="method"><span id='set_max_fps.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../event_loop/trait.EventLoop.html#method.set_max_fps' class='fnname'>set_max_fps</a>(&mut self, frames: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/event_loop/lib.rs.html#422-425' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>The maximum number of frames per second <a href="../event_loop/trait.EventLoop.html#method.set_max_fps">Read more</a></p>
|
||
</div><h4 id='method.max_fps' class="method"><span id='max_fps.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../event_loop/trait.EventLoop.html#method.max_fps' class='fnname'>max_fps</a>(self, frames: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/event_loop/lib.rs.html#432-435' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>The maximum number of frames per second <a href="../event_loop/trait.EventLoop.html#method.max_fps">Read more</a></p>
|
||
</div><h4 id='method.set_swap_buffers' class="method"><span id='set_swap_buffers.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../event_loop/trait.EventLoop.html#method.set_swap_buffers' class='fnname'>set_swap_buffers</a>(&mut self, enable: <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/event_loop/lib.rs.html#438-441' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Enable or disable automatic swapping of buffers.</p>
|
||
</div><h4 id='method.swap_buffers' class="method"><span id='swap_buffers.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../event_loop/trait.EventLoop.html#method.swap_buffers' class='fnname'>swap_buffers</a>(self, enable: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/event_loop/lib.rs.html#444-447' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Enable or disable automatic swapping of buffers.</p>
|
||
</div><h4 id='method.set_bench_mode' class="method"><span id='set_bench_mode.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../event_loop/trait.EventLoop.html#method.set_bench_mode' class='fnname'>set_bench_mode</a>(&mut self, enable: <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/event_loop/lib.rs.html#453-456' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Enable or disable benchmark mode. When enabled, it will render and update without sleep and ignore input. Used to test performance by playing through as fast as possible. Requires <code>lazy</code> to be set to <code>false</code>. <a href="../event_loop/trait.EventLoop.html#method.set_bench_mode">Read more</a></p>
|
||
</div><h4 id='method.bench_mode' class="method"><span id='bench_mode.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../event_loop/trait.EventLoop.html#method.bench_mode' class='fnname'>bench_mode</a>(self, enable: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/event_loop/lib.rs.html#462-465' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Enable or disable benchmark mode. When enabled, it will render and update without sleep and ignore input. Used to test performance by playing through as fast as possible. Requires <code>lazy</code> to be set to <code>false</code>. <a href="../event_loop/trait.EventLoop.html#method.bench_mode">Read more</a></p>
|
||
</div><h4 id='method.set_lazy' class="method"><span id='set_lazy.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../event_loop/trait.EventLoop.html#method.set_lazy' class='fnname'>set_lazy</a>(&mut self, enable: <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/event_loop/lib.rs.html#470-473' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Enable or disable rendering only when receiving input. When enabled, update events are disabled. Idle events are emitted while receiving input. <a href="../event_loop/trait.EventLoop.html#method.set_lazy">Read more</a></p>
|
||
</div><h4 id='method.lazy' class="method"><span id='lazy.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../event_loop/trait.EventLoop.html#method.lazy' class='fnname'>lazy</a>(self, enable: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/event_loop/lib.rs.html#478-481' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Enable or disable rendering only when receiving input. When enabled, update events are disabled. Idle events are emitted while receiving input. <a href="../event_loop/trait.EventLoop.html#method.lazy">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="../event_loop/struct.Events.html" title="struct event_loop::Events">Events</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="../event_loop/struct.Events.html" title="struct event_loop::Events">Events</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 = "event_loop";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |