.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "ZBar::Image 3pm"
.TH ZBar::Image 3pm "2009-10-23" "perl v5.20.1" "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"
Barcode::ZBar::Image \- image object to scan for bar codes
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Barcode::ZBar;
\&    
\&    my $image = Barcode::ZBar::Image\->new();
\&    $image\->set_format(\*(Aq422P\*(Aq);
\&    $image\->set_size(114, 80);
\&    $image\->set_data($raw_bits);
\&    
\&    my @symbols = $image\->get_symbols();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Barcode::ZBar::Image is used to pass images to the bar code scanner.
It wraps raw image data with the meta-data required to interpret it
(size, pixel format, etc)
.SS "Image Formats"
.IX Subsection "Image Formats"
Image data formats are represented by (relatively) standard \*(L"Four
Character Codes\*(R" (fourcc), represented by four character strings in
Perl.  A list of supported formats is available on the project wiki.
.PP
Examples:
.IP "\(bu" 2
\&'\s-1GREY\s0' \- single 8bpp intensity plane
.IP "\(bu" 2
\&'\s-1BGR3\s0' \- 24bpp packed \s-1RGB\s0 component format
.IP "\(bu" 2
\&'\s-1YUYV\s0' \- 12bpp packed luminance/chrominance (YCbCr) format
.SH "REFERENCE"
.IX Header "REFERENCE"
.SS "Methods"
.IX Subsection "Methods"
.IP "\fInew()\fR" 4
.IX Item "new()"
Create a new Barcode::ZBar::Image object.  The size, pixel format and
data must be defined before the object may be used.
.IP "\fIget_format()\fR" 4
.IX Item "get_format()"
.PD 0
.IP "set_format(\fIformat\fR)" 4
.IX Item "set_format(format)"
.PD
Return/specify the fourcc code corresponding to the image pixel format.
.IP "\fIget_sequence()\fR" 4
.IX Item "get_sequence()"
.PD 0
.IP "set_sequence(\fIseq_num\fR)" 4
.IX Item "set_sequence(seq_num)"
.PD
Return/specify the video frame or page number associated with the image.
.IP "\fIget_size()\fR" 4
.IX Item "get_size()"
.PD 0
.IP "set_size(\fIwidth\fR, \fIheight\fR)" 4
.IX Item "set_size(width, height)"
.PD
Return/specify the (\fIwidth\fR, \fIheight\fR) image size tuple.
.IP "\fIget_data()\fR" 4
.IX Item "get_data()"
.PD 0
.IP "set_data(\fIraw\fR)" 4
.IX Item "set_data(raw)"
.PD
Return/specify the raw image data as a binary string.
.IP "\fIget_symbols()\fR" 4
.IX Item "get_symbols()"
Return a list of scanned Barcode::ZBar::Symbol results attached to
this image.
.IP "convert(\fIformat\fR)" 4
.IX Item "convert(format)"
Return a new Barcode::ZBar::Image object converted to the indicated
fourcc format.  Returns \f(CW\*(C`undef\*(C'\fR if the conversion is not supported.
Conversion complexity ranges from \s-1CPU\s0 intensive to trivial depending
on the formats involved.  Note that only a few conversions retain
color information.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Barcode::ZBar, Barcode::ZBar::Image, Barcode::ZBar::Symbol
.PP
\&\fIzbarimg\fR\|(1), \fIzbarcam\fR\|(1)
.PP
http://zbar.sf.net
.SH "AUTHOR"
.IX Header "AUTHOR"
Jeff Brown, <spadix@users.sourceforge.net>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2008\-2009 (c) Jeff Brown <spadix@users.sourceforge.net>
.PP
The ZBar Bar Code Reader is free software; you can redistribute it
and/or modify it under the terms of the \s-1GNU\s0 Lesser Public License as
published by the Free Software Foundation; either version 2.1 of
the License, or (at your option) any later version.