mirror of
https://github.com/a-b-street/abstreet.git
synced 2024-12-01 02:33:54 +03:00
15 lines
6.6 KiB
HTML
15 lines
6.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 `SharedAppState` trait in crate `widgetry`."><meta name="keywords" content="rust, rustlang, rust-lang, SharedAppState"><title>widgetry::app_state::SharedAppState - 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 id="default-settings"></script><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 trait"><!--[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='../../widgetry/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Trait SharedAppState</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.before_event">before_event</a><a href="#method.before_quit">before_quit</a><a href="#method.draw_default">draw_default</a><a href="#method.dump_before_abort">dump_before_abort</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">widgetry</a>::<wbr><a href="index.html">app_state</a></p><script>window.sidebarCurrent = {name: "SharedAppState", ty: "trait", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></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">−</span>]</a></span><a class="srclink" href="../../src/widgetry/app_state.rs.html#12-22" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="../index.html">widgetry</a>::<wbr><a href="index.html">app_state</a>::<wbr><a class="trait" href="">SharedAppState</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait SharedAppState {
|
||
fn <a href="#method.before_event" class="fnname">before_event</a>(&mut self) { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.draw_default" class="fnname">draw_default</a>(&self, _: &mut <a class="struct" href="../../widgetry/struct.GfxCtx.html" title="struct widgetry::GfxCtx">GfxCtx</a><'_>) { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.dump_before_abort" class="fnname">dump_before_abort</a>(&self, _: &<a class="struct" href="../../widgetry/struct.Canvas.html" title="struct widgetry::Canvas">Canvas</a>) { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.before_quit" class="fnname">before_quit</a>(&self, _: &<a class="struct" href="../../widgetry/struct.Canvas.html" title="struct widgetry::Canvas">Canvas</a>) { ... }
|
||
}</pre></div><div class="docblock"><p>Any data that should last the entire lifetime of the application should be stored in the struct
|
||
implementing this trait.</p>
|
||
</div><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><h3 id="method.before_event" class="method"><code>fn <a href="#method.before_event" class="fnname">before_event</a>(&mut self)</code></h3><div class="docblock"><p>Before <code>State::event</code> is called, call this.</p>
|
||
</div><h3 id="method.draw_default" class="method"><code>fn <a href="#method.draw_default" class="fnname">draw_default</a>(&self, _: &mut <a class="struct" href="../../widgetry/struct.GfxCtx.html" title="struct widgetry::GfxCtx">GfxCtx</a><'_>)</code></h3><div class="docblock"><p>When DrawBaselayer::DefaultDraw is called, run this.</p>
|
||
</div><h3 id="method.dump_before_abort" class="method"><code>fn <a href="#method.dump_before_abort" class="fnname">dump_before_abort</a>(&self, _: &<a class="struct" href="../../widgetry/struct.Canvas.html" title="struct widgetry::Canvas">Canvas</a>)</code></h3><div class="docblock"><p>Will be called if <code>State::event</code> or <code>State::draw</code> panics.</p>
|
||
</div><h3 id="method.before_quit" class="method"><code>fn <a href="#method.before_quit" class="fnname">before_quit</a>(&self, _: &<a class="struct" href="../../widgetry/struct.Canvas.html" title="struct widgetry::Canvas">Canvas</a>)</code></h3><div class="docblock"><p>Called before a normal exit, like window close</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/widgetry/app_state/trait.SharedAppState.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "widgetry";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |