27 lines
7.1 KiB
HTML
27 lines
7.1 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="The trait all encoders implement"><title>ImageEncoder 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 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" 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="#">Image<wbr>Encoder</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.write_image" title="write_image">write_image</a></li></ul><h3><a href="#implementors">Implementors</a></h3></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>Trait <span class="trait">ImageEncoder</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/image.rs.html#757-779">Source</a> </span></div><pre class="rust item-decl"><code>pub trait ImageEncoder {
|
|
// Required method
|
|
fn <a href="#tymethod.write_image" class="fn">write_image</a>(
|
|
self,
|
|
buf: &[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>],
|
|
width: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>,
|
|
height: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>,
|
|
color_type: <a class="enum" href="enum.ExtendedColorType.html" title="enum image::ExtendedColorType">ExtendedColorType</a>,
|
|
) -> <a class="type" href="error/type.ImageResult.html" title="type image::error::ImageResult">ImageResult</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The trait all encoders implement</p>
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.write_image" class="method"><a class="src rightside" href="../src/image/image.rs.html#772-778">Source</a><h4 class="code-header">fn <a href="#tymethod.write_image" class="fn">write_image</a>(
|
|
self,
|
|
buf: &[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>],
|
|
width: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>,
|
|
height: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>,
|
|
color_type: <a class="enum" href="enum.ExtendedColorType.html" title="enum image::ExtendedColorType">ExtendedColorType</a>,
|
|
) -> <a class="type" href="error/type.ImageResult.html" title="type image::error::ImageResult">ImageResult</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Writes all the bytes in an image to the encoder.</p>
|
|
<p>This function takes a slice of bytes of the pixel data of the image
|
|
and encodes them. Unlike particular format encoders inherent impl encode
|
|
methods where endianness is not specified, here image data bytes should
|
|
always be in native endian. The implementor will reorder the endianness
|
|
as necessary for the target encoding format.</p>
|
|
<p>See also <code>ImageDecoder::read_image</code> which reads byte buffers into
|
|
native endian.</p>
|
|
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
|
|
<p>Panics if <code>width * height * color_type.bytes_per_pixel() != buf.len()</code>.</p>
|
|
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-ImageEncoder-for-HdrEncoder%3CW%3E" class="impl"><a class="src rightside" href="../src/image/codecs/hdr/encoder.rs.html#13-38">Source</a><a href="#impl-ImageEncoder-for-HdrEncoder%3CW%3E" class="anchor">§</a><h3 class="code-header">impl<W: <a class="trait" href="https://doc.rust-lang.org/1.84.0/std/io/trait.Write.html" title="trait std::io::Write">Write</a>> <a class="trait" href="trait.ImageEncoder.html" title="trait image::ImageEncoder">ImageEncoder</a> for <a class="struct" href="codecs/hdr/struct.HdrEncoder.html" title="struct image::codecs::hdr::HdrEncoder">HdrEncoder</a><W></h3></section><section id="impl-ImageEncoder-for-PngEncoder%3CW%3E" class="impl"><a class="src rightside" href="../src/image/codecs/png.rs.html#596-646">Source</a><a href="#impl-ImageEncoder-for-PngEncoder%3CW%3E" class="anchor">§</a><h3 class="code-header">impl<W: <a class="trait" href="https://doc.rust-lang.org/1.84.0/std/io/trait.Write.html" title="trait std::io::Write">Write</a>> <a class="trait" href="trait.ImageEncoder.html" title="trait image::ImageEncoder">ImageEncoder</a> for <a class="struct" href="codecs/png/struct.PngEncoder.html" title="struct image::codecs::png::PngEncoder">PngEncoder</a><W></h3></section></div><script src="../trait.impl/image/image/trait.ImageEncoder.js" async></script></section></div></main></body></html> |