| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/image-0.23.14/./src/imageops/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs - source</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="../../../source-script.js"></script><script defer src="../../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><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></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../image/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! Image Processing Functions |
| </span><span class="kw">use </span>std::cmp; |
| |
| <span class="kw">use </span>num_traits::{NumCast}; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::image::{GenericImage, GenericImageView, SubImage}; |
| <span class="kw">use </span><span class="kw">crate</span>::traits::{Lerp, Primitive, Pixel}; |
| |
| <span class="kw">pub use </span><span class="self">self</span>::sample::FilterType; |
| |
| <span class="kw">pub use </span><span class="self">self</span>::sample::FilterType::{CatmullRom, Gaussian, Lanczos3, Nearest, Triangle}; |
| |
| <span class="doccomment">/// Affine transformations |
| </span><span class="kw">pub use </span><span class="self">self</span>::affine::{ |
| flip_horizontal, flip_horizontal_in_place, flip_vertical, flip_vertical_in_place, rotate180, |
| rotate180_in_place, rotate270, rotate90, rotate180_in, rotate90_in, rotate270_in, flip_horizontal_in, flip_vertical_in |
| }; |
| |
| <span class="doccomment">/// Image sampling |
| </span><span class="kw">pub use </span><span class="self">self</span>::sample::{blur, filter3x3, resize, thumbnail, unsharpen}; |
| |
| <span class="doccomment">/// Color operations |
| </span><span class="kw">pub use </span><span class="self">self</span>::colorops::{brighten, contrast, dither, grayscale, huerotate, index_colors, invert, |
| BiLevel, ColorMap}; |
| |
| <span class="kw">mod </span>affine; |
| <span class="comment">// Public only because of Rust bug: |
| // https://github.com/rust-lang/rust/issues/18241 |
| </span><span class="kw">pub mod </span>colorops; |
| <span class="kw">mod </span>sample; |
| |
| <span class="doccomment">/// Return a mutable view into an image |
| /// The coordinates set the position of the top left corner of the crop. |
| </span><span class="kw">pub fn </span>crop<I: GenericImageView>( |
| image: <span class="kw-2">&mut </span>I, |
| x: u32, |
| y: u32, |
| width: u32, |
| height: u32, |
| ) -> SubImage<<span class="kw-2">&mut </span>I> { |
| <span class="kw">let </span>(x, y, width, height) = crop_dimms(image, x, y, width, height); |
| SubImage::new(image, x, y, width, height) |
| } |
| |
| <span class="doccomment">/// Return an immutable view into an image |
| /// The coordinates set the position of the top left corner of the crop. |
| </span><span class="kw">pub fn </span>crop_imm<I: GenericImageView>( |
| image: <span class="kw-2">&</span>I, |
| x: u32, |
| y: u32, |
| width: u32, |
| height: u32, |
| ) -> SubImage<<span class="kw-2">&</span>I> { |
| <span class="kw">let </span>(x, y, width, height) = crop_dimms(image, x, y, width, height); |
| SubImage::new(image, x, y, width, height) |
| } |
| |
| <span class="kw">fn </span>crop_dimms<I: GenericImageView>( |
| image: <span class="kw-2">&</span>I, |
| x: u32, |
| y: u32, |
| width: u32, |
| height: u32, |
| ) -> (u32, u32, u32, u32) { |
| <span class="kw">let </span>(iwidth, iheight) = image.dimensions(); |
| |
| <span class="kw">let </span>x = cmp::min(x, iwidth); |
| <span class="kw">let </span>y = cmp::min(y, iheight); |
| |
| <span class="kw">let </span>height = cmp::min(height, iheight - y); |
| <span class="kw">let </span>width = cmp::min(width, iwidth - x); |
| |
| (x, y, width, height) |
| } |
| |
| <span class="doccomment">/// Calculate the region that can be copied from top to bottom. |
| /// |
| /// Given image size of bottom and top image, and a point at which we want to place the top image |
| /// onto the bottom image, how large can we be? Have to wary of the following issues: |
| /// * Top might be larger than bottom |
| /// * Overflows in the computation |
| /// * Coordinates could be completely out of bounds |
| /// |
| /// The main idea is to make use of inequalities provided by the nature of `saturing_add` and |
| /// `saturating_sub`. These intrinsically validate that all resulting coordinates will be in bounds |
| /// for both images. |
| /// |
| /// We want that all these coordinate accesses are safe: |
| /// 1. `bottom.get_pixel(x + [0..x_range), y + [0..y_range))` |
| /// 2. `top.get_pixel([0..x_range), [0..y_range))` |
| /// |
| /// Proof that the function provides the necessary bounds for width. Note that all unaugmented math |
| /// operations are to be read in standard arithmetic, not integer arithmetic. Since no direct |
| /// integer arithmetic occurs in the implementation, this is unambiguous. |
| /// |
| /// ```text |
| /// Three short notes/lemmata: |
| /// - Iff `(a - b) <= 0` then `a.saturating_sub(b) = 0` |
| /// - Iff `(a - b) >= 0` then `a.saturating_sub(b) = a - b` |
| /// - If `a <= c` then `a.saturating_sub(b) <= c.saturating_sub(b)` |
| /// |
| /// 1.1 We show that if `bottom_width <= x`, then `x_range = 0` therefore `x + [0..x_range)` is empty. |
| /// |
| /// x_range |
| /// = (top_width.saturating_add(x).min(bottom_width)).saturating_sub(x) |
| /// <= bottom_width.saturating_sub(x) |
| /// |
| /// bottom_width <= x |
| /// <==> bottom_width - x <= 0 |
| /// <==> bottom_width.saturating_sub(x) = 0 |
| /// ==> x_range <= 0 |
| /// ==> x_range = 0 |
| /// |
| /// 1.2 If `x < bottom_width` then `x + x_range < bottom_width` |
| /// |
| /// x + x_range |
| /// <= x + bottom_width.saturating_sub(x) |
| /// = x + (bottom_width - x) |
| /// = bottom_width |
| /// |
| /// 2. We show that `x_range <= top_width` |
| /// |
| /// x_range |
| /// = (top_width.saturating_add(x).min(bottom_width)).saturating_sub(x) |
| /// <= top_width.saturating_add(x).saturating_sub(x) |
| /// <= (top_wdith + x).saturating_sub(x) |
| /// = top_width (due to `top_width >= 0` and `x >= 0`) |
| /// ``` |
| /// |
| /// Proof is the same for height. |
| </span><span class="kw">pub fn </span>overlay_bounds( |
| (bottom_width, bottom_height): (u32, u32), |
| (top_width, top_height): (u32, u32), |
| x: u32, |
| y: u32 |
| ) |
| -> (u32, u32) |
| { |
| <span class="kw">let </span>x_range = top_width.saturating_add(x) <span class="comment">// Calculate max coordinate |
| </span>.min(bottom_width) <span class="comment">// Restrict to lower width |
| </span>.saturating_sub(x); <span class="comment">// Determinate length from start `x` |
| </span><span class="kw">let </span>y_range = top_height.saturating_add(y) |
| .min(bottom_height) |
| .saturating_sub(y); |
| (x_range, y_range) |
| } |
| |
| <span class="doccomment">/// Overlay an image at a given coordinate (x, y) |
| </span><span class="kw">pub fn </span>overlay<I, J>(bottom: <span class="kw-2">&mut </span>I, top: <span class="kw-2">&</span>J, x: u32, y: u32) |
| <span class="kw">where |
| </span>I: GenericImage, |
| J: GenericImageView<Pixel = I::Pixel>, |
| { |
| <span class="kw">let </span>bottom_dims = bottom.dimensions(); |
| <span class="kw">let </span>top_dims = top.dimensions(); |
| |
| <span class="comment">// Crop our top image if we're going out of bounds |
| </span><span class="kw">let </span>(range_width, range_height) = overlay_bounds(bottom_dims, top_dims, x, y); |
| |
| <span class="kw">for </span>top_y <span class="kw">in </span><span class="number">0</span>..range_height { |
| <span class="kw">for </span>top_x <span class="kw">in </span><span class="number">0</span>..range_width { |
| <span class="kw">let </span>p = top.get_pixel(top_x, top_y); |
| <span class="kw">let </span><span class="kw-2">mut </span>bottom_pixel = bottom.get_pixel(x + top_x, y + top_y); |
| bottom_pixel.blend(<span class="kw-2">&</span>p); |
| |
| bottom.put_pixel(x + top_x, y + top_y, bottom_pixel); |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Tile an image by repeating it multiple times |
| /// |
| /// # Examples |
| /// ```no_run |
| /// use image::{RgbaImage}; |
| /// |
| /// let mut img = RgbaImage::new(1920, 1080); |
| /// let tile = image::open("tile.png").unwrap(); |
| /// |
| /// image::imageops::tile(&mut img, &tile); |
| /// img.save("tiled_wallpaper.png").unwrap(); |
| /// ``` |
| </span><span class="kw">pub fn </span>tile<I, J>(bottom: <span class="kw-2">&mut </span>I, top: <span class="kw-2">&</span>J) |
| <span class="kw">where |
| </span>I: GenericImage, |
| J: GenericImageView<Pixel = I::Pixel>, |
| { |
| <span class="kw">for </span>x <span class="kw">in </span>(<span class="number">0</span>..bottom.width()).step_by(top.width() <span class="kw">as </span>usize) { |
| <span class="kw">for </span>y <span class="kw">in </span>(<span class="number">0</span>..bottom.height()).step_by(top.height() <span class="kw">as </span>usize) { |
| overlay(bottom, top, x, y); |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Fill the image with a linear vertical gradient |
| /// |
| /// This function assumes a linear color space. |
| /// |
| /// # Examples |
| /// ```no_run |
| /// use image::{Rgba, RgbaImage, Pixel}; |
| /// |
| /// let mut img = RgbaImage::new(100, 100); |
| /// let start = Rgba::from_slice(&[0, 128, 0, 0]); |
| /// let end = Rgba::from_slice(&[255, 255, 255, 255]); |
| /// |
| /// image::imageops::vertical_gradient(&mut img, start, end); |
| /// img.save("vertical_gradient.png").unwrap(); |
| </span><span class="kw">pub fn </span>vertical_gradient<S, P, I>(img: <span class="kw-2">&mut </span>I, start: <span class="kw-2">&</span>P, stop: <span class="kw-2">&</span>P) |
| <span class="kw">where |
| </span>I: GenericImage<Pixel = P>, |
| P: Pixel<Subpixel = S> + <span class="lifetime">'static</span>, |
| S: Primitive + Lerp + <span class="lifetime">'static |
| </span>{ |
| <span class="kw">for </span>y <span class="kw">in </span><span class="number">0</span>..img.height() { |
| <span class="kw">let </span>pixel = start.map2(stop, |a, b| { |
| <span class="kw">let </span>y = <S::Ratio <span class="kw">as </span>NumCast>::from(y).unwrap(); |
| <span class="kw">let </span>height = <S::Ratio <span class="kw">as </span>NumCast>::from(img.height() - <span class="number">1</span>).unwrap(); |
| S::lerp(a, b, y / height) |
| }); |
| |
| <span class="kw">for </span>x <span class="kw">in </span><span class="number">0</span>..img.width() { |
| img.put_pixel(x, y, pixel); |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Fill the image with a linear horizontal gradient |
| /// |
| /// This function assumes a linear color space. |
| /// |
| /// # Examples |
| /// ```no_run |
| /// use image::{Rgba, RgbaImage, Pixel}; |
| /// |
| /// let mut img = RgbaImage::new(100, 100); |
| /// let start = Rgba::from_slice(&[0, 128, 0, 0]); |
| /// let end = Rgba::from_slice(&[255, 255, 255, 255]); |
| /// |
| /// image::imageops::horizontal_gradient(&mut img, start, end); |
| /// img.save("horizontal_gradient.png").unwrap(); |
| </span><span class="kw">pub fn </span>horizontal_gradient<S, P, I>(img: <span class="kw-2">&mut </span>I, start: <span class="kw-2">&</span>P, stop: <span class="kw-2">&</span>P) |
| <span class="kw">where |
| </span>I: GenericImage<Pixel = P>, |
| P: Pixel<Subpixel = S> + <span class="lifetime">'static</span>, |
| S: Primitive + Lerp + <span class="lifetime">'static |
| </span>{ |
| <span class="kw">for </span>x <span class="kw">in </span><span class="number">0</span>..img.width() { |
| <span class="kw">let </span>pixel = start.map2(stop, |a, b| { |
| <span class="kw">let </span>x = <S::Ratio <span class="kw">as </span>NumCast>::from(x).unwrap(); |
| <span class="kw">let </span>width = <S::Ratio <span class="kw">as </span>NumCast>::from(img.width() - <span class="number">1</span>).unwrap(); |
| S::lerp(a, b, x / width) |
| }); |
| |
| <span class="kw">for </span>y <span class="kw">in </span><span class="number">0</span>..img.height() { |
| img.put_pixel(x, y, pixel); |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Replace the contents of an image at a given coordinate (x, y) |
| </span><span class="kw">pub fn </span>replace<I, J>(bottom: <span class="kw-2">&mut </span>I, top: <span class="kw-2">&</span>J, x: u32, y: u32) |
| <span class="kw">where |
| </span>I: GenericImage, |
| J: GenericImageView<Pixel = I::Pixel>, |
| { |
| <span class="kw">let </span>bottom_dims = bottom.dimensions(); |
| <span class="kw">let </span>top_dims = top.dimensions(); |
| |
| <span class="comment">// Crop our top image if we're going out of bounds |
| </span><span class="kw">let </span>(range_width, range_height) = overlay_bounds(bottom_dims, top_dims, x, y); |
| |
| <span class="kw">for </span>top_y <span class="kw">in </span><span class="number">0</span>..range_height { |
| <span class="kw">for </span>top_x <span class="kw">in </span><span class="number">0</span>..range_width { |
| <span class="kw">let </span>p = top.get_pixel(top_x, top_y); |
| bottom.put_pixel(x + top_x, y + top_y, p); |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| |
| <span class="kw">use </span><span class="kw">super</span>::overlay; |
| <span class="kw">use </span><span class="kw">crate</span>::RgbaImage; |
| <span class="kw">use </span><span class="kw">crate</span>::ImageBuffer; |
| <span class="kw">use </span><span class="kw">crate</span>::color::Rgb; |
| |
| <span class="attribute">#[test] |
| </span><span class="doccomment">/// Test that images written into other images works |
| </span><span class="kw">fn </span>test_image_in_image() { |
| <span class="kw">let </span><span class="kw-2">mut </span>target = ImageBuffer::new(<span class="number">32</span>, <span class="number">32</span>); |
| <span class="kw">let </span>source = ImageBuffer::from_pixel(<span class="number">16</span>, <span class="number">16</span>, Rgb([<span class="number">255u8</span>, <span class="number">0</span>, <span class="number">0</span>])); |
| overlay(<span class="kw-2">&mut </span>target, <span class="kw-2">&</span>source, <span class="number">0</span>, <span class="number">0</span>); |
| <span class="macro">assert!</span>(<span class="kw-2">*</span>target.get_pixel(<span class="number">0</span>, <span class="number">0</span>) == Rgb([<span class="number">255u8</span>, <span class="number">0</span>, <span class="number">0</span>])); |
| <span class="macro">assert!</span>(<span class="kw-2">*</span>target.get_pixel(<span class="number">15</span>, <span class="number">0</span>) == Rgb([<span class="number">255u8</span>, <span class="number">0</span>, <span class="number">0</span>])); |
| <span class="macro">assert!</span>(<span class="kw-2">*</span>target.get_pixel(<span class="number">16</span>, <span class="number">0</span>) == Rgb([<span class="number">0u8</span>, <span class="number">0</span>, <span class="number">0</span>])); |
| <span class="macro">assert!</span>(<span class="kw-2">*</span>target.get_pixel(<span class="number">0</span>, <span class="number">15</span>) == Rgb([<span class="number">255u8</span>, <span class="number">0</span>, <span class="number">0</span>])); |
| <span class="macro">assert!</span>(<span class="kw-2">*</span>target.get_pixel(<span class="number">0</span>, <span class="number">16</span>) == Rgb([<span class="number">0u8</span>, <span class="number">0</span>, <span class="number">0</span>])); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="doccomment">/// Test that images written outside of a frame doesn't blow up |
| </span><span class="kw">fn </span>test_image_in_image_outside_of_bounds() { |
| <span class="kw">let </span><span class="kw-2">mut </span>target = ImageBuffer::new(<span class="number">32</span>, <span class="number">32</span>); |
| <span class="kw">let </span>source = ImageBuffer::from_pixel(<span class="number">32</span>, <span class="number">32</span>, Rgb([<span class="number">255u8</span>, <span class="number">0</span>, <span class="number">0</span>])); |
| overlay(<span class="kw-2">&mut </span>target, <span class="kw-2">&</span>source, <span class="number">1</span>, <span class="number">1</span>); |
| <span class="macro">assert!</span>(<span class="kw-2">*</span>target.get_pixel(<span class="number">0</span>, <span class="number">0</span>) == Rgb([<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>])); |
| <span class="macro">assert!</span>(<span class="kw-2">*</span>target.get_pixel(<span class="number">1</span>, <span class="number">1</span>) == Rgb([<span class="number">255u8</span>, <span class="number">0</span>, <span class="number">0</span>])); |
| <span class="macro">assert!</span>(<span class="kw-2">*</span>target.get_pixel(<span class="number">31</span>, <span class="number">31</span>) == Rgb([<span class="number">255u8</span>, <span class="number">0</span>, <span class="number">0</span>])); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="doccomment">/// Test that images written to coordinates out of the frame doesn't blow up |
| /// (issue came up in #848) |
| </span><span class="kw">fn </span>test_image_outside_image_no_wrap_around() { |
| <span class="kw">let </span><span class="kw-2">mut </span>target = ImageBuffer::new(<span class="number">32</span>, <span class="number">32</span>); |
| <span class="kw">let </span>source = ImageBuffer::from_pixel(<span class="number">32</span>, <span class="number">32</span>, Rgb([<span class="number">255u8</span>, <span class="number">0</span>, <span class="number">0</span>])); |
| overlay(<span class="kw-2">&mut </span>target, <span class="kw-2">&</span>source, <span class="number">33</span>, <span class="number">33</span>); |
| <span class="macro">assert!</span>(<span class="kw-2">*</span>target.get_pixel(<span class="number">0</span>, <span class="number">0</span>) == Rgb([<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>])); |
| <span class="macro">assert!</span>(<span class="kw-2">*</span>target.get_pixel(<span class="number">1</span>, <span class="number">1</span>) == Rgb([<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>])); |
| <span class="macro">assert!</span>(<span class="kw-2">*</span>target.get_pixel(<span class="number">31</span>, <span class="number">31</span>) == Rgb([<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>])); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="doccomment">/// Test that images written to coordinates with overflow works |
| </span><span class="kw">fn </span>test_image_coordinate_overflow() { |
| <span class="kw">let </span><span class="kw-2">mut </span>target = ImageBuffer::new(<span class="number">16</span>, <span class="number">16</span>); |
| <span class="kw">let </span>source = ImageBuffer::from_pixel(<span class="number">32</span>, <span class="number">32</span>, Rgb([<span class="number">255u8</span>, <span class="number">0</span>, <span class="number">0</span>])); |
| <span class="comment">// Overflows to 'sane' coordinates but top is larger than bot. |
| </span>overlay(<span class="kw-2">&mut </span>target, <span class="kw-2">&</span>source, u32::max_value() - <span class="number">31</span>, u32::max_value() - <span class="number">31</span>); |
| <span class="macro">assert!</span>(<span class="kw-2">*</span>target.get_pixel(<span class="number">0</span>, <span class="number">0</span>) == Rgb([<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>])); |
| <span class="macro">assert!</span>(<span class="kw-2">*</span>target.get_pixel(<span class="number">1</span>, <span class="number">1</span>) == Rgb([<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>])); |
| <span class="macro">assert!</span>(<span class="kw-2">*</span>target.get_pixel(<span class="number">15</span>, <span class="number">15</span>) == Rgb([<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>])); |
| } |
| |
| <span class="kw">use super</span>::{horizontal_gradient, vertical_gradient}; |
| |
| <span class="attribute">#[test] |
| </span><span class="doccomment">/// Test that horizontal gradients are correctly generated |
| </span><span class="kw">fn </span>test_image_horizontal_gradient_limits() { |
| <span class="kw">let </span><span class="kw-2">mut </span>img = ImageBuffer::new(<span class="number">100</span>, <span class="number">1</span>); |
| |
| <span class="kw">let </span>start = Rgb([<span class="number">0u8</span>, <span class="number">128</span>, <span class="number">0</span>]); |
| <span class="kw">let </span>end = Rgb([<span class="number">255u8</span>, <span class="number">255</span>, <span class="number">255</span>]); |
| |
| horizontal_gradient(<span class="kw-2">&mut </span>img, <span class="kw-2">&</span>start, <span class="kw-2">&</span>end); |
| |
| <span class="macro">assert_eq!</span>(img.get_pixel(<span class="number">0</span>, <span class="number">0</span>), <span class="kw-2">&</span>start); |
| <span class="macro">assert_eq!</span>(img.get_pixel(img.width() - <span class="number">1</span>, <span class="number">0</span>), <span class="kw-2">&</span>end); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="doccomment">/// Test that vertical gradients are correctly generated |
| </span><span class="kw">fn </span>test_image_vertical_gradient_limits() { |
| <span class="kw">let </span><span class="kw-2">mut </span>img = ImageBuffer::new(<span class="number">1</span>, <span class="number">100</span>); |
| |
| <span class="kw">let </span>start = Rgb([<span class="number">0u8</span>, <span class="number">128</span>, <span class="number">0</span>]); |
| <span class="kw">let </span>end = Rgb([<span class="number">255u8</span>, <span class="number">255</span>, <span class="number">255</span>]); |
| |
| vertical_gradient(<span class="kw-2">&mut </span>img, <span class="kw-2">&</span>start, <span class="kw-2">&</span>end); |
| |
| <span class="macro">assert_eq!</span>(img.get_pixel(<span class="number">0</span>, <span class="number">0</span>), <span class="kw-2">&</span>start); |
| <span class="macro">assert_eq!</span>(img.get_pixel(<span class="number">0</span>, img.height() - <span class="number">1</span>), <span class="kw-2">&</span>end); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="doccomment">/// Test blur doens't panick when passed 0.0 |
| </span><span class="kw">fn </span>test_blur_zero() { |
| <span class="kw">let </span>image = RgbaImage::new(<span class="number">50</span>, <span class="number">50</span>); |
| <span class="kw">let _ </span>= <span class="kw">super</span>::blur(<span class="kw-2">&</span>image, <span class="number">0.0</span>); |
| } |
| } |
| </code></pre></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> |
