.\" -*- 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 "Image::Info::XPM 3pm"
.TH Image::Info::XPM 3pm 2024-02-01 "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
Image::Info::XPM \- XPM support for Image::Info
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& use Image::Info qw(image_info dim);
\&
\& my $info = image_info("image.xpm");
\& if (my $error = $info\->{error}) {
\&     die "Can\*(Aqt parse image info: $error\en";
\& }
\& my $color = $info\->{color_type};
\&
\& my($w, $h) = dim($info);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This modules supplies the standard key names
except for Compression, Gamma, Interlace, LastModificationTime, as well as:
.IP ColorPalette 4
.IX Item "ColorPalette"
Reference to an array of all colors used.
This key is only present if \f(CW\*(C`image_info\*(C'\fR is invoked
as \f(CW\*(C`image_info($file, ColorPalette>=1)\*(C'\fR.
.IP ColorTableSize 4
.IX Item "ColorTableSize"
The number of colors the image uses.
.IP HotSpotX 4
.IX Item "HotSpotX"
The x\-coord of the image's hotspot.
Set to \-1 if there is no hotspot.
.IP HotSpotY 4
.IX Item "HotSpotY"
The y\-coord of the image's hotspot.
Set to \-1 if there is no hotspot.
.IP L1D_Histogram 4
.IX Item "L1D_Histogram"
Reference to an array representing a one dimensional luminance
histogram. This key is only present if \f(CW\*(C`image_info\*(C'\fR is invoked
as \f(CW\*(C`image_info($file, L1D_Histogram=>1)\*(C'\fR. The range is from 0 to 255,
however auto-vivification is used so a null field is also 0,
and the array may not actually contain 255 fields.
.IP XPM_CharactersPerPixel 4
.IX Item "XPM_CharactersPerPixel"
This is typically 1 or 2. See Image::Xpm.
.IP XPM_Extension\-.* 4
.IX Item "XPM_Extension-.*"
XPM Extensions (the most common is XPMEXT) if present.
.SH METHODS
.IX Header "METHODS"
.SS \fBprocess_file()\fP
.IX Subsection "process_file()"
.Vb 1
\&        $info\->process_file($source, $options);
.Ve
.PP
Processes one file and sets the found info fields in the \f(CW$info\fR object.
.SH FILES
.IX Header "FILES"
This module requires Image::Xpm
.PP
\&\fR\f(CI$Image::Info::XPM::RGBLIB\fR\fI\fR is set to \fI/usr/X11R6/lib/X11/rgb.txt\fR
or an equivalent path (see the \f(CW\*(C`_get_rgb_txt\*(C'\fR function for the
complete list) by default, this is used to resolve textual color names
to their RGB counterparts.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Image::Info, Image::Xpm
.SH NOTES
.IX Header "NOTES"
For more information about XPM see
<ftp://ftp.x.org/contrib/libraries/xpm\-README.html>
.SH CAVEATS
.IX Header "CAVEATS"
While the module attempts to be as robust as possible, it may not recognize
older XPMs (Versions 1\-3), if this is the case try inserting /*\ XPM\ */
as the first line.
.SH AUTHOR
.IX Header "AUTHOR"
Jerrad Pierce <belg4mit@mit.edu>/<webmaster@pthbb.org>
.PP
Tels \- (c) 2006.
.PP
Now maintained by Slaven Rezic <srezic@cpan.org>.
.PP
This library is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.