.\" Automatically generated by Pod::Man 4.14 (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
..
.\" 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 >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 "PDF::Builder::Resource::XObject::Image::PNM 3pm"
.TH PDF::Builder::Resource::XObject::Image::PNM 3pm "2023-12-15" "perl v5.36.0" "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"
PDF::Builder::Resource::XObject::Image::PNM \- support routines for PNM (Portable aNy Map) image library. Inherits from PDF::Builder::Resource::XObject::Image
.SS "\s-1METHODS\s0"
.IX Subsection "METHODS"
.SS "new"
.IX Subsection "new"
.Vb 1
\&    $res = PDF::Builder::Resource::XObject::Image::PNM\->new($pdf, $file, %opts)
.Ve
.Sp
.RS 4
Options:
.IP "'name' => 'string'" 4
.IX Item "'name' => 'string'"
This is the name you can give for the \s-1PNM\s0 image object. The default is Nxnnnn.
.IP "'compress' => 1" 4
.IX Item "'compress' => 1"
This is the compression you can give for the \s-1PNM\s0 image object. Any value will
cause the use of \fIFlate\fR compression, otherwise (\f(CW\*(C`compress\*(C'\fR not given),
\&\fIASCIIHexDecode\fR is used.
.RE
.RS 4
.RE
.PP
Returns an image in the \s-1PDF. PNM\s0 types 1 (ASCII/plain bi\-level/PBM), 
2 (ASCII/plain grayscale/PGM), 3 (ASCII/plain \s-1RGB/PPM\s0), 
4 (binary/raw bi\-level/PBM), 5 (binary/raw grayscale/PGM), and 
6 (binary/raw \s-1RGB/PPM\s0) are supported.
.PP
For bi-level, only values 0/1 (white/black) are supported. For grayscale, the
maximum sample (full white) may be anything from 1 to 65535, with 0 being full
black. If the maximum sample value is 255 or smaller, one byte of raw binary
data per pixel, otherwise two bytes. For \s-1RGB,\s0 each sample (full-on of that
color) may be anything from 1 to 65535 (the same maximum for all three colors),
with 0 being full black. If the maximum sample value is 255 or smaller, three
bytes of raw binary data per pixel, otherwise six bytes.
.PP
Remember that you need to use Builder.pm's image_pnm method to use this
functionality.