<linkrel="alternate icon"type="image/png"href="../favicon-32x32.png"><styletype="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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="sidebar"><divclass="sidebar-menu"role="button">☰</div><ahref='../widgetry/index.html'><divclass='logo-container rust-logo'><imgsrc='../rust-logo.png'alt='logo'></div></a><h2class="location">Struct Image</h2><divclass="sidebar-elems"><divclass="block items"><h3class="sidebar-title"><ahref="#fields">Fields</a></h3><divclass="sidebar-links"><ahref="#structfield.bg_color">bg_color</a><ahref="#structfield.color">color</a><ahref="#structfield.content_mode">content_mode</a><ahref="#structfield.corner_rounding">corner_rounding</a><ahref="#structfield.dims">dims</a><ahref="#structfield.padding">padding</a><ahref="#structfield.source">source</a><ahref="#structfield.tooltip">tooltip</a></div><h3class="sidebar-title"><ahref="#implementations">Methods</a></h3><divclass="sidebar-links"><ahref="#method.bg_color">bg_color</a><ahref="#method.build_batch">build_batch</a><ahref="#method.color">color</a><ahref="#method.content_mode">content_mode</a><ahref="#method.corner_rounding">corner_rounding</a><ahref="#method.dims">dims</a><ahref="#method.empty">empty</a><ahref="#method.from_batch">from_batch</a><ahref="#method.from_bytes">from_bytes</a><ahref="#method.from_path">from_path</a><ahref="#method.into_widget">into_widget</a><ahref="#method.merged_image_style">merged_image_style</a><ahref="#method.padding">padding</a><ahref="#method.source">source</a><ahref="#method.source_batch">source_batch</a><ahref="#method.source_bytes">source_bytes</a><ahref="#method.source_path">source_path</a><ahref="#method.tooltip">tooltip</a><ahref="#method.untinted">untinted</a></div><h3class="sidebar-title"><ahref="#trait-implementations">Trait Implementations</a></h3><divclass="sidebar-links"><ahref="#impl-Clone">Clone</a><ahref="#impl-Debug">Debug</a><ahref="#impl-Default">Default</a></div><h3class="sidebar-title"><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><divclass="sidebar-links"><ahref="#impl-RefUnwindSafe">RefUnwindSafe</a><ahref="#impl-Send">Send</a><ahref="#impl-Sync">Sync</a><ahref="#impl-Unpin">Unpin</a><ahref="#impl-UnwindSafe">UnwindSafe</a></div><h3class="sidebar-title"><ahref="#blanket-implementations">Blanket Implementations</a></h3><divclass="sidebar-links"><ahref="#impl-Any">Any</a><ahref="#impl-Borrow%3CT%3E">Borrow<T></a><ahref="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><ahref="#impl-Downcast">Downcast</a><ahref="#impl-DowncastSync">DowncastSync</a><ahref="#impl-From%3CT%3E">From<T></a><ahref="#impl-Into%3CU%3E">Into<U></a><ahref="#impl-Same%3CT%3E">Same<T></a><ahref="#impl-ToOwned">ToOwned</a><ahref="#impl-TryFrom%3CU%3E">TryFrom<U></a><ahref="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><h2class="location">Other items in<br><ahref="index.html">widgetry</a></h2><divid="sidebar-vars"data-name="Image"data-ty="struct"data-relpath=""></div><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"aria-haspopup="menu"title="themes"><imgsrc="../brush.svg"width="18"height="18"alt="Pick another theme!"></button><divid="theme-choices"role="menu"></div></div><navclass="sub"><formclass="search-form"><divclass="search-container"><div><selectid="crate-search"><optionvalue="All crates">All crates</option></select><inputclass="search-input"name="search"disabledautocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"></div><buttontype="button"id="help-button"title="help">?</button><aid="settings-menu"href="../settings.html"title="settings"><imgsrc="../wheel.svg"width="18"height="18"alt="Change
}</pre></div><detailsclass="rustdoc-toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>A stylable UI component builder which presents vector graphics from an <ahref="widgets/image/enum.ImageSource.html"title="ImageSource"><code>ImageSource</code></a>.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.from_path"class="method has-srclink"><h4class="code-header">pub fn <ahref="#method.from_path"class="fnname">from_path</a>(filename: &'a <aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>) -> Self</h4><ahref="#method.from_path"class="anchor"></a><aclass="srclink"href="../src/widgetry/widgets/image.rs.html#64-69"title="goto source code">[src]</a></div></summary><divclass="docblock"><p>Create an SVG <code>Image</code>, read from <code>filename</code>, which is colored to match <code>Style.icon_fg</code></p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.untinted"class="method has-srclink"><h4class="code-header">pub fn <ahref="#method.untinted"class="fnname">untinted</a>(filename: &'a <aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>) -> Self</h4><ahref="#method.untinted"class="anchor"></a><aclass="srclink"href="../src/widgetry/widgets/image.rs.html#75-77"title="goto source code">[src]</a></div></summary><divclass="docblock"><p>Create an SVG <code>Image</code>, read from <code>filename</code>.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.from_batch"class="method has-srclink"><h4class="code-header">pub fn <ahref="#method.from_batch"class="fnname">from_batch</a>(batch: <aclass="struct"href="geom/struct.GeomBatch.html"title="struct widgetry::geom::GeomBatch">GeomBatch</a>, bounds: <aclass="struct"href="../geom/bounds/struct.Bounds.html"title="struct geom::bounds::Bounds">Bounds</a>) -> Self</h4><ahref="#method.from_batch"class="anchor"></a><aclass="srclink"href="../src/widgetry/widgets/image.rs.html#96-101"title="goto source code">[src]</a></div></summary><divclass="docblock"><p>Create a new <code>Image</code> from a <ahref="geom/struct.GeomBatch.html"title="GeomBatch"><code>GeomBatch</code></a>.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.source"class="method has-srclink"><h4class="code-header">pub fn <ahref="#method.source"class="fnname">source</a>(self, source: <aclass="enum"href="widgets/image/enum.ImageSource.html"title="enum widgetry::widgets::image::ImageSource">ImageSource</a><'a>) -> Self</h4><ahref="#method.source"class="anchor"></a><aclass="srclink"href="../src/widgetry/widgets/image.rs.html#106-109"title="goto source code">[src]</a></div></summary><divclass="docblock"><p>Set a new source for the <code>Image</code>’s data.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.source_path"class="method has-srclink"><h4class="code-header">pub fn <ahref="#method.source_path"class="fnname">source_path</a>(self, path: &'a <aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>) -> Self</h4><ahref="#method.source_path"class="anchor"></a><aclass="srclink"href="../src/widgetry/widgets/image.rs.html#114-116"title="goto source code">[src]</a></div></summary><divclass="docblock"><p>Set the path to an SVG file for the image.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.tooltip"class="method has-srclink"><h4class="code-header">pub fn <ahref="#method.tooltip"class="fnname">tooltip</a>(self, tooltip: impl <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><<aclass="struct"href="text/struct.Text.html"title="struct widgetry::text::Text">Text</a>>) -> Self</h4><ahref="#method.tooltip"class="anchor"></a><aclass="srclink"href="../src/widgetry/widgets/image.rs.html#145-148"title="goto source code">[src]</a></div></summary><divclass="docblock"><p>Add a tooltip to appear when hovering over the image.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.merged_image_style"class="method has-srclink"><h4class="code-header">pub fn <ahref="#method.merged_image_style"class="fnname">merged_image_style</a>(&'c self, other: <aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&'c </a>Self) -> Self</h4><ahref="#method.merged_image_style"class="anchor"></a><aclass="srclink"href="../src/widgetry/widgets/image.rs.html#151-170"title="goto source code">[src]</a></div></summary><divclass="docblock"><p>Create a new <code>Image</code> based on <code>self</code>, but overriding with any values set on <code>other</code>.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.color"class="method has-srclink"><h4class="code-header">pub fn <ahref="#method.color"class="fnname">color</a><RWC: <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><<aclass="enum"href="geom/enum.RewriteColor.html"title="enum widgetry::geom::RewriteColor">RewriteColor</a>>>(self, value: RWC) -> Self</h4><ahref="#method.color"class="anchor"></a><aclass="srclink"href="../src/widgetry/widgets/image.rs.html#173-176"title="goto source code">[src]</a></div></summary><divclass="docblock"><p>Rewrite the color of the image.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.bg_color"class="method has-srclink"><h4class="code-header">pub fn <ahref="#method.bg_color"class="fnname">bg_color</a>(self, value: <aclass="struct"href="color/struct.Color.html"title="struct widgetry::color::Color">Color</a>) -> Self</h4><ahref="#method.bg_color"class="anchor"></a><aclass="srclink"href="../src/widgetry/widgets/image.rs.html#179-182"title="goto source code">[src]</a></div></summary><divclass="docblock"><p>Set a background color for the image.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.dims"class="method has-srclink"><h4class="code-header">pub fn <ahref="#method.dims"class="fnname">dims</a><D: <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><<aclass="struct"href="screen_geom/struct.ScreenDims.html"title="struct widgetry::screen_geom::ScreenDims">ScreenDims</a>>>(self, dims: D) -> Self</h4><ahref="#method.dims"class="anchor"></a><aclass="srclink"href="../src/widgetry/widgets/image.rs.html#189-192"title="goto source code">[src]</a></div></summary><divclass="docblock"><p>Scale the bounds containing the image. If <code>image_dims</code> are not specified, the images
<p>See <ahref="widgets/image/struct.Image.html#method.content_mode"title="Self::content_mode"><code>Self::content_mode</code></a> to control how the image scales to fit
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.content_mode"class="method has-srclink"><h4class="code-header">pub fn <ahref="#method.content_mode"class="fnname">content_mode</a>(self, value: <aclass="enum"href="enum.ContentMode.html"title="enum widgetry::ContentMode">ContentMode</a>) -> Self</h4><ahref="#method.content_mode"class="anchor"></a><aclass="srclink"href="../src/widgetry/widgets/image.rs.html#201-204"title="goto source code">[src]</a></div></summary><divclass="docblock"><p>If a custom <code>dims</code> was set, control how the image should be scaled to its new bounds</p>
<p>The default, <ahref="enum.ContentMode.html#variant.ScaleAspectFit"title="ContentMode::ScaleAspectFit"><code>ContentMode::ScaleAspectFit</code></a> will only grow as much as it can while
then be further <code>downcast</code> into <code>Box<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <ahref="#tymethod.into_any">Read more</a></p>
further <code>downcast</code> into <code>Rc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <ahref="#tymethod.into_any_rc">Read more</a></p>
further <code>downcast</code> into <code>Arc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <ahref="#tymethod.into_any_arc">Read more</a></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-Into%3CU%3E"class="impl has-srclink"><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.From.html"title="trait core::convert::From">From</a><T>, </span></h3><ahref="#impl-Into%3CU%3E"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#533-540"title="goto source code">[src]</a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.into"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.Into.html#tymethod.into"class="fnname">into</a>(self) -> U</h4><ahref="#method.into"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#537"title="goto source code">[src]</a></div></summary><divclass='docblock'><p>Performs the conversion.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-Same%3CT%3E"class="impl has-srclink"><h3class="code-header in-band">impl<T> Same<T> for T</h3><ahref="#impl-Same%3CT%3E"class="anchor"></a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Output"class="type trait-impl has-srclink"><h4class="code-header">type <ahref="#associatedtype.Output"class="type">Output</a> = T</h4><ahref="#associatedtype.Output"class="anchor"></a></div></summary><divclass='docblock'><p>Should always be <code>Self</code></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-ToOwned"class="impl has-srclink"><h3class="code-header in-band">impl<T><aclass="trait"href="https://doc.rust-lang.org/1.54.0/alloc/borrow/trait.ToOwned.html"title="trait alloc::borrow::ToOwned">ToOwned</a> for T <spanclass="where fmt-newline">where<br> T: <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a>, </span></h3><ahref="#impl-ToOwned"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/alloc/borrow.rs.html#84-96"title="goto source code">[src]</a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Owned"class="type trait-impl has-srclink"><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.54.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned"class="type">Owned</a> = T</h4><ahref="#associatedtype.Owned"class="anchor"></a></div></summary><divclass='docblock'><p>The resulting type after obtaining ownership.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.to_owned"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned"class="fnname">to_owned</a>(&self) -> T</h4><ahref="#method.to_owned"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/alloc/borrow.rs.html#89"title="goto source code">[src]</a></div></summary><divclass='docblock'><p>Creates owned data from borrowed data, usually by cloning. <ahref="https://doc.rust-lang.org/1.54.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.clone_into"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/alloc/borrow/trait.ToOwned.html#method.clone_into"class="fnname">clone_into</a>(&self, target: <aclass="primitive"href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&mut </a>T)</h4><ahref="#method.clone_into"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/alloc/borrow.rs.html#93"title="goto source code">[src]</a></div></summary><divclass="item-info"><divclass="stab unstable"><details><summary><spanclass="emoji">🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
</details></div></div><divclass='docblock'><p>Uses borrowed data to replace owned data, usually by cloning. <ahref="https://doc.rust-lang.org/1.54.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-TryFrom%3CU%3E"class="impl has-srclink"><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.54.0/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.54.0/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></h3><ahref="#impl-TryFrom%3CU%3E"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#581-590"title="goto source code">[src]</a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Error"class="type trait-impl has-srclink"><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error"class="type">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.54.0/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4><ahref="#associatedtype.Error"class="anchor"></a></div></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.try_from"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#tymethod.try_from"class="fnname">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/1.54.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="type"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4><ahref="#method.try_from"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#587"title="goto source code">[src]</a></div></summary><divclass='docblock'><p>Performs the conversion.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><divid="impl-TryInto%3CU%3E"class="impl has-srclink"><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.54.0/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.54.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3><ahref="#impl-TryInto%3CU%3E"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#567-576"title="goto source code">[src]</a></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Error-1"class="type trait-impl has-srclink"><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryInto.html#associatedtype.Error"class="type">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4><ahref="#associatedtype.Error-1"class="anchor"></a></div></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.try_into"class="method trait-impl has-srclink"><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryInto.html#tymethod.try_into"class="fnname">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.54.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/1.54.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4><ahref="#method.try_into"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/1.54.0/src/core/convert/mod.rs.html#573"title="goto source code">[src]</a></div></summary><divclass='docblock'><p>Performs the conversion.</p>
