Image::Info::XPM(3pm)

Image::Info::XPM3pm

Xpm support for image::info

Usage

 use Image::Info qw(image_info dim);
 my $info = image_info("image.xpm");
 if (my $error = $info->{error}) {
     die "Can't parse image info: $error\n";
 }
 my $color = $info->{color_type};
 my($w, $h) = dim($info);

Overview

This modules supplies the standard key names except for Compression, Gamma, Interlace, LastModificationTime, as well as:

ColorPalette

Reference to an array of all colors used. This key is only present if "image_info" is invoked as "image_info($file, ColorPalette>=1)".

ColorTableSize

The number of colors the image uses.

HotSpotX

The x-coord of the image's hotspot. Set to -1 if there is no hotspot.

HotSpotY

The y-coord of the image's hotspot. Set to -1 if there is no hotspot.

L1D_Histogram

Reference to an array representing a one dimensional luminance histogram. This key is only present if "image_info" is invoked as "image_info($file, L1D_Histogram=>1)". 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.

XPM_CharactersPerPixel

This is typically 1 or 2. See Image::Xpm.

XPM_Extension-.*

XPM Extensions (the most common is XPMEXT) if present.

Methods

process_file()

        $info->process_file($source, $options);

Processes one file and sets the found info fields in the $info object.

Files

This module requires Image::Xpm

$Image::Info::XPM::RGBLIB is set to /usr/X11R6/lib/X11/rgb.txt or an equivalent path (see the "_get_rgb_txt" function for the complete list) by default, this is used to resolve textual color names to their RGB counterparts.

Notes

For more information about XPM see <ftp://ftp.x.org/contrib/libraries/xpm-README.html>

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.

Releases

13 releases since Debian 3.0 (Woody); the text changed 9 times.

  1. 3.0
  2. 3.1
  3. 4.0
  4. 5.0–8
  5. 9
  6. 10
  7. 11
  8. 12
  9. 13
  10. Arch

Author

Jerrad Pierce <[email protected]>/<[email protected]>

Tels - (c) 2006.

Now maintained by Slaven Rezic <[email protected]>.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

From perl-image-info 1.45-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.