|
|
<!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 `line_drawing` crate."><meta name="keywords" content="rust, rustlang, rust-lang, line_drawing"><title>line_drawing - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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><a href='../line_drawing/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate line_drawing</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all line_drawing's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'line_drawing', ty: 'mod', relpath: '../'};</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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='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/line_drawing/lib.rs.html#1-73' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>line_drawing</a></span></h1><div class='docblock'><p>A collection of line-drawing algorithms for use in graphics and video games.</p>
|
|
|
<p>Currently implemented:</p>
|
|
|
<ul>
|
|
|
<li><a href="struct.Bresenham.html"><code>Bresenham</code></a> - An implementation of <a href="https://en.wikipedia.org/wiki/Bresenham's_line_algorithm">Bresenham's line algorithm</a>.</li>
|
|
|
<li><a href="struct.Bresenham3d.html"><code>Bresenham3d</code></a> - A 3-Dimensional implementation of bresenham.</li>
|
|
|
<li><a href="struct.BresenhamCircle.html"><code>BresenhamCircle</code></a> - Bresenham's circle algorithm.</li>
|
|
|
<li><a href="struct.Midpoint.html"><code>Midpoint</code></a> - The <a href="http://www.mat.univie.ac.at/%7Ekriegl/Skripten/CG/node25.html">mid-point line algorithm</a>.</li>
|
|
|
<li><a href="struct.WalkGrid.html"><code>WalkGrid</code></a> and <a href="struct.Supercover.html"><code>Supercover</code></a> - implemented from <a href="http://www.redblobgames.com/grids/line-drawing.html">this article by Red Blob Games</a>.</li>
|
|
|
<li><a href="struct.WalkVoxels.html"><code>WalkVoxels</code></a> - A similar 3-Dimensional algorithm that only takes orthogonal steps.</li>
|
|
|
<li><a href="struct.XiaolinWu.html"><code>XiaolinWu</code></a> - <a href="https://en.wikipedia.org/wiki/Xiaolin_Wu%27s_line_algorithm">Xiaolin Wu's line algorithm</a>.</li>
|
|
|
</ul>
|
|
|
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="mod" href="octant/index.html" title='line_drawing::octant mod'>octant</a></td><td class='docblock-short'><p>A simple octant struct for transforming line points.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="steps/index.html" title='line_drawing::steps mod'>steps</a></td><td class='docblock-short'><p>An iterator that returns <code>(start, end)</code> tuples from the walk.</p>
|
|
|
</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.Bresenham.html" title='line_drawing::Bresenham struct'>Bresenham</a></td><td class='docblock-short'><p>An implementation of <a href="https://en.wikipedia.org/wiki/Bresenham's_line_algorithm">Bresenham's line algorithm</a>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Bresenham3d.html" title='line_drawing::Bresenham3d struct'>Bresenham3d</a></td><td class='docblock-short'><p>An 3-D implementation of bresenham, sourced from <a href="http://members.chello.at/%7Eeasyfilter/bresenham.html">this site</a>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.BresenhamCircle.html" title='line_drawing::BresenhamCircle struct'>BresenhamCircle</a></td><td class='docblock-short'><p>An implementation of <a href="http://members.chello.at/%7Eeasyfilter/bresenham.html">Bresenham's circle algorithm</a>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Midpoint.html" title='line_drawing::Midpoint struct'>Midpoint</a></td><td class='docblock-short'><p>An implementation of the <a href="http://www.mat.univie.ac.at/%7Ekriegl/Skripten/CG/node25.html">mid-point line drawing algorithm</a>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Supercover.html" title='line_drawing::Supercover struct'>Supercover</a></td><td class='docblock-short'><p>Like <a href="struct.WalkGrid.html"><code>WalkGrid</code></a> but takes diagonal steps if the line passes directly over a corner.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.WalkGrid.html" title='line_drawing::WalkGrid struct'>WalkGrid</a></td><td class='docblock-short'><p>Walk along a grid, taking only orthogonal steps.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.WalkVoxels.html" title='line_drawing::WalkVoxels struct'>WalkVoxels</a></td><td class='docblock-short'><p>Walk between two voxels, taking orthogonal steps and visiting all voxels in between.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.XiaolinWu.html" title='line_drawing::XiaolinWu struct'>XiaolinWu</a></td><td class='docblock-short'><p>An implementation of <a href="https://en.wikipedia.org/wiki/Xiaolin_Wu%27s_line_algorithm">Xiaolin Wu's line algorithm</a>.</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.VoxelOrigin.html" title='line_drawing::VoxelOrigin enum'>VoxelOrigin</a></td><td class='docblock-short'><p>Where the center of the voxel is, at the center or a corner.</p>
|
|
|
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="trait" href="trait.FloatNum.html" title='line_drawing::FloatNum trait'>FloatNum</a></td><td class='docblock-short'><p>All the floating-point primitives.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.SignedNum.html" title='line_drawing::SignedNum trait'>SignedNum</a></td><td class='docblock-short'><p>All the signed integer primitives.</p>
|
|
|
</td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="type" href="type.Point.html" title='line_drawing::Point type'>Point</a></td><td class='docblock-short'><p>A point in 2D space.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="type" href="type.Voxel.html" title='line_drawing::Voxel type'>Voxel</a></td><td class='docblock-short'><p>An point in 3D space.</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 = "line_drawing";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
