abstreet/rustdoc/map_gui/index.html

20 lines
6.1 KiB
HTML
Raw Normal View History

<!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 `map_gui` crate."><meta name="keywords" content="rust, rustlang, rust-lang, map_gui"><title>map_gui - 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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><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">&#9776;</div><a href='../map_gui/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate map_gui</p><div class='block version'><p>Version 0.1.0</p></div><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all map_gui'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></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'map_gui', 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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><span class="help-button">?</span>
<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'>&#x2212;</span>]</a></span><a class='srclink' href='../src/map_gui/lib.rs.html#1-120' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>map_gui</a></span></h1><div class='docblock'><p>This crate contains common code for applications that draw and interact with a <code>Map</code>.</p>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table><tr class='module-item'><td><a class="mod" href="colors/index.html" title='map_gui::colors mod'>colors</a></td><td class='docblock-short'><p>A color scheme groups colors used for different map, dynamic, and UI elements in one place, to
encourage deduplication. The player can also switch between different color schemes.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="load/index.html" title='map_gui::load mod'>load</a></td><td class='docblock-short'><p>Loading large resources (like maps, scenarios, and prebaked data) requires different strategies
on native and web. Both cases are wrapped up as a State that runs a callback when done.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="options/index.html" title='map_gui::options mod'>options</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="render/index.html" title='map_gui::render mod'>render</a></td><td class='docblock-short'><p>Render static and dynamic map elements.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="simple_app/index.html" title='map_gui::simple_app mod'>simple_app</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="tools/index.html" title='map_gui::tools mod'>tools</a></td><td class='docblock-short'><p>Assorted tools and UI states that're useful for applications built to display maps.</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.Cached.html" title='map_gui::Cached struct'>Cached</a></td><td class='docblock-short'><p>Store a cached key/value pair, only recalculating when the key changes.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.SimpleApp.html" title='map_gui::SimpleApp struct'>SimpleApp</a></td><td class='docblock-short'><p>Simple app state that just renders a static map, without any dynamic agents on the map.</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.ID.html" title='map_gui::ID enum'>ID</a></td><td class='docblock-short'></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.AppLike.html" title='map_gui::AppLike trait'>AppLike</a></td><td class='docblock-short'><p>An application wishing to use the tools in this crate has to implement this on the struct that
implements <code>widgetry::SharedAppState</code>, so that the tools here can access the map. See
<code>SimpleApp</code> for an example implementation.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "map_gui";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>