Struct Encoder

pub struct Encoder { /* private fields */ }

Encoder type used to produce blurhashes

Implementations

impl Encoder

pub fn auto(bounds: ImageBounds) -> Self

Create an encoder that automatically picks Compoent and Skip values

This is a best-effort configuration

pub fn new( _: Components, bounds: ImageBounds, skip: u32, ) -> Result<Self, ConfigurationError>

Create a new Encoder to produce a blurhash

The provided component x and y values must be between 1 and 9 inclusive.

The skip value indicates how many pixels can be skipped when proccessing the image. this value will be squared to produce the final skip value. When set to 1, no pixels will be skipped, when set to 2, one in four pixels will be processed. when set to 3, one in 9 pixels will be processed, etc. This improves performance at the cost of losing accuracy.

Errors if too many components are requested

pub fn update(&mut self, rgba8_image: &[u8])

Update the encoder with bytes from an image

The input image must be in the sRGB colorspace and be formatted as 8bit RGBA The input doesn’t need to contain whole pixels, the encoder is capable of handling partial pixels

pub fn finalize(self) -> String

Produce a blurhash from the provided encoder