mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 19:18:44 +00:00
37 lines
14 KiB
HTML
37 lines
14 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 `KeyboardInput` struct in crate `winit`."><meta name="keywords" content="rust, rustlang, rust-lang, KeyboardInput"><title>winit::KeyboardInput - 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 KeyboardInput</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.scancode">scancode</a><a href="#structfield.state">state</a><a href="#structfield.virtual_keycode">virtual_keycode</a><a href="#structfield.modifiers">modifiers</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Clone">Clone</a><a href="#impl-Copy">Copy</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'>winit</a></p><script>window.sidebarCurrent = {name: 'KeyboardInput', 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'>winit</a>::<wbr><a class="struct" href=''>KeyboardInput</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/winit/events.rs.html#151-172' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct KeyboardInput {
|
|||
|
|
pub scancode: <a class="type" href="../winit/type.ScanCode.html" title="type winit::ScanCode">ScanCode</a>,
|
|||
|
|
pub state: <a class="enum" href="../winit/enum.ElementState.html" title="enum winit::ElementState">ElementState</a>,
|
|||
|
|
pub virtual_keycode: <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="../winit/enum.VirtualKeyCode.html" title="enum winit::VirtualKeyCode">VirtualKeyCode</a>>,
|
|||
|
|
pub modifiers: <a class="struct" href="../winit/struct.ModifiersState.html" title="struct winit::ModifiersState">ModifiersState</a>,
|
|||
|
|
}</pre></div><div class='docblock'><p>Describes a keyboard input event.</p>
|
|||
|
|
</div><h2 id='fields' class='fields small-section-header'>
|
|||
|
|
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.scancode" class="structfield small-section-header">
|
|||
|
|
<a href="#structfield.scancode" class="anchor field"></a>
|
|||
|
|
<span id="scancode.v" class='invisible'>
|
|||
|
|
<code>scancode: <a class="type" href="../winit/type.ScanCode.html" title="type winit::ScanCode">ScanCode</a></code>
|
|||
|
|
</span></span><div class='docblock'><p>Identifies the physical key pressed</p>
|
|||
|
|
<p>This should not change if the user adjusts the host's keyboard map. Use when the physical location of the
|
|||
|
|
key is more important than the key's host GUI semantics, such as for movement controls in a first-person
|
|||
|
|
game.</p>
|
|||
|
|
</div><span id="structfield.state" class="structfield small-section-header">
|
|||
|
|
<a href="#structfield.state" class="anchor field"></a>
|
|||
|
|
<span id="state.v" class='invisible'>
|
|||
|
|
<code>state: <a class="enum" href="../winit/enum.ElementState.html" title="enum winit::ElementState">ElementState</a></code>
|
|||
|
|
</span></span><span id="structfield.virtual_keycode" class="structfield small-section-header">
|
|||
|
|
<a href="#structfield.virtual_keycode" class="anchor field"></a>
|
|||
|
|
<span id="virtual_keycode.v" class='invisible'>
|
|||
|
|
<code>virtual_keycode: <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="../winit/enum.VirtualKeyCode.html" title="enum winit::VirtualKeyCode">VirtualKeyCode</a>></code>
|
|||
|
|
</span></span><div class='docblock'><p>Identifies the semantic meaning of the key</p>
|
|||
|
|
<p>Use when the semantics of the key are more important than the physical location of the key, such as when
|
|||
|
|
implementing appropriate behavior for "page up."</p>
|
|||
|
|
</div><span id="structfield.modifiers" class="structfield small-section-header">
|
|||
|
|
<a href="#structfield.modifiers" class="anchor field"></a>
|
|||
|
|
<span id="modifiers.v" class='invisible'>
|
|||
|
|
<code>modifiers: <a class="struct" href="../winit/struct.ModifiersState.html" title="struct winit::ModifiersState">ModifiersState</a></code>
|
|||
|
|
</span></span><div class='docblock'><p>Modifier keys active at the time of this input.</p>
|
|||
|
|
<p>This is tracked internally to avoid tracking errors arising from modifier key state changes when events from
|
|||
|
|
this device are not being delivered to the application, e.g. due to keyboard focus being elsewhere.</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-Debug' 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/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../winit/struct.KeyboardInput.html" title="struct winit::KeyboardInput">KeyboardInput</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/winit/events.rs.html#150' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/winit/events.rs.html#150' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
|||
|
|
</div></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="../winit/struct.KeyboardInput.html" title="struct winit::KeyboardInput">KeyboardInput</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/winit/events.rs.html#150' 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="../winit/struct.KeyboardInput.html" title="struct winit::KeyboardInput">KeyboardInput</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/winit/events.rs.html#150' 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-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="../winit/struct.KeyboardInput.html" title="struct winit::KeyboardInput">KeyboardInput</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/winit/events.rs.html#150' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'></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="../winit/struct.KeyboardInput.html" title="struct winit::KeyboardInput">KeyboardInput</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="../winit/struct.KeyboardInput.html" title="struct winit::KeyboardInput">KeyboardInput</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 = "winit";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|