.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Imager::QRCode 3pm"
.TH Imager::QRCode 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Imager::QRCode \- Generate QR Code with Imager using libqrencode
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Imager::QRCode;
\&
\&    my $qrcode = Imager::QRCode\->new(
\&        size          => 2,
\&        margin        => 2,
\&        version       => 1,
\&        level         => \*(AqM\*(Aq,
\&        casesensitive => 1,
\&        lightcolor    => Imager::Color\->new(255, 255, 255),
\&        darkcolor     => Imager::Color\->new(0, 0, 0),
\&    );
\&    my $img = $qrcode\->plot("blah blah");
\&    $img\->write(file => "qrcode.gif");
\&
\&    # or instance method
\&    use Imager::QRCode qw(plot_qrcode);
\&
\&    my $img = plot_qrcode("blah blah", \e%params);
\&    $img\->write(file => "qrcode.gif");
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module allows you to generate QR Code with Imager. This module use libqrencode '2.0.0' and above.
.SH METHODS
.IX Header "METHODS"
.IP new 4
.IX Item "new"
.Vb 1
\&    $qrcode = Imager::QRCode\->new(%params);
.Ve
.Sp
The \f(CWnew()\fR constructor method instantiates a new Imager::QRCode object. \f(CWnew()\fR accepts the following parameters.
.RS 4
.IP \(bu 4
\&\f(CW\*(C`size\*(C'\fR \- Horizontal and vertical size of module(dot). Default is 4.
.IP \(bu 4
\&\f(CW\*(C`margin\*(C'\fR \- Margin size of QR Code. Default is 3.
.IP \(bu 4
\&\f(CW\*(C`level\*(C'\fR \- Error collectin level. Valid values are 'M', 'L', 'Q' or 'H'. Default is 'L'.
.IP \(bu 4
\&\f(CW\*(C`version\*(C'\fR \- Version of the symbol. If specify '0', this module chooses the minimum version for the input data. Default is '0'.
.IP \(bu 4
\&\f(CW\*(C`mode\*(C'\fR \- Encoding mode. Valid values are 'numerical', 'alpha\-numerical', '8\-bit' or 'kanji'. Default is '8\-bit'.
.Sp
If not give \f(CW\*(C`casesensitive\*(C'\fR then should be given \f(CW\*(C`mode\*(C'\fR. If 'kanji' is given, characters will be encoded as Shift-JIS characters. If '8\-bit' is given, all of non-alpha-numerical characters will be encoded as is. If you want to embed UTF\-8 string, choose '8\-bit'.
.IP \(bu 4
\&\f(CW\*(C`casesensitive\*(C'\fR \- If your application is case-sensitive using 8\-bit characters, set to '1'. Default is '0'.
.RE
.RS 4
.RE
.IP plot($text) 4
.IX Item "plot($text)"
.Vb 1
\&    $img = $qrcode\->plot("blah blah");
.Ve
.Sp
Create a new QR Code image. This method returns Imager object ploted QR Code with the given text.
.SH "INSTANT METHODS"
.IX Header "INSTANT METHODS"
.IP "plot_qrcode($text, \e%params)" 4
.IX Item "plot_qrcode($text, %params)"
Instant method. \f(CW$text\fR is input text. \f(CW%params\fR is same parameter as \f(CWnew()\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\f(CW\*(C`Imager\*(C'\fR, \f(CW\*(C`http://www.qrcode.com/\*(C'\fR, \f(CW\*(C`http://megaui.net/fukuchi/works/qrencode/index.en.html\*(C'\fR
.SH AUTHOR
.IX Header "AUTHOR"
Yoshiki KURIHARA  \f(CW\*(C`<kurihara _\|_at_\|_ cpan.org>\*(C'\fR
.SH THANKS
.IX Header "THANKS"
Tokuhiro Matsuno
.SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT"
Copyright (c) 2011, Yoshiki KURIHARA \f(CW\*(C`<kurihara _\|_at_\|_ cpan.org>\*(C'\fR.
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See perlartistic.