Struct Renderer 

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

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

Implementations

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

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

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

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

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

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

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

Whether to include the quiet zone in the generated image.

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

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

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.

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.

pub fn for_web(&mut self) -> &mut Self

Sets dimensions suitable for web display (200×200 pixels minimum).

This is a convenience preset for embedding QR codes in web pages. The actual size may be slightly larger to maintain uniform module sizing.

pub fn for_print(&mut self, dpi: u32) -> &mut Self

Sets dimensions suitable for printing at the specified DPI.

Targets a 1-inch × 1-inch physical size. For example, at 300 DPI the image will be at least 300×300 pixels.

Arguments

• dpi - Dots per inch (common values: 150 for draft, 300 for standard, 600 for high quality)

pub fn for_social(&mut self, platform: &str) -> &mut Self

Sets dimensions suitable for social media platform sharing.

Targets platform-recommended sizes:

Platform	Size (px)
"twitter"	400×400
"facebook"	600×600
"instagram"	1080×1080
"wechat"	600×600
Any other	400×400

pub fn build(&self) -> P::Image

Renders the QR code into an image.