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 `EventLoop` trait in crate `event_loop`."><meta name="keywords" content="rust, rustlang, rust-lang, EventLoop"><title>event_loop::EventLoop - 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 EventLoop</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_event_settings">get_event_settings</a><a href="#tymethod.set_event_settings">set_event_settings</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.set_ups">set_ups</a><a href="#method.ups">ups</a><a href="#method.set_ups_reset">set_ups_reset</a><a href="#method.ups_reset">ups_reset</a><a href="#method.set_max_fps">set_max_fps</a><a href="#method.max_fps">max_fps</a><a href="#method.set_swap_buffers">set_swap_buffers</a><a href="#method.swap_buffers">swap_buffers</a><a href="#method.set_bench_mode">set_bench_mode</a><a href="#method.bench_mode">bench_mode</a><a href="#method.set_lazy">set_lazy</a><a href="#method.lazy">lazy</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>event_loop</a></p><script>window.sidebarCurrent = {name: 'EventLoop', 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'>event_loop</a>::<wbr><a class="trait" href=''>EventLoop</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#377-482' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait EventLoop: <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_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>;
|
||
<div class='item-spacer'></div> fn <a href='#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>);
|
||
|
||
fn <a href='#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>) { ... }
|
||
<div class='item-spacer'></div> fn <a href='#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 { ... }
|
||
<div class='item-spacer'></div> fn <a href='#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>) { ... }
|
||
<div class='item-spacer'></div> fn <a href='#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 { ... }
|
||
<div class='item-spacer'></div> fn <a href='#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>) { ... }
|
||
<div class='item-spacer'></div> fn <a href='#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 { ... }
|
||
<div class='item-spacer'></div> fn <a href='#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>) { ... }
|
||
<div class='item-spacer'></div> fn <a href='#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 { ... }
|
||
<div class='item-spacer'></div> fn <a href='#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>) { ... }
|
||
<div class='item-spacer'></div> fn <a href='#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 { ... }
|
||
<div class='item-spacer'></div> fn <a href='#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>) { ... }
|
||
<div class='item-spacer'></div> fn <a href='#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 { ... }
|
||
}</pre></div><div class='docblock'><p>Methods implemented for changing event loop settings.</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_event_settings' class='method'><span id='get_event_settings.v' class='invisible'><code>fn <a href='#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></h3><div class='docblock'><p>Returns event loop settings.</p>
|
||
</div><h3 id='tymethod.set_event_settings' class='method'><span id='set_event_settings.v' class='invisible'><code>fn <a href='#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></h3><div class='docblock'><p>Sets event loop settings.</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.set_ups' class='method'><span id='set_ups.v' class='invisible'><code>fn <a href='#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></h3><div class='docblock'><p>The number of updates per second</p>
|
||
<p>This is the fixed update rate on average over time.
|
||
If the event loop lags, it will try to catch up.
|
||
When set to <code>0</code>, update events are disabled.</p>
|
||
</div><h3 id='method.ups' class='method'><span id='ups.v' class='invisible'><code>fn <a href='#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></h3><div class='docblock'><p>The number of updates per second</p>
|
||
<p>This is the fixed update rate on average over time.
|
||
If the event loop lags, it will try to catch up.
|
||
When set to <code>0</code>, update events are disabled.</p>
|
||
</div><h3 id='method.set_ups_reset' class='method'><span id='set_ups_reset.v' class='invisible'><code>fn <a href='#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></h3><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.</p>
|
||
</div><h3 id='method.ups_reset' class='method'><span id='ups_reset.v' class='invisible'><code>fn <a href='#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></h3><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.</p>
|
||
</div><h3 id='method.set_max_fps' class='method'><span id='set_max_fps.v' class='invisible'><code>fn <a href='#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></h3><div class='docblock'><p>The maximum number of frames per second</p>
|
||
<p>The frame rate can be lower because the
|
||
next frame is always scheduled from the previous frame.
|
||
This causes the frames to "slip" over time.</p>
|
||
</div><h3 id='method.max_fps' class='method'><span id='max_fps.v' class='invisible'><code>fn <a href='#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></h3><div class='docblock'><p>The maximum number of frames per second</p>
|
||
<p>The frame rate can be lower because the
|
||
next frame is always scheduled from the previous frame.
|
||
This causes the frames to "slip" over time.</p>
|
||
</div><h3 id='method.set_swap_buffers' class='method'><span id='set_swap_buffers.v' class='invisible'><code>fn <a href='#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></h3><div class='docblock'><p>Enable or disable automatic swapping of buffers.</p>
|
||
</div><h3 id='method.swap_buffers' class='method'><span id='swap_buffers.v' class='invisible'><code>fn <a href='#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></h3><div class='docblock'><p>Enable or disable automatic swapping of buffers.</p>
|
||
</div><h3 id='method.set_bench_mode' class='method'><span id='set_bench_mode.v' class='invisible'><code>fn <a href='#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></h3><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>.</p>
|
||
</div><h3 id='method.bench_mode' class='method'><span id='bench_mode.v' class='invisible'><code>fn <a href='#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></h3><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>.</p>
|
||
</div><h3 id='method.set_lazy' class='method'><span id='set_lazy.v' class='invisible'><code>fn <a href='#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></h3><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.</p>
|
||
</div><h3 id='method.lazy' class='method'><span id='lazy.v' class='invisible'><code>fn <a href='#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></h3><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.</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 EventLoop for <a class="struct" href="../event_loop/struct.EventSettings.html" title="struct event_loop::EventSettings">EventSettings</a></code><td><div class='out-of-band'><a class='srclink' href='../src/event_loop/lib.rs.html#484-491' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl EventLoop for <a class="struct" href="../event_loop/struct.Events.html" title="struct event_loop::Events">Events</a></code><td><div class='out-of-band'><a class='srclink' href='../src/event_loop/lib.rs.html#493-501' 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/event_loop/trait.EventLoop.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 = "event_loop";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |