mirror of
https://github.com/a-b-street/abstreet.git
synced 2024-11-23 17:07:12 +03:00
15 lines
8.8 KiB
HTML
15 lines
8.8 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="Any data that should last the entire lifetime of the application should be stored in the struct implementing this trait."><meta name="keywords" content="rust, rustlang, rust-lang, SharedAppState"><title>SharedAppState in widgetry - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../widgetry/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../widgetry/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">SharedAppState</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><ul><li><a href="#method.before_event">before_event</a></li><li><a href="#method.before_quit">before_quit</a></li><li><a href="#method.draw_default">draw_default</a></li><li><a href="#method.dump_before_abort">dump_before_abort</a></li><li><a href="#method.free_memory">free_memory</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In widgetry</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../widgetry/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">widgetry</a>::<wbr><a class="trait" href="#">SharedAppState</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/widgetry/app_state.rs.html#14-28">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait SharedAppState {
|
||
fn <a href="#method.before_event" class="fnname">before_event</a>(&mut self) { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.draw_default" class="fnname">draw_default</a>(&self, _: &mut <a class="struct" href="drawing/struct.GfxCtx.html" title="struct widgetry::drawing::GfxCtx">GfxCtx</a><'_>) { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.dump_before_abort" class="fnname">dump_before_abort</a>(&self, _: &<a class="struct" href="canvas/struct.Canvas.html" title="struct widgetry::canvas::Canvas">Canvas</a>) { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.before_quit" class="fnname">before_quit</a>(&self, _: &<a class="struct" href="canvas/struct.Canvas.html" title="struct widgetry::canvas::Canvas">Canvas</a>) { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.free_memory" class="fnname">free_memory</a>(&mut self) { ... }
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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></details><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="method.before_event" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#16">source</a></div><h4 class="code-header">fn <a href="#method.before_event" class="fnname">before_event</a>(&mut self)</h4></div></summary><div class="docblock"><p>Before <code>State::event</code> is called, call this.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="method.draw_default" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#18">source</a></div><h4 class="code-header">fn <a href="#method.draw_default" class="fnname">draw_default</a>(&self, _: &mut <a class="struct" href="drawing/struct.GfxCtx.html" title="struct widgetry::drawing::GfxCtx">GfxCtx</a><'_>)</h4></div></summary><div class="docblock"><p>When DrawBaselayer::DefaultDraw is called, run this.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="method.dump_before_abort" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#21">source</a></div><h4 class="code-header">fn <a href="#method.dump_before_abort" class="fnname">dump_before_abort</a>(&self, _: &<a class="struct" href="canvas/struct.Canvas.html" title="struct widgetry::canvas::Canvas">Canvas</a>)</h4></div></summary><div class="docblock"><p>Will be called if <code>State::event</code> or <code>State::draw</code> panics.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="method.before_quit" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#23">source</a></div><h4 class="code-header">fn <a href="#method.before_quit" class="fnname">before_quit</a>(&self, _: &<a class="struct" href="canvas/struct.Canvas.html" title="struct widgetry::canvas::Canvas">Canvas</a>)</h4></div></summary><div class="docblock"><p>Called before a normal exit, like window close</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="method.free_memory" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#27">source</a></div><h4 class="code-header">fn <a href="#method.free_memory" class="fnname">free_memory</a>(&mut self)</h4></div></summary><div class="docblock"><p>If widgetry determines the video card is low on memory, this may be called. The application
|
||
should make its best effort to delete any unused Drawables.</p>
|
||
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script type="text/javascript" src="../implementors/widgetry/app_state/trait.SharedAppState.js" data-ignore-extern-crates="" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="widgetry" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |