#rgb #pixel #rgba #bgra #interoperability

rgb

struct RGB (etc.) for sharing pixels between crates. Allows no-copy high-level interoperability. Also adds common convenience methods and implements standard Rust traits to make RGB/RGBA pixels first-class Rust objects.

28 releases

0.8.11 Jul 19, 2018
0.8.9 May 11, 2018
0.8.7 Dec 31, 2017
0.8.5 Nov 27, 2017
0.4.0 Jul 5, 2016

#10 in Images

Download history 237/week @ 2018-08-31 284/week @ 2018-09-07 369/week @ 2018-09-14 181/week @ 2018-09-21 333/week @ 2018-09-28 507/week @ 2018-10-05 275/week @ 2018-10-12 467/week @ 2018-10-19 233/week @ 2018-10-26 499/week @ 2018-11-02 378/week @ 2018-11-09 331/week @ 2018-11-16 366/week @ 2018-11-23

945 downloads per month
Used in 31 crates (16 directly)

MIT license

41KB
1K SLoC

struct RGB for Rust v

Operating on pixels as weakly-typed vectors of u8 is error-prone and inconvenient. It's better to use vectors of pixel structs. However, Rust is so strongly typed that your RGB pixel struct is not compatible with my RGB pixel struct. So let's all use mine :P

xkcd standards

Installation

Add this to your Cargo.toml:

[dependencies]
rgb = "0.8"

Usage

RGB and RGBA structs

The structs implement common Rust traits and a few convenience functions, e.g. map that repeats an operation on every subpixel:

extern crate rgb;
use rgb::*; // Laziest way to use traits which add extra methods to the structs

let px = RGB {
    r:255_u8,
    g:0,
    b:255,
};
let inverted = px.map(|ch| 255 - ch);

println!("{}", inverted); // Display: rgb(0,255,0)
assert_eq!(RGB8::new(0, 255, 0), inverted);

Byte slices to pixel slices

For interoperability with functions operating on generic arrays of bytes there are functinos for safe casting to and from pixel slices.

let raw = vec![0u8; width*height*3];
let pixels: &[RGB8] = raw.as_rgb(); /// Safe casts without copying
let raw_again = pixels.as_bytes();

About colorspaces

This crate is intentionally ignorant about flavors of RGB color spaces. Correct color management is a complex problem, and this crate aims to be the lowest common denominator.

However, it supports any subpixel type for RGB<T>, and RGBA<RGBType, AlphaType>, so you can use them with a newtype, e.g.:

struct LinearLight(u16);
type LinearRGB = RGB<LinearLight>;

Dependencies

  • optional serde 1.0+derive