mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-05 11:38:44 +00:00
44 lines
20 KiB
HTML
44 lines
20 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 `CircleArc` struct in crate `graphics`."><meta name="keywords" content="rust, rustlang, rust-lang, CircleArc"><title>graphics::circle_arc::CircleArc - 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 CircleArc</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.color">color</a><a href="#structfield.radius">radius</a><a href="#structfield.start">start</a><a href="#structfield.end">end</a><a href="#structfield.resolution">resolution</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.color">color</a><a href="#method.radius">radius</a><a href="#method.start">start</a><a href="#method.end">end</a><a href="#method.resolution">resolution</a><a href="#method.draw">draw</a><a href="#method.draw_tri">draw_tri</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></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'>circle_arc</a></p><script>window.sidebarCurrent = {name: 'CircleArc', 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'>circle_arc</a>::<wbr><a class="struct" href=''>CircleArc</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/graphics/circle_arc.rs.html#10-25' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct CircleArc {
|
||
pub color: <a class="type" href="../../graphics/types/type.Color.html" title="type graphics::types::Color">Color</a>,
|
||
pub radius: <a class="type" href="../../graphics/types/type.Radius.html" title="type graphics::types::Radius">Radius</a>,
|
||
pub start: <a class="type" href="../../graphics/math/type.Scalar.html" title="type graphics::math::Scalar">Scalar</a>,
|
||
pub end: <a class="type" href="../../graphics/math/type.Scalar.html" title="type graphics::math::Scalar">Scalar</a>,
|
||
pub resolution: <a class="type" href="../../graphics/types/type.Resolution.html" title="type graphics::types::Resolution">Resolution</a>,
|
||
}</pre></div><div class='docblock'><p>A curved line</p>
|
||
</div><h2 id='fields' class='fields small-section-header'>
|
||
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.color" class="structfield small-section-header">
|
||
<a href="#structfield.color" class="anchor field"></a>
|
||
<span id="color.v" class='invisible'>
|
||
<code>color: <a class="type" href="../../graphics/types/type.Color.html" title="type graphics::types::Color">Color</a></code>
|
||
</span></span><div class='docblock'><p>The arcs color</p>
|
||
</div><span id="structfield.radius" class="structfield small-section-header">
|
||
<a href="#structfield.radius" class="anchor field"></a>
|
||
<span id="radius.v" class='invisible'>
|
||
<code>radius: <a class="type" href="../../graphics/types/type.Radius.html" title="type graphics::types::Radius">Radius</a></code>
|
||
</span></span><div class='docblock'><p>The radius of the arc (Thickness of the drawing, not the radius of the circle)</p>
|
||
</div><span id="structfield.start" class="structfield small-section-header">
|
||
<a href="#structfield.start" class="anchor field"></a>
|
||
<span id="start.v" class='invisible'>
|
||
<code>start: <a class="type" href="../../graphics/math/type.Scalar.html" title="type graphics::math::Scalar">Scalar</a></code>
|
||
</span></span><div class='docblock'><p>The start of the arc in radians</p>
|
||
</div><span id="structfield.end" class="structfield small-section-header">
|
||
<a href="#structfield.end" class="anchor field"></a>
|
||
<span id="end.v" class='invisible'>
|
||
<code>end: <a class="type" href="../../graphics/math/type.Scalar.html" title="type graphics::math::Scalar">Scalar</a></code>
|
||
</span></span><div class='docblock'><p>The end of the arc in radians</p>
|
||
</div><span id="structfield.resolution" class="structfield small-section-header">
|
||
<a href="#structfield.resolution" class="anchor field"></a>
|
||
<span id="resolution.v" class='invisible'>
|
||
<code>resolution: <a class="type" href="../../graphics/types/type.Resolution.html" title="type graphics::types::Resolution">Resolution</a></code>
|
||
</span></span><div class='docblock'><p>The resolution for the arc.</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="../../graphics/circle_arc/struct.CircleArc.html" title="struct graphics::circle_arc::CircleArc">CircleArc</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/graphics/circle_arc.rs.html#27-100' 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>(<br> color: <a class="type" href="../../graphics/types/type.Color.html" title="type graphics::types::Color">Color</a>, <br> radius: <a class="type" href="../../graphics/types/type.Radius.html" title="type graphics::types::Radius">Radius</a>, <br> start: <a class="type" href="../../graphics/math/type.Scalar.html" title="type graphics::math::Scalar">Scalar</a>, <br> end: <a class="type" href="../../graphics/math/type.Scalar.html" title="type graphics::math::Scalar">Scalar</a><br>) -> <a class="struct" href="../../graphics/circle_arc/struct.CircleArc.html" title="struct graphics::circle_arc::CircleArc">CircleArc</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/graphics/circle_arc.rs.html#29-37' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new arc</p>
|
||
</div><h4 id='method.color' class="method"><span id='color.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.color' class='fnname'>color</a>(self, value: <a class="type" href="../../graphics/types/type.Color.html" title="type graphics::types::Color">Color</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/graphics/circle_arc.rs.html#40-43' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the arcs color.</p>
|
||
</div><h4 id='method.radius' class="method"><span id='radius.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.radius' class='fnname'>radius</a>(self, value: <a class="type" href="../../graphics/types/type.Radius.html" title="type graphics::types::Radius">Radius</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/graphics/circle_arc.rs.html#46-49' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the radius of the arc (Thickness of the arc, not the radius of the circle it wraps)</p>
|
||
</div><h4 id='method.start' class="method"><span id='start.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.start' class='fnname'>start</a>(self, value: <a class="type" href="../../graphics/math/type.Scalar.html" title="type graphics::math::Scalar">Scalar</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/graphics/circle_arc.rs.html#52-55' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the start of the arc (in radians).</p>
|
||
</div><h4 id='method.end' class="method"><span id='end.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.end' class='fnname'>end</a>(self, value: <a class="type" href="../../graphics/math/type.Scalar.html" title="type graphics::math::Scalar">Scalar</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/graphics/circle_arc.rs.html#58-61' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the end of the arc (in radians).</p>
|
||
</div><h4 id='method.resolution' class="method"><span id='resolution.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.resolution' class='fnname'>resolution</a>(self, value: <a class="type" href="../../graphics/types/type.Resolution.html" title="type graphics::types::Resolution">Resolution</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/graphics/circle_arc.rs.html#64-67' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the resolution of the arcs smoothness.</p>
|
||
</div><h4 id='method.draw' class="method"><span id='draw.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.draw' class='fnname'>draw</a><R: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="type" href="../../graphics/types/type.Rectangle.html" title="type graphics::types::Rectangle">Rectangle</a>>, G>(<br> &self, <br> rectangle: R, <br> draw_state: &<a class="struct" href="../../graphics/draw_state/struct.DrawState.html" title="struct graphics::draw_state::DrawState">DrawState</a>, <br> transform: <a class="type" href="../../graphics/math/type.Matrix2d.html" title="type graphics::math::Matrix2d">Matrix2d</a>, <br> g: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>G<br>) <span class="where fmt-newline">where<br> G: <a class="trait" href="../../graphics/trait.Graphics.html" title="trait graphics::Graphics">Graphics</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/graphics/circle_arc.rs.html#71-79' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Draws circle arc using default method.</p>
|
||
</div><h4 id='method.draw_tri' class="method"><span id='draw_tri.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.draw_tri' class='fnname'>draw_tri</a><R: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="type" href="../../graphics/types/type.Rectangle.html" title="type graphics::types::Rectangle">Rectangle</a>>, G>(<br> &self, <br> rectangle: R, <br> draw_state: &<a class="struct" href="../../graphics/draw_state/struct.DrawState.html" title="struct graphics::draw_state::DrawState">DrawState</a>, <br> transform: <a class="type" href="../../graphics/math/type.Matrix2d.html" title="type graphics::math::Matrix2d">Matrix2d</a>, <br> g: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>G<br>) <span class="where fmt-newline">where<br> G: <a class="trait" href="../../graphics/trait.Graphics.html" title="trait graphics::Graphics">Graphics</a>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/graphics/circle_arc.rs.html#82-99' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Draws circle arc using triangulation.</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="../../graphics/circle_arc/struct.CircleArc.html" title="struct graphics::circle_arc::CircleArc">CircleArc</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/graphics/circle_arc.rs.html#9' 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="../../graphics/circle_arc/struct.CircleArc.html" title="struct graphics::circle_arc::CircleArc">CircleArc</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/graphics/circle_arc.rs.html#9' 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="../../graphics/circle_arc/struct.CircleArc.html" title="struct graphics::circle_arc::CircleArc">CircleArc</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/graphics/circle_arc.rs.html#9' 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></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="../../graphics/circle_arc/struct.CircleArc.html" title="struct graphics::circle_arc::CircleArc">CircleArc</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="../../graphics/circle_arc/struct.CircleArc.html" title="struct graphics::circle_arc::CircleArc">CircleArc</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 = "graphics";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |