Files
phy/image/type.GrayImage.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

9 lines
7.4 KiB
HTML
Raw Permalink 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="Sendable grayscale image buffer"><title>GrayImage in image - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="image" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc type"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../image/index.html">image</a><span class="version">0.25.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Gray<wbr>Image</a></h2><h3><a href="#aliased-type">Aliased type</a></h3><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.expand_palette" title="expand_palette">expand_palette</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-From%3CDynamicImage%3E-for-ImageBuffer%3CLuma%3Cu8%3E,+Vec%3Cu8%3E%3E" title="From&#60;DynamicImage&#62;">From&#60;DynamicImage&#62;</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate image</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">image</a></span><h1>Type Alias <span class="type">GrayImage</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/image/buffer.rs.html#1415">Source</a> </span></div><pre class="rust item-decl"><code>pub type GrayImage = <a class="struct" href="struct.ImageBuffer.html" title="struct image::ImageBuffer">ImageBuffer</a>&lt;<a class="struct" href="struct.Luma.html" title="struct image::Luma">Luma</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>&gt;, <a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>&gt;&gt;;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Sendable grayscale image buffer</p>
</div></details><h2 id="aliased-type" class="section-header">Aliased Type<a href="#aliased-type" class="anchor">§</a></h2><pre class="rust item-decl"><code>struct GrayImage { <span class="comment">/* private fields */</span> }</code></pre><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-ImageBuffer%3CLuma%3Cu8%3E,+Vec%3Cu8%3E%3E" class="impl"><a class="src rightside" href="../src/image/buffer.rs.html#1343-1376">Source</a><a href="#impl-ImageBuffer%3CLuma%3Cu8%3E,+Vec%3Cu8%3E%3E" class="anchor">§</a><h3 class="code-header">impl <a class="type" href="type.GrayImage.html" title="type image::GrayImage">GrayImage</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.expand_palette" class="method"><a class="src rightside" href="../src/image/buffer.rs.html#1348-1375">Source</a><h4 class="code-header">pub fn <a href="#method.expand_palette" class="fn">expand_palette</a>(
self,
palette: &amp;[(<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>)],
transparent_idx: <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>&gt;,
) -&gt; <a class="type" href="type.RgbaImage.html" title="type image::RgbaImage">RgbaImage</a></h4></section></summary><div class="docblock"><p>Expands a color palette by re-using the existing buffer.
Assumes 8 bit per pixel. Uses an optionally transparent index to
adjust its alpha value accordingly.</p>
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CDynamicImage%3E-for-ImageBuffer%3CLuma%3Cu8%3E,+Vec%3Cu8%3E%3E" class="impl"><a class="src rightside" href="../src/image/buffer.rs.html#1447-1451">Source</a><a href="#impl-From%3CDynamicImage%3E-for-ImageBuffer%3CLuma%3Cu8%3E,+Vec%3Cu8%3E%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="enum" href="enum.DynamicImage.html" title="enum image::DynamicImage">DynamicImage</a>&gt; for <a class="type" href="type.GrayImage.html" title="type image::GrayImage">GrayImage</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="../src/image/buffer.rs.html#1448-1450">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(value: <a class="enum" href="enum.DynamicImage.html" title="enum image::DynamicImage">DynamicImage</a>) -&gt; Self</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details></div><script src="../type.impl/image/struct.ImageBuffer.js" data-self-path="image::buffer_::GrayImage" async></script></section></div></main></body></html>