1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
//! A module for common image editing operations. // from rust use std::cmp; // from external crate // from local crate use error::{RasterError, RasterResult}; use blend::{self, BlendMode}; use Color; use Image; use position::{Position, PositionMode}; use transform; /// Blend 2 images into one. The image1 is the base and image2 is the top. /// /// Opacity is any value from 0.0 - 1.0 /// /// The `offset_x` and `offset_y` are added to the final position. Can also be negative offsets. /// /// # Errors /// /// If image2 falls outside the canvas area, then this fails with /// `RasterError::BlendingImageFallsOutsideCanvas`. /// /// # Examples /// ``` /// use raster::{editor, BlendMode, PositionMode}; /// /// // Create images from file /// let image1 = raster::open("tests/in/sample.jpg").unwrap(); /// let image2 = raster::open("tests/in/watermark.png").unwrap(); /// /// // Blend image2 on top of image1 using normal mode, opacity of 1.0 (100%), with image2 at the /// // center, with 0 x and 0 y offsets. whew /// let normal = editor::blend(&image1, &image2, BlendMode::Normal, 1.0, PositionMode::Center, 0, 0).unwrap(); /// /// // All the other blend modes /// let difference = editor::blend(&image1, &image2, BlendMode::Difference, 1.0, PositionMode::Center, 0, 0).unwrap(); /// let multiply = editor::blend(&image1, &image2, BlendMode::Multiply, 1.0, PositionMode::Center, 0, 0).unwrap(); /// let overlay = editor::blend(&image1, &image2, BlendMode::Overlay, 1.0, PositionMode::Center, 0, 0).unwrap(); /// let screen = editor::blend(&image1, &image2, BlendMode::Screen, 1.0, PositionMode::Center, 0, 0).unwrap(); /// /// // Save it /// raster::save(&normal, "tests/out/test_blend_normal.png").unwrap(); /// raster::save(&difference, "tests/out/test_blend_difference.png").unwrap(); /// raster::save(&multiply, "tests/out/test_blend_multiply.png").unwrap(); /// raster::save(&overlay, "tests/out/test_blend_overlay.png").unwrap(); /// raster::save(&screen, "tests/out/test_blend_screen.png").unwrap(); /// ``` /// ### Source Images /// /// Image 1 /// ///  /// /// Image 2 /// ///  /// /// ### Blended Images /// /// Normal /// ///  /// /// Difference /// ///  /// /// /// Multiply /// ///  /// /// /// Overlay /// ///  /// /// /// Screen /// ///  /// pub fn blend( image1: &Image, image2: &Image, blend_mode: BlendMode, opacity: f32, position: PositionMode, offset_x: i32, offset_y: i32, ) -> RasterResult<Image> { let opacity = if opacity > 1.0 { 1.0 } else if opacity < 0.0 { 0.0 } else { opacity }; // Turn into positioner struct let positioner = Position::new(position, offset_x, offset_y); // Position is for image2, image1 is canvas. let (offset_x, offset_y) = positioner.get_x_y(image1.width, image1.height, image2.width, image2.height)?; let (w1, h1) = (image1.width, image1.height); let (w2, h2) = (image2.width, image2.height); // Check if it overlaps if (offset_x >= w1) || (offset_x + w2 <= 0) || (offset_y >= h1) || (offset_y + h2 <= 0) { return Err(RasterError::BlendingImageFallsOutsideCanvas); } // Loop start X let mut loop_start_x = 0; let canvas_start_x = offset_x; if canvas_start_x < 0 { let diff = 0 - canvas_start_x; loop_start_x += diff; } // Loop end X let mut loop_end_x = w2; let canvas_end_x = offset_x + w2; if canvas_end_x > w1 { let diff = canvas_end_x - w1; loop_end_x -= diff; } // Loop start Y let mut loop_start_y = 0; let canvas_start_y = offset_y; if canvas_start_y < 0 { let diff = 0 - canvas_start_y; loop_start_y += diff; } // Loop end Y let mut loop_end_y = h2; let canvas_end_y = offset_y + h2; if canvas_end_y > h1 { let diff = canvas_end_y - h1; loop_end_y -= diff; } match blend_mode { BlendMode::Normal => blend::normal( image1, image2, loop_start_y, loop_end_y, loop_start_x, loop_end_x, offset_x, offset_y, opacity, ), BlendMode::Difference => blend::difference( image1, image2, loop_start_y, loop_end_y, loop_start_x, loop_end_x, offset_x, offset_y, opacity, ), BlendMode::Multiply => blend::multiply( image1, image2, loop_start_y, loop_end_y, loop_start_x, loop_end_x, offset_x, offset_y, opacity, ), BlendMode::Overlay => blend::overlay( image1, image2, loop_start_y, loop_end_y, loop_start_x, loop_end_x, offset_x, offset_y, opacity, ), BlendMode::Screen => blend::screen( image1, image2, loop_start_y, loop_end_y, loop_start_x, loop_end_x, offset_x, offset_y, opacity, ), } } /// Crop the image to the given dimension and position. /// /// The `offset_x` and `offset_y` are added to the final position. Can also be negative offsets. /// Offsets can be used to nudge the final position. Or you can set the position to /// `PositionMode::TopLeft` and use the offsets as a normal screen x and y coordinates. /// /// # Examples /// /// ### Input /// ///  /// /// ### Code /// /// ``` /// use raster::{editor, PositionMode}; /// /// // Create image from file /// let mut top_left = raster::open("tests/in/crop-test.jpg").unwrap(); /// /// // Make copies /// let mut top_center = top_left.clone(); /// let mut top_right = top_left.clone(); /// /// let mut center_left = top_left.clone(); /// let mut center = top_left.clone(); /// let mut center_right = top_left.clone(); /// /// let mut bottom_left = top_left.clone(); /// let mut bottom_center = top_left.clone(); /// let mut bottom_right = top_left.clone(); /// /// // Crop it /// editor::crop(&mut top_left, 167, 93, PositionMode::TopLeft, 0, 0).unwrap(); /// editor::crop(&mut top_center, 166, 93, PositionMode::TopCenter, 0, 0).unwrap(); /// editor::crop(&mut top_right, 167, 93, PositionMode::TopRight, 0, 0).unwrap(); /// /// editor::crop(&mut center_left, 167, 93, PositionMode::CenterLeft, 0, 0).unwrap(); /// editor::crop(&mut center, 166, 93, PositionMode::Center, 0, 0).unwrap(); /// editor::crop(&mut center_right, 167, 93, PositionMode::CenterRight, 0, 0).unwrap(); /// /// editor::crop(&mut bottom_left, 167, 93, PositionMode::BottomLeft, 0, 0).unwrap(); /// editor::crop(&mut bottom_center, 166, 93, PositionMode::BottomCenter, 0, 0).unwrap(); /// editor::crop(&mut bottom_right, 167, 93, PositionMode::BottomRight, 0, 0).unwrap(); /// /// // Save it /// raster::save(&top_left, "tests/out/test_crop_top_left.jpg").unwrap(); /// raster::save(&top_center, "tests/out/test_crop_top_center.jpg").unwrap(); /// raster::save(&top_right, "tests/out/test_crop_top_right.jpg").unwrap(); /// /// raster::save(¢er_left, "tests/out/test_crop_center_left.jpg").unwrap(); /// raster::save(¢er, "tests/out/test_crop_center.jpg").unwrap(); /// raster::save(¢er_right, "tests/out/test_crop_center_right.jpg").unwrap(); /// /// raster::save(&bottom_left, "tests/out/test_crop_bottom_left.jpg").unwrap(); /// raster::save(&bottom_center, "tests/out/test_crop_bottom_center.jpg").unwrap(); /// raster::save(&bottom_right, "tests/out/test_crop_bottom_right.jpg").unwrap(); /// ``` /// /// ### Output /// The cropped images arranged in a grid, showing how you can easily set the crop position. /// ///    ///    ///    pub fn crop( src: &mut Image, crop_width: i32, crop_height: i32, position: PositionMode, offset_x: i32, offset_y: i32, ) -> RasterResult<()> { // Turn into positioner struct let positioner = Position::new(position, offset_x, offset_y); let (offset_x, offset_y) = positioner.get_x_y(src.width, src.height, crop_width, crop_height)?; let offset_x = cmp::max(0, offset_x); let offset_y = cmp::max(0, offset_y); let height2 = { let height2 = offset_y + crop_height; cmp::min(height2, src.height) }; let width2 = { let width2 = offset_x + crop_width; cmp::min(width2, src.width) }; let mut dest = Image::blank(width2 - offset_x, height2 - offset_y); for y in 0..dest.height { for x in 0..dest.width { let pixel = src.get_pixel(offset_x + x, offset_y + y)?; dest.set_pixel(x, y, &Color::rgba(pixel.r, pixel.g, pixel.b, pixel.a))?; } } src.width = dest.width; src.height = dest.height; src.bytes = dest.bytes; Ok(()) } /// Fill an image with color. /// /// # Examples /// ``` /// use raster::Image; /// use raster::editor; /// use raster::Color; /// /// // Create a 100x100 image /// let mut image = Image::blank(100, 100); /// /// // Fill it with red /// editor::fill(&mut image, Color::red()).unwrap(); /// /// // Save it /// raster::save(&image, "tests/out/test_fill.png").unwrap(); /// ``` /// /// pub fn fill(src: &mut Image, color: Color) -> RasterResult<()> { for y in 0..src.height { for x in 0..src.width { src.set_pixel(x, y, &color)?; } } Ok(()) } /// An enum for the various modes that can be used for resizing. #[derive(Debug)] pub enum ResizeMode { /// Resize image to exact dimensions ignoring aspect ratio. Exact, /// Resize image to exact width. Height parameter is ignored and is auto calculated instead. ExactWidth, /// Resize image to exact height. Width parameter is ignored and is auto calculated instead. ExactHeight, /// Resize an image to fit within the given width and height. Fit, /// Resize image to fill all the space in the given dimension. Excess parts are cropped. Fill, } /// Resize an image to a given width, height and mode. /// /// # Examples /// ### Resize Fit /// ``` /// use raster::{editor, Color, Image, ResizeMode, BlendMode, PositionMode}; /// /// // Create an image from file /// let mut image1 = raster::open("tests/in/sample.jpg").unwrap(); /// let mut image2 = raster::open("tests/in/portrait.jpg").unwrap(); /// /// // Resize it /// editor::resize(&mut image1, 200, 200, ResizeMode::Fit).unwrap(); /// editor::resize(&mut image2, 200, 200, ResizeMode::Fit).unwrap(); /// /// // Superimpose images on a gray background /// let mut bg = Image::blank(200, 200); /// editor::fill(&mut bg, Color::hex("#CCCCCC").unwrap()).unwrap(); /// /// let image1 = editor::blend(&bg, &image1, BlendMode::Normal, 1.0, PositionMode::TopLeft, 0, 0).unwrap(); /// let image2 = editor::blend(&bg, &image2, BlendMode::Normal, 1.0, PositionMode::TopLeft, 0, 0).unwrap(); /// /// raster::save(&image1, "tests/out/test_resize_fit_1.jpg").unwrap(); /// raster::save(&image2, "tests/out/test_resize_fit_2.jpg").unwrap(); /// ``` /// /// The gray box shows the 200x200 imaginary box that the images "fit" in. /// /// ///   /// /// ### Resize Fill /// ``` /// use raster::{editor, Color, Image, ResizeMode}; /// /// // Create an image from file /// let mut image1 = raster::open("tests/in/sample.jpg").unwrap(); /// let mut image2 = raster::open("tests/in/portrait.jpg").unwrap(); /// /// // Resize it /// editor::resize(&mut image1, 200, 200, ResizeMode::Fill).unwrap(); /// editor::resize(&mut image2, 200, 200, ResizeMode::Fill).unwrap(); /// /// raster::save(&image1, "tests/out/test_resize_fill_1.jpg").unwrap(); /// raster::save(&image2, "tests/out/test_resize_fill_2.jpg").unwrap(); /// ``` /// /// The image fills up the entire 200x200 box. /// ///   /// /// ### Resize to Exact Width /// ``` /// use raster::{editor, Color, Image, ResizeMode}; /// /// // Create an image from file /// let mut image1 = raster::open("tests/in/sample.jpg").unwrap(); /// let mut image2 = raster::open("tests/in/portrait.jpg").unwrap(); /// /// // Resize it /// editor::resize(&mut image1, 200, 200, ResizeMode::ExactWidth).unwrap(); /// editor::resize(&mut image2, 200, 200, ResizeMode::ExactWidth).unwrap(); /// /// raster::save(&image1, "tests/out/test_resize_exact_width_1.jpg").unwrap(); /// raster::save(&image2, "tests/out/test_resize_exact_width_2.jpg").unwrap(); /// ``` /// /// The images will have a width of 200. The height is auto-calculated. /// ///  ///  /// /// ### Resize to Exact Height /// ``` /// use raster::{editor, Color, Image, ResizeMode}; /// /// // Create an image from file /// let mut image1 = raster::open("tests/in/sample.jpg").unwrap(); /// let mut image2 = raster::open("tests/in/portrait.jpg").unwrap(); /// /// // Resize it /// editor::resize(&mut image1, 200, 200, ResizeMode::ExactHeight).unwrap(); /// editor::resize(&mut image2, 200, 200, ResizeMode::ExactHeight).unwrap(); /// /// raster::save(&image1, "tests/out/test_resize_exact_height_1.jpg").unwrap(); /// raster::save(&image2, "tests/out/test_resize_exact_height_2.jpg").unwrap(); /// ``` /// /// The images will have a height of 200. The width is auto-calculated. /// ///   /// /// ### Resize to Exact Dimension /// ``` /// use raster::{editor, Color, Image, ResizeMode}; /// /// // Create an image from file /// let mut image1 = raster::open("tests/in/sample.jpg").unwrap(); /// let mut image2 = raster::open("tests/in/portrait.jpg").unwrap(); /// /// // Resize it /// editor::resize(&mut image1, 200, 200, ResizeMode::Exact).unwrap(); /// editor::resize(&mut image2, 200, 200, ResizeMode::Exact).unwrap(); /// /// raster::save(&image1, "tests/out/test_resize_exact_1.jpg").unwrap(); /// raster::save(&image2, "tests/out/test_resize_exact_2.jpg").unwrap(); /// ``` /// /// The images will be resized to the exact dimension ignoring aspect ratio. /// ///   /// pub fn resize(src: &mut Image, w: i32, h: i32, mode: ResizeMode) -> RasterResult<()> { match mode { ResizeMode::Exact => transform::resize_exact(src, w, h), ResizeMode::ExactWidth => transform::resize_exact_width(src, w), ResizeMode::ExactHeight => transform::resize_exact_height(src, h), ResizeMode::Fit => transform::resize_fit(src, w, h), ResizeMode::Fill => transform::resize_fill(src, w, h), } }