PDF::API2::Resource::XObject::Image (3)

Leading comments

Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/PDF::API2::Resource::XObject::Image.3pm".)

NAME

PDF::API2::Resource::XObject::Image - Base class for external raster image objects

METHODS

$image = PDF::API2::Resource::XObject::Image->new($pdf, $name)

Returns an image resource object.

$width = $image->width($width)

Get or set the width value for the image object.

$height = $image->height($height)

Get or set the height value for the image object.

$image->smask($xobject)

Set the soft-mask image object.

$image->mask(@color_range)

$image->mask($xobject)

Set the mask to an image mask XObject or an array containing a range of colors to be applied as a color key mask.

$image->colorspace($name)

$image->colorspace($array)

Set the color space used by the image. Depending on the color space, this will either be just the name of the color space, or it will be an array containing the color space and any required parameters.

If passing an array, parameters must already be encoded as

PDF

objects. The array itself may also be a

PDF

object. If not, one will be created.

$image->bits_per_component($integer)

Set the number of bits used to represent each color component.