.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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::TIFF_GT 3pm"
.TH PDF::Builder::Resource::XObject::Image::TIFF_GT 3pm "2021-03-28" "perl v5.32.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"
PDF::Builder::Resource::XObject::Image::TIFF_GT \- TIFF image support
(Graphics::TIFF enabled)
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "$res = PDF::Builder::Resource::XObject::Image::TIFF_GT\->new($pdf, $file, $name, %opts)" 4
.el .IP "\f(CW$res\fR = PDF::Builder::Resource::XObject::Image::TIFF_GT\->new($pdf, \f(CW$file\fR, \f(CW$name\fR, \f(CW%opts\fR)" 4
.IX Item "$res = PDF::Builder::Resource::XObject::Image::TIFF_GT->new($pdf, $file, $name, %opts)"
.PD 0
.ie n .IP "$res = PDF::Builder::Resource::XObject::Image::TIFF_GT\->new($pdf, $file, $name)" 4
.el .IP "\f(CW$res\fR = PDF::Builder::Resource::XObject::Image::TIFF_GT\->new($pdf, \f(CW$file\fR, \f(CW$name\fR)" 4
.IX Item "$res = PDF::Builder::Resource::XObject::Image::TIFF_GT->new($pdf, $file, $name)"
.ie n .IP "$res = PDF::Builder::Resource::XObject::Image::TIFF_GT\->new($pdf, $file)" 4
.el .IP "\f(CW$res\fR = PDF::Builder::Resource::XObject::Image::TIFF_GT\->new($pdf, \f(CW$file\fR)" 4
.IX Item "$res = PDF::Builder::Resource::XObject::Image::TIFF_GT->new($pdf, $file)"
.PD
Returns a TIFF-image object. \f(CW$pdf\fR is the \s-1PDF\s0 object being added to, \f(CW$file\fR
is the input \s-1TIFF\s0 file, and the optional \f(CW$name\fR of the new parent image object
defaults to IxAAA.
.Sp
If the Graphics::TIFF package is installed, and its use is not suppressed via
the \f(CW\*(C`\-nouseGT\*(C'\fR flag (see Builder documentation for \f(CW\*(C`image_tiff\*(C'\fR), the \s-1TIFF_GT\s0
library will be used. Otherwise, the \s-1TIFF\s0 library will be used instead.
.Sp
Options:
.RS 4
.IP "\-notrans => 1" 4
.IX Item "-notrans => 1"
Ignore any alpha layer (transparency) and make the image fully opaque.
.RE
.RS 4
.Sp
\&\s-1TIFF\s0 support (when using Graphics::TIFF) is for \f(CW\*(C`PhotometricInterpretation\*(C'\fR
values of 0 (bilevel/gray, white is 0), 1 (bilevel/gray, black is 0), 2 (\s-1RGB\s0),
and 3 (Palette color). It currently does \fInot\fR support 4 (transparency mask),
5 (separated \s-1CMYK\s0), 6 (YCbCr), 8 (CIELab), or higher. There is limited support 
for an Alpha (transparency) channel (due to extremely limited test cases). 
Some tags are not supported, and a PlanarConfiguration of 2 is unknown until 
we get some test cases.
.Sp
Some applications seem to take odd liberties with \s-1TIFF\s0 tags, such as adding a
SamplePerPixel without specifying ExtraSamples type. In such cases, we treat
one extra sample (not otherwise defined) as an Alpha channel, and hope for 
the best!
.Sp
If there are invalid tags or field values within a tag, the Graphics::TIFF
library will attempt to pop-up a warning dialog, rather than just ignoring 
invalid things. If we can find a switch to disable this behavior, we will
look into adding it as an option. According to Graphic::TIFF's owner 
(ticket \s-1RT 133955\s0), this is coming directly from libtiff (as write to \s-1STDERR\s0), 
so he can't do anything about it!
.RE
.ie n .IP "$mode = $tif\->\fBusesLib()\fR" 4
.el .IP "\f(CW$mode\fR = \f(CW$tif\fR\->\fBusesLib()\fR" 4
.IX Item "$mode = $tif->usesLib()"
Returns 1 if Graphics::TIFF installed and used, 0 if not installed, or \-1 if
installed but not used (\-nouseGT option given to \f(CW\*(C`image_tiff\*(C'\fR).
.Sp
\&\fBCaution:\fR this method can only be used \fIafter\fR the image object has been
created. It can't tell you whether Graphics::TIFF is available in
advance of actually using it, in case you want to use some functionality
available only in \s-1TIFF_GT.\s0 See the PDF::Builder \s-1\fBLA_GT\s0()\fR call if you
need to know in advance.