Struct Renderer

Source

pub struct Renderer<'a, P: Pixel> { /* private fields */ }

Expand description

A QR code renderer. This is a builder type which converts a bool-vector into an image.

Implementations§

Source §

impl<'a, P: Pixel> Renderer<'a, P>

Source

pub fn new( content: &'a [Color], modules_count: usize, quiet_zone: u32, ) -> Renderer<'a, P>

Creates a new renderer.

§Panics

panics if content is not modules_count squared big

Source

pub fn from_source<C>(source: &'a C, quiet_zone: u32) -> Renderer<'a, P>
where C: ModuleSource + ?Sized,

Creates a new renderer from a module-grid source.

This is the read-only-source counterpart to Renderer::new. It is useful when rendering a borrowed view that implements qrcode_core::ModuleSource but does not expose facade-specific QR code methods.

§Panics

Panics if source is not square or if its row-major module slice length does not match width() * height().

Source

pub fn from_symbol<S>(symbol: &'a S) -> Renderer<'a, P>
where S: QrSymbol + ?Sized,

Creates a new renderer from a QR symbol.

This is the metadata-aware counterpart to Renderer::from_source. The quiet zone is inferred from qrcode_core::QrSymbol::quiet_zone.

§Panics

Panics if symbol exposes an invalid module grid.

Source

pub fn try_from_source<C>( source: &'a C, quiet_zone: u32, ) -> Result<Renderer<'a, P>, RenderError>
where C: ModuleSource + ?Sized,

Tries to create a new renderer from a module-grid source.

Unlike Renderer::from_source, this constructor reports malformed sources as RenderError instead of panicking.

§Errors

Returns RenderError::InvalidModuleSource when source is empty, non-square, or its row-major module slice length does not match width() * height(). Returns RenderError::ModuleSourceTooWide when the width cannot be represented by this renderer.

Source

pub fn try_from_symbol<S>(symbol: &'a S) -> Result<Renderer<'a, P>, RenderError>
where S: QrSymbol + ?Sized,

Tries to create a new renderer from a QR symbol.

This is the fallible, metadata-aware counterpart to Renderer::try_from_source. The quiet zone is inferred from qrcode_core::QrSymbol::quiet_zone.

§Errors

Returns the same errors as Renderer::try_from_source when the symbol exposes an invalid module grid.

Source

pub fn dark_color(&mut self, color: P) -> &mut Self

Sets color of a dark module. Default is opaque black.

Source

pub fn light_color(&mut self, color: P) -> &mut Self

Sets color of a light module. Default is opaque white.

Source

pub fn quiet_zone(&mut self, has_quiet_zone: bool) -> &mut Self

Whether to include the quiet zone in the generated image.

Source

pub fn module_dimensions(&mut self, width: u32, height: u32) -> &mut Self

Sets the size of each module in pixels. Default is 8×8.

Source

pub fn min_dimensions(&mut self, width: u32, height: u32) -> &mut Self

Sets the minimum total image size in pixels, including the quiet zone if applicable. The renderer will try to find the dimension as small as possible, such that each module in the QR code has uniform size (no distortion).

For instance, a version 1 QR code has 19 modules across including the quiet zone. If we request an image of size ≥200×200, we get that each module’s size should be 11×11, so the actual image size will be 209×209.

Source

pub fn max_dimensions(&mut self, width: u32, height: u32) -> &mut Self

Sets the maximum total image size in pixels, including the quiet zone if applicable. The renderer will try to find the dimension as large as possible, such that each module in the QR code has uniform size (no distortion).

For instance, a version 1 QR code has 19 modules across including the quiet zone. If we request an image of size ≤200×200, we get that each module’s size should be 10×10, so the actual image size will be 190×190.

The module size is at least 1×1, so if the restriction is too small, the final image can be larger than the input.

Source