robin/contrast-rs
1
0
Fork 0
mirror of https://codeberg.org/icewind/contrast.git synced 2026-06-03 09:54:19 +02:00
Code Issues Projects Releases Packages Wiki Activity

readme

Browse source
This commit is contained in:
Robin Appelman 2019-09-07 16:17:46 +02:00
commit f5d94cd16d
2 changed files with 27 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md Normal file
View file

@ -0,0 +1,15 @@
# Contrast
Calculate contrast between two colors as specified by [WCAG 2](http://www.w3.org/TR/WCAG20#contrast-ratiodef)
# Usage
```rust
use contrast::contrast;
use rgb::RGB8;
///
fn main() {
let contrast: f32 = contrast(RGB8::from([255, 255, 255]), RGB8::from([255, 255, 0]));
assert_eq!(contrast, 1.0738392);
}
```

12
src/lib.rs
View file

@ -28,6 +28,18 @@ fn scale_channel<T: Bounded + NumCast, F: Float + NumCast + Div>(channel: T) ->
} }
/// Calculate contrast between two colors as specified by [WCAG 2](http://www.w3.org/TR/WCAG20#contrast-ratiodef) /// Calculate contrast between two colors as specified by [WCAG 2](http://www.w3.org/TR/WCAG20#contrast-ratiodef)
///
/// # Usage
///
/// ```rust
/// use contrast::contrast;
/// use rgb::RGB8;
///
/// fn main() {
/// let contrast: f32 = contrast(RGB8::from([255, 255, 255]), RGB8::from([255, 255, 0]));
/// assert_eq!(contrast, 1.0738392);
/// }
/// ```
pub fn contrast<T: Bounded + NumCast, F: Float + NumCast + Div>(a: RGB<T>, b: RGB<T>) -> F { pub fn contrast<T: Bounded + NumCast, F: Float + NumCast + Div>(a: RGB<T>, b: RGB<T>) -> F {
let luminance_a: F = luminance::<T, F>(a) + cast::<_, F>(0.05).unwrap(); let luminance_a: F = luminance::<T, F>(a) + cast::<_, F>(0.05).unwrap();
let luminance_b: F = luminance::<T, F>(b) + cast::<_, F>(0.05).unwrap(); let luminance_b: F = luminance::<T, F>(b) + cast::<_, F>(0.05).unwrap();