image_overlay/
lib.rs

1//! # image-overlay  
2//! This crate supports overlaying images with 27 blend modes.  
3//! 
4//! # Usage
5//! This is to be used with image crate as following:
6//!
7//! ``````````rust
8//! use image::{DynamicImage, ImageBuffer, Rgba, Luma};
9//! use image_overlay::{overlay, overlay_dyn_img, BlendMode};
10//! 
11//! 
12//! let mut dest = ImageBuffer::<Rgba<f32>, Vec<f32>>::new(100, 100);
13//! let src = ImageBuffer::<Luma<u8>, Vec<u8>>::new(100, 100);
14//! 
15//! overlay(&mut dest, &src, 0, 0, BlendMode::default());
16//! 
17//! 
18//! let mut dest = DynamicImage::new_rgba8(100, 100);
19//! let src = DynamicImage::new_luma8(100, 100);
20//! 
21//! // Do NOT use "overlay" for DynamicImage. 
22//! // Use "overlay_dyn_img" insted.  
23//! overlay_dyn_img(&mut dest, &src, 0, 0, BlendMode::default());
24//! ``````````
25//! 
26//! # Features
27//! Use f32 as an intermediate representation by default.  
28//! However, can perform higher-precision calculations using f64 by enabling the "f64" feature.  
29
30mod blend_mode;
31mod overlay;
32mod as_rgba;
33
34#[cfg(feature = "blend_dissolve")]
35pub mod rng;
36pub mod blend;
37
38pub use as_rgba::AsRgba;
39pub use blend_mode::BlendMode;
40pub use overlay::*;