Struct Canvas 

pub struct Canvas { /* private fields */ }

Canvas is an intermediate helper structure to render error-corrected data into a QR code.

Implementations

impl Canvas

pub fn new(version: Version, ec_level: EcLevel) -> Self

Constructs a new canvas big enough for a QR code of the given version.

pub fn get(&self, x: i16, y: i16) -> Module

Obtains a module at the given coordinates. For convenience, negative coordinates will wrap around.

pub fn get_mut(&mut self, x: i16, y: i16) -> &mut Module

Obtains a mutable module at the given coordinates. For convenience, negative coordinates will wrap around.

pub fn put(&mut self, x: i16, y: i16, color: Color)

Sets the color of a functional module at the given coordinates. For convenience, negative coordinates will wrap around.

impl Canvas

pub fn draw_all_functional_patterns(&mut self)

Draw all functional patterns, before data placement.

All functional patterns (e.g. the finder pattern) except the format info pattern will be filled in. The format info pattern will be filled with light modules instead. Data bits can then put in the empty modules. with .draw_data().

impl Canvas

pub fn draw_data(&mut self, data: &[u8], ec: &[u8])

Draws the encoded data and error correction codes to the empty modules.

impl Canvas

pub fn apply_mask(&mut self, pattern: MaskPattern)

Applies a mask to the canvas. This method will also draw the format info patterns.

impl Canvas

pub fn apply_best_mask(&self) -> Self

Construct a new canvas and apply the best masking that gives the lowest penalty score.

pub fn apply_best_mask_with_pattern(&self) -> (Self, MaskPattern)

Construct a new canvas with the best mask and return the selected mask pattern alongside it.

pub fn apply_best_mask_with_score(&self) -> (Self, MaskPattern, u16)

Construct a new canvas with the best mask and return the selected mask pattern and its penalty score.

Masks are compared using full u32 scores. Unusually high scores exceeding u16::MAX are clipped to u16::MAX in the returned score.

pub fn into_colors(self) -> Vec<Color>

Convert the modules into a vector of colors.

Trait Implementations

impl Clone for Canvas

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.