bstein/rusty_snek_gaem
1
0
Fork 0
mirror of https://github.com/neogeek23/rusty_snek_gaem.git synced 2026-02-04 19:18:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
rusty_snek_gaem/target/doc/graphics/character/struct.Character.html
brad stein c73dd7a7d0 first commit
2018-10-28 21:14:05 -05:00

28 lines
15 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `Character` struct in crate `graphics`."><meta name="keywords" content="rust, rustlang, rust-lang, Character"><title>graphics::character::Character - 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">&#9776;</div><p class='location'>Struct Character</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.offset">offset</a><a href="#structfield.size">size</a><a href="#structfield.texture">texture</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.left">left</a><a href="#method.top">top</a><a href="#method.width">width</a><a href="#method.height">height</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</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'>graphics</a>::<wbr><a href='index.html'>character</a></p><script>window.sidebarCurrent = {name: 'Character', 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'>graphics</a>::<wbr><a href='index.html'>character</a>::<wbr><a class="struct" href=''>Character</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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/graphics/character.rs.html#8-15' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Character&lt;'a, T:&nbsp;'a + <a class="trait" href="../../graphics/trait.ImageSize.html" title="trait graphics::ImageSize">ImageSize</a>&gt; {
pub offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="type" href="../../graphics/math/type.Scalar.html" title="type graphics::math::Scalar">Scalar</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 2]</a>,
pub size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="type" href="../../graphics/math/type.Scalar.html" title="type graphics::math::Scalar">Scalar</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 2]</a>,
pub texture: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a </a>T,
}</pre></div><div class='docblock'><p>Holds rendered character data.</p>
</div><h2 id='fields' class='fields small-section-header'>
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.offset" class="structfield small-section-header">
<a href="#structfield.offset" class="anchor field"></a>
<span id="offset.v" class='invisible'>
<code>offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="type" href="../../graphics/math/type.Scalar.html" title="type graphics::math::Scalar">Scalar</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 2]</a></code>
</span></span><div class='docblock'><p>The offset of character.</p>
</div><span id="structfield.size" class="structfield small-section-header">
<a href="#structfield.size" class="anchor field"></a>
<span id="size.v" class='invisible'>
<code>size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="type" href="../../graphics/math/type.Scalar.html" title="type graphics::math::Scalar">Scalar</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 2]</a></code>
</span></span><div class='docblock'><p>The size of character, including space.</p>
</div><span id="structfield.texture" class="structfield small-section-header">
<a href="#structfield.texture" class="anchor field"></a>
<span id="texture.v" class='invisible'>
<code>texture: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a </a>T</code>
</span></span><div class='docblock'><p>The texture of the character.</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&lt;'a, T:&nbsp;<a class="trait" href="../../graphics/trait.ImageSize.html" title="trait graphics::ImageSize">ImageSize</a>&gt; <a class="struct" href="../../graphics/character/struct.Character.html" title="struct graphics::character::Character">Character</a>&lt;'a, T&gt;</code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/graphics/character.rs.html#17-37' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.left' class="method"><span id='left.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.left' class='fnname'>left</a>(&amp;self) -&gt; <a class="type" href="../../graphics/math/type.Scalar.html" title="type graphics::math::Scalar">Scalar</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/graphics/character.rs.html#19-21' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>The left offset.</p>
</div><h4 id='method.top' class="method"><span id='top.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.top' class='fnname'>top</a>(&amp;self) -&gt; <a class="type" href="../../graphics/math/type.Scalar.html" title="type graphics::math::Scalar">Scalar</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/graphics/character.rs.html#24-26' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>The top offset.</p>
</div><h4 id='method.width' class="method"><span id='width.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.width' class='fnname'>width</a>(&amp;self) -&gt; <a class="type" href="../../graphics/math/type.Scalar.html" title="type graphics::math::Scalar">Scalar</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/graphics/character.rs.html#29-31' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Gets width of character, including space to the next one.</p>
</div><h4 id='method.height' class="method"><span id='height.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.height' class='fnname'>height</a>(&amp;self) -&gt; <a class="type" href="../../graphics/math/type.Scalar.html" title="type graphics::math::Scalar">Scalar</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/graphics/character.rs.html#34-36' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets height of character, including space to the next one.</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-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;'a, T:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + 'a + <a class="trait" href="../../graphics/trait.ImageSize.html" title="trait graphics::ImageSize">ImageSize</a>&gt; <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="../../graphics/character/struct.Character.html" title="struct graphics::character::Character">Character</a>&lt;'a, T&gt;</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/graphics/character.rs.html#7' 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>(&amp;self) -&gt; <a class="struct" href="../../graphics/character/struct.Character.html" title="struct graphics::character::Character">Character</a>&lt;'a, T&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/graphics/character.rs.html#7' 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>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</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></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&lt;'a, T&gt; <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="../../graphics/character/struct.Character.html" title="struct graphics::character::Character">Character</a>&lt;'a, T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,&nbsp;</span></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&lt;'a, T&gt; <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="../../graphics/character/struct.Character.html" title="struct graphics::character::Character">Character</a>&lt;'a, T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,&nbsp;</span></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>&#9166;</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 = "graphics";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink