<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="Customize how widgetry works. Most of these settings can’t be changed after starting."><metaname="keywords"content="rust, rustlang, rust-lang, Settings"><title>Settings in widgetry - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceSerif4-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../FiraSans-Regular.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../FiraSans-Medium.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceCodePro-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceSerif4-Bold.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceCodePro-Semibold.ttf.woff2"><linkrel="stylesheet"type="text/css"href="../normalize.css"><linkrel="stylesheet"type="text/css"href="../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../ayu.css"disabled><linkrel="stylesheet"type="text/css"href="../dark.css"disabled><linkrel="stylesheet"type="text/css"href="../light.css"id="themeStyle"><scriptid="default-settings"></script><scriptsrc="../storage.js"></script><scriptsrc="../crates.js"></script><scriptdefersrc="../main.js"></script>
<noscript><linkrel="stylesheet"href="../noscript.css"></noscript><linkrel="alternate icon"type="image/png"href="../favicon-16x16.png"><linkrel="alternate icon"type="image/png"href="../favicon-32x32.png"><linkrel="icon"type="image/svg+xml"href="../favicon.svg"></head><bodyclass="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="sidebar-logo"href="../widgetry/index.html"><divclass="logo-container"><imgclass="rust-logo"src="../rust-logo.svg"alt="logo"></div>
</a><h2class="location"><ahref="#">Settings</a></h2><divclass="sidebar-elems"><section><divclass="block"><h3class="sidebar-title"><ahref="#fields">Fields</a></h3><ul><li><ahref="#structfield.assets_are_gzipped">assets_are_gzipped</a></li><li><ahref="#structfield.assets_base_url">assets_base_url</a></li><li><ahref="#structfield.canvas_settings">canvas_settings</a></li><li><ahref="#structfield.dump_raw_events">dump_raw_events</a></li><li><ahref="#structfield.loading_tips">loading_tips</a></li><li><ahref="#structfield.read_svg">read_svg</a></li><li><ahref="#structfield.require_minimum_width">require_minimum_width</a></li><li><ahref="#structfield.scale_factor">scale_factor</a></li><li><ahref="#structfield.window_icon">window_icon</a></li><li><ahref="#structfield.window_title">window_title</a></li></ul></div><divclass="block"><h3class="sidebar-title"><ahref="#implementations">Methods</a></h3><ul><li><ahref="#method.assets_are_gzipped">assets_are_gzipped</a></li><li><ahref="#method.assets_base_url">assets_base_url</a></li><li><ahref="#method.canvas_settings">canvas_settings</a></li><li><ahref="#method.dump_raw_events">dump_raw_events</a></li><li><ahref="#method.loading_tips">loading_tips</a></li><li><ahref="#method.new">new</a></li><li><ahref="#method.read_svg">read_svg</a></li><li><ahref="#method.require_minimum_width">require_minimum_width</a></li><li><ahref="#method.scale_factor">scale_factor</a></li><li><ahref="#method.window_icon">window_icon</a></li></ul></div><divclass="block"><h3class="sidebar-title"><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><ul><li><ahref="#impl-RefUnwindSafe">!RefUnwindSafe</a></li><li><ahref="#impl-Send">!Send</a></li><li><ahref="#impl-Sync">!Sync</a></li><li><ahref="#impl-Unpin">Unpin</a></li><li><ahref="#impl-UnwindSafe">!UnwindSafe</a></li></ul></div><divclass="block"><h3class="sidebar-title"><ahref="#blanket-implementations">Blanket Implementations</a></h3><ul><li><ahref="#impl-Any">Any</a></li><li><ahref="#impl-Borrow%3CT%3E">Borrow<T></a></li><li><ahref="#impl-BorrowMut%3CT%3E">BorrowMut<T></a></li><li><ahref="#impl-Downcast">Downcast</a></li><li><ahref="#impl-From%3CT%3E">From<T></a></li><li><ahref="#impl-Instrument">Instrument</a></li><li><ahref="#impl-Into%3CU%3E">Into<U></a></li><li><ahref="#impl-TryFrom%3CU%3E">TryFrom<U></a></li><li><ahref="#impl-TryInto%3CU%3E">TryInto<U></a></li></ul></div></section><h2class="location"><ahref="index.html">In widgetry</a></h2><divid="sidebar-vars"data-name="Settings"data-ty="struct"data-relpath=""></div><scriptdefersrc="sidebar-items.js"></script></div></nav><main><divclass="width-limiter"><divclass="sub-container"><aclass="sub-logo-container"href="../widgetry/index.html"><imgclass="rust-logo"src="../rust-logo.svg"alt="logo"></a><navclass="sub"><divclass="theme-picker hidden"><buttonid="theme-picker"aria-label="Pick another theme!"aria-haspopup="menu"title="themes"><imgwidth="22"height="22"alt="Pick another theme!"src="../brush.svg"></button><divid="theme-choices"role="menu"></div></div><formclass="search-form"><divclass="search-container"><span></span><inputclass="search-input"name="search"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><buttontype="button"id="help-button"title="help">?</button><aid="settings-menu"href="../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../wheel.svg"></a></div></form></nav></div><sectionid="main-content"class="content"><divclass="main-heading">
}</code></pre></div><detailsclass="rustdoc-toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>Customize how widgetry works. Most of these settings can’t be changed after starting.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.dump_raw_events"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/widgetry/runner.rs.html#236-240">source</a></span><ahref="#method.dump_raw_events"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.dump_raw_events"class="fnname">dump_raw_events</a>(self) -> Self</h4></section></summary><divclass="docblock"><p>Log every raw winit event to the DEBUG level.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.scale_factor"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/widgetry/runner.rs.html#243-246">source</a></span><ahref="#method.scale_factor"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.scale_factor"class="fnname">scale_factor</a>(self, scale_factor: <aclass="primitive"href="https://doc.rust-lang.org/1.62.1/std/primitive.f64.html">f64</a>) -> Self</h4></section></summary><divclass="docblock"><p>Override the initial HiDPI scale factor from whatever winit initially detects.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.require_minimum_width"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/widgetry/runner.rs.html#260-263">source</a></span><ahref="#method.require_minimum_width"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.require_minimum_width"class="fnname">require_minimum_width</a>(self, width: <aclass="primitive"href="https://doc.rust-lang.org/1.62.1/std/primitive.f64.html">f64</a>) -> Self</h4></section></summary><divclass="docblock"><p>If the screen width using the monitor’s detected scale factor is below this value (in units
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.window_icon"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/widgetry/runner.rs.html#266-269">source</a></span><ahref="#method.window_icon"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.window_icon"class="fnname">window_icon</a>(self, path: <aclass="struct"href="https://doc.rust-lang.org/1.62.1/alloc/string/struct.String.html"title="struct alloc::string::String">String</a>) -> Self</h4></section></summary><divclass="docblock"><p>Sets the window icon. This should be a 32x32 image.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.loading_tips"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/widgetry/runner.rs.html#273-276">source</a></span><ahref="#method.loading_tips"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.loading_tips"class="fnname">loading_tips</a>(self, txt: <aclass="struct"href="text/struct.Text.html"title="struct widgetry::text::Text">Text</a>) -> Self</h4></section></summary><divclass="docblock"><p>Sets the text that’ll appear during long <code>ctx.loading_screen</code> calls. You can use this as a
then be further <code>downcast</code> into <code>Box<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <a>Read more</a></p>
further <code>downcast</code> into <code>Rc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <a>Read more</a></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-Instrument"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.26/src/tracing/instrument.rs.html#155">source</a></span><ahref="#impl-Instrument"class="anchor"></a><h3class="code-header in-band">impl<T><aclass="trait"href="https://docs.rs/tracing/0.1.26/tracing/instrument/trait.Instrument.html"title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.instrument"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.26/src/tracing/instrument.rs.html#38">source</a></span><ahref="#method.instrument"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.26/tracing/instrument/trait.Instrument.html#method.instrument"class="fnname">instrument</a>(self, span: <aclass="struct"href="https://docs.rs/tracing/0.1.26/tracing/span/struct.Span.html"title="struct tracing::span::Span">Span</a>) -><aclass="struct"href="https://docs.rs/tracing/0.1.26/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'><p>Instruments this type with the provided <code>Span</code>, returning an
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.in_current_span"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.26/src/tracing/instrument.rs.html#74">source</a></span><ahref="#method.in_current_span"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.26/tracing/instrument/trait.Instrument.html#method.in_current_span"class="fnname">in_current_span</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.26/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'><p>Instruments this type with the <ahref="../struct.Span.html#method.current">current</a><code>Span</code>, returning an
<code><ahref="https://doc.rust-lang.org/1.62.1/core/convert/trait.From.html"title="From">From</a><T> for U</code> chooses to do.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-TryFrom%3CU%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/1.62.1/src/core/convert/mod.rs.html#598-607">source</a></span><ahref="#impl-TryFrom%3CU%3E"class="anchor"></a><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/1.62.1/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Error-1"class="associatedtype trait-impl has-srclink"><ahref="#associatedtype.Error-1"class="anchor"></a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.62.1/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4></section></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.try_from"class="method trait-impl has-srclink"><spanclass="rightside"><spanclass="since"title="const unstable">const: <ahref="https://github.com/rust-lang/rust/issues/88674"title="Tracking issue for const_convert">unstable</a></span> · <aclass="srclink"href="https://doc.rust-lang.org/1.62.1/src/core/convert/mod.rs.html#604">source</a></span><ahref="#method.try_from"class="anchor"></a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html#tymethod.try_from"class="fnname">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/1.62.1/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'><p>Performs the conversion.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-TryInto%3CU%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/1.62.1/src/core/convert/mod.rs.html#583-592">source</a></span><ahref="#impl-TryInto%3CU%3E"class="anchor"></a><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Error"class="associatedtype trait-impl has-srclink"><ahref="#associatedtype.Error"class="anchor"></a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.try_into"class="method trait-impl has-srclink"><spanclass="rightside"><spanclass="since"title="const unstable">const: <ahref="https://github.com/rust-lang/rust/issues/88674"title="Tracking issue for const_convert">unstable</a></span> · <aclass="srclink"href="https://doc.rust-lang.org/1.62.1/src/core/convert/mod.rs.html#589">source</a></span><ahref="#method.try_into"class="anchor"></a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryInto.html#tymethod.try_into"class="fnname">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.62.1/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.62.1/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'><p>Performs the conversion.</p>
