.\" -*- 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 "PDF::Builder::Resource::XObject::Image::TIFF_GT 3"
.TH PDF::Builder::Resource::XObject::Image::TIFF_GT 3 2023-12-21 "perl v5.38.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"
.SS new
.IX Subsection "new"
.Vb 1
\&    $res = PDF::Builder::Resource::XObject::Image::TIFF_GT\->new($pdf, $file, %opts)
.Ve
.Sp
.RS 4
Returns a TIFF-image object. \f(CW$pdf\fR is the PDF object being added to, \f(CW$file\fR
is the input TIFF 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 TIFF_GT
library will be used. Otherwise, the TIFF library will be used instead.
.Sp
Options:
.IP "'notrans' => 1" 4
.IX Item "'notrans' => 1"
Ignore any alpha layer (transparency) and make the image fully opaque.
.IP "'name' => 'string'" 4
.IX Item "'name' => 'string'"
This is the name you can give for the TIFF image object. The default is Ixnnnn.
.RE
.RS 4
.Sp
TIFF 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 (RGB),
and 3 (Palette color). It currently does \fInot\fR support 4 (transparency mask),
5 (separated CMYK), 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 TIFF 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 RT 133955), this is coming directly from libtiff (as write to STDERR), 
so he can't do anything about it!
.RE
.SS usesLib
.IX Subsection "usesLib"
.Vb 1
\&    $mode = $tif\->usesLib()
.Ve
.Sp
.RS 4
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 TIFF_GT. See the PDF::Builder \fBLA_GT()\fR call if you
need to know in advance.
.RE