abstreet/rustdoc/widgetry/app_state/trait.SharedAppState.html
2021-07-29 16:51:19 +00:00

17 lines
8.4 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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::app_state - 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><script src="../../crates.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 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a href='../../widgetry/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><h2 class="location">Trait SharedAppState</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><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><a href="#method.free_memory">free_memory</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="../index.html">widgetry</a>::<wbr><a href="index.html">app_state</a></h2><div id="sidebar-vars" data-name="SharedAppState" data-ty="trait" data-relpath=""></div><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" title="themes"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><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><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><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><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></button></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">&#x2212;</span>]</a></span><a class="srclink" href="../../src/widgetry/app_state.rs.html#14-28" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust trait">pub trait SharedAppState {
fn <a href="#method.before_event" class="fnname">before_event</a>(&amp;mut self) { ... }
<div class="item-spacer"></div> fn <a href="#method.draw_default" class="fnname">draw_default</a>(&amp;self, _: &amp;mut <a class="struct" href="../drawing/struct.GfxCtx.html" title="struct widgetry::drawing::GfxCtx">GfxCtx</a>&lt;'_&gt;) { ... }
<div class="item-spacer"></div> fn <a href="#method.dump_before_abort" class="fnname">dump_before_abort</a>(&amp;self, _: &amp;<a class="struct" href="../canvas/struct.Canvas.html" title="struct widgetry::canvas::Canvas">Canvas</a>) { ... }
<div class="item-spacer"></div> fn <a href="#method.before_quit" class="fnname">before_quit</a>(&amp;self, _: &amp;<a class="struct" href="../canvas/struct.Canvas.html" title="struct widgetry::canvas::Canvas">Canvas</a>) { ... }
<div class="item-spacer"></div> fn <a href="#method.free_memory" class="fnname">free_memory</a>(&amp;mut self) { ... }
}</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"><h4 class="code-header">fn <a href="#method.before_event" class="fnname">before_event</a>(&amp;mut self)</h4><a class="srclink" href="../../src/widgetry/app_state.rs.html#16" title="goto source code">[src]</a></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"><h4 class="code-header">fn <a href="#method.draw_default" class="fnname">draw_default</a>(&amp;self, _: &amp;mut <a class="struct" href="../drawing/struct.GfxCtx.html" title="struct widgetry::drawing::GfxCtx">GfxCtx</a>&lt;'_&gt;)</h4><a class="srclink" href="../../src/widgetry/app_state.rs.html#18" title="goto source code">[src]</a></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"><h4 class="code-header">fn <a href="#method.dump_before_abort" class="fnname">dump_before_abort</a>(&amp;self, _: &amp;<a class="struct" href="../canvas/struct.Canvas.html" title="struct widgetry::canvas::Canvas">Canvas</a>)</h4><a class="srclink" href="../../src/widgetry/app_state.rs.html#21" title="goto source code">[src]</a></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"><h4 class="code-header">fn <a href="#method.before_quit" class="fnname">before_quit</a>(&amp;self, _: &amp;<a class="struct" href="../canvas/struct.Canvas.html" title="struct widgetry::canvas::Canvas">Canvas</a>)</h4><a class="srclink" href="../../src/widgetry/app_state.rs.html#23" title="goto source code">[src]</a></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"><h4 class="code-header">fn <a href="#method.free_memory" class="fnname">free_memory</a>(&amp;mut self)</h4><a class="srclink" href="../../src/widgetry/app_state.rs.html#27" title="goto source code">[src]</a></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" async></script></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="widgetry" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div><script src="../../main.js"></script></body></html>