mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-05 03:28:41 +00:00
75 lines
8.6 KiB
HTML
75 lines
8.6 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 `rectangle` mod in crate `graphics`."><meta name="keywords" content="rust, rustlang, rust-lang, rectangle"><title>graphics::rectangle - 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 mod"><!--[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'>Module rectangle</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>graphics</a></p><script>window.sidebarCurrent = {name: 'rectangle', ty: 'mod', 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'>Module <a href='../index.html'>graphics</a>::<wbr><a class="mod" href=''>rectangle</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/rectangle.rs.html#1-277' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>Draw rectangle</p>
|
|||
|
|
<p>This module contains the definintion of a rectangle with possibly rounded
|
|||
|
|
corners. It contains the code to draw the rectangle and defines properties
|
|||
|
|
like color and shape. The rectangle dimensions and location are specified by
|
|||
|
|
<code>types::Rectangle</code>.</p>
|
|||
|
|
<p>To draw a square with side 10 and top left corner in (0, 0), do the
|
|||
|
|
following:</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">let</span> <span class="ident">rectangle</span> <span class="op">=</span> <span class="ident">Rectangle</span>::<span class="ident">new</span>(<span class="ident">color</span>::<span class="ident">BLACK</span>);
|
|||
|
|
<span class="kw">let</span> <span class="ident">dims</span> <span class="op">=</span> <span class="ident">square</span>(<span class="number">0.0</span>, <span class="number">0.0</span>, <span class="number">10.0</span>);
|
|||
|
|
<span class="ident">rectangle</span>.<span class="ident">draw</span>(<span class="ident">dims</span>, <span class="kw-2">&</span><span class="ident">draw_state</span>::<span class="ident">Default</span>::<span class="ident">default</span>(), <span class="ident">transform</span>, <span class="ident">g</span>);</pre>
|
|||
|
|
</div><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
|
|||
|
|
<table><tr><td><code>pub use math::<a class="fn" href="../../graphics/math/fn.margin_rectangle.html" title="fn graphics::math::margin_rectangle">margin_rectangle</a> as margin;</code></td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Border.html"
|
|||
|
|
title='struct graphics::rectangle::Border'>Border</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>The border of the rectangle</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Rectangle.html"
|
|||
|
|
title='struct graphics::rectangle::Rectangle'>Rectangle</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>A filled rectangle</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="enum" href="enum.Shape.html"
|
|||
|
|
title='enum graphics::rectangle::Shape'>Shape</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>The shape of the rectangle corners</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.centered.html"
|
|||
|
|
title='fn graphics::rectangle::centered'>centered</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Use x, y, half-width, half-height</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.centered_square.html"
|
|||
|
|
title='fn graphics::rectangle::centered_square'>centered_square</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Create <code>types::Rectangle</code> for a square with a center in (<code>x</code>, <code>y</code>) and side
|
|||
|
|
<code>2 * radius</code>.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.rectangle_by_corners.html"
|
|||
|
|
title='fn graphics::rectangle::rectangle_by_corners'>rectangle_by_corners</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Create <code>types::Rectangle</code> by the two opposite corners.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.square.html"
|
|||
|
|
title='fn graphics::rectangle::square'>square</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Create <code>types::Rectangle</code> for a square with a top-left corner in (<code>x</code>, <code>y</code>)
|
|||
|
|
and side <code>size</code>.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table></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>
|