| <!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="Image representations for ffi."><meta name="keywords" content="rust, rustlang, rust-lang, flat"><title>image::flat - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[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">☰</button><a class="sidebar-logo" href="../../image/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../image/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module flat</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">image</a>::<wbr><a class="mod" href="#">flat</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/image/flat.rs.html#1-1645">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Image representations for ffi.</p> |
| <h2 id="usage"><a href="#usage">Usage</a></h2> |
| <p>Imagine you want to offer a very simple ffi interface: The caller provides an image buffer and |
| your program creates a thumbnail from it and dumps that image as <code>png</code>. This module is designed |
| to help you transition from raw memory data to Rust representation.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::ptr; |
| <span class="kw">use </span>std::slice; |
| <span class="kw">use </span>image::Rgb; |
| <span class="kw">use </span>image::flat::{FlatSamples, SampleLayout}; |
| <span class="kw">use </span>image::imageops::thumbnail; |
| |
| <span class="attribute">#[no_mangle] |
| </span><span class="kw">pub extern </span><span class="string">"C" </span><span class="kw">fn </span>store_rgb8_compressed( |
| data: <span class="kw-2">*const </span>u8, len: usize, |
| layout: <span class="kw-2">*const </span>SampleLayout |
| ) |
| -> bool |
| { |
| <span class="kw">let </span>samples = <span class="kw">unsafe </span>{ slice::from_raw_parts(data, len) }; |
| <span class="kw">let </span>layout = <span class="kw">unsafe </span>{ ptr::read(layout) }; |
| |
| <span class="kw">let </span>buffer = FlatSamples { |
| samples, |
| layout, |
| color_hint: <span class="prelude-val">None</span>, |
| }; |
| |
| <span class="kw">let </span>view = <span class="kw">match </span>buffer.as_view::<Rgb<u8>>() { |
| <span class="prelude-val">Err</span>(<span class="kw">_</span>) => <span class="kw">return </span><span class="bool-val">false</span>, <span class="comment">// Invalid layout. |
| </span><span class="prelude-val">Ok</span>(view) => view, |
| }; |
| |
| thumbnail(<span class="kw-2">&</span>view, <span class="number">64</span>, <span class="number">64</span>) |
| .save(<span class="string">"output.png"</span>) |
| .map(|<span class="kw">_</span>| <span class="bool-val">true</span>) |
| .unwrap_or_else(|<span class="kw">_</span>| <span class="bool-val">false</span>) |
| }</code></pre></div> |
| </div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FlatSamples.html" title="image::flat::FlatSamples struct">FlatSamples</a></div><div class="item-right docblock-short">A flat buffer over a (multi channel) image.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SampleLayout.html" title="image::flat::SampleLayout struct">SampleLayout</a></div><div class="item-right docblock-short">A ffi compatible description of a sample buffer.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.View.html" title="image::flat::View struct">View</a></div><div class="item-right docblock-short">A flat buffer that can be used as an image view.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ViewMut.html" title="image::flat::ViewMut struct">ViewMut</a></div><div class="item-right docblock-short">A mutable owning version of a flat buffer.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Error.html" title="image::flat::Error enum">Error</a></div><div class="item-right docblock-short">Denotes invalid flat sample buffers when trying to convert to stricter types.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.NormalForm.html" title="image::flat::NormalForm enum">NormalForm</a></div><div class="item-right docblock-short">Different normal forms of buffers.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="image" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
