• NAVIGATION LINKS
  • Up (Parents)
  • Siblings
  • Down (Children)
• NAME
• METHODS
  • new
  • width
  • height
  • smask
  • mask
  • colorspace
  • bits_per_component

NAME

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

Inherits from PDF::Builder::Resource::XObject

METHODS

new

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

Returns an image resource object.

width

    $width = $image->width()

Get the width (in points) of the image object.

Note that this function also has the ability to set the width, by giving the new width (in points), but it appears that it never worked correctly. The set capability has been deprecated, and is scheduled to be removed some time after October, 2025. If you are using the width() method in some manner to set the image width, please let us know, so we can plan to keep it enabled!

height

    $height = $image->height()

Get the height (in points) of the image object.

Note that this function also has the ability to set the height, by giving the new height (in points), but it appears that it never worked correctly. The set capability has been deprecated, and is scheduled to be removed some time after October, 2025. If you are using the height() method in some manner to set the image height, please let us know, so we can plan to keep it enabled!

smask

    $image->smask($xobject)

Set the soft-mask image object.

mask

    $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.

colorspace

    $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.

bits_per_component

    $image->bits_per_component($integer)

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

NAVIGATION LINKS

Up (Parents)

Master Index
PDF::Builder -- Facilitates the creation and modification of PDF files
PDF::Builder::Resource -- Base class for PDF resources
PDF::Builder::Resource::XObject -- Base class for external objects

Siblings

PDF::Builder::Resource::XObject::Form -- Base class for external form objects

Down (Children)

PDF::Builder::Resource::XObject::Image::GD -- Support routines for Graphics Development image library
PDF::Builder::Resource::XObject::Image::GIF -- Support routines for GIF image library
PDF::Builder::Resource::XObject::Image::JPEG -- Support routines for JPEG image library
PDF::Builder::Resource::XObject::Image::PNG -- Support routines for PNG image library (using pure Perl code)
PDF::Builder::Resource::XObject::Image::PNG_IPL -- Support routines for PNG image library (using Image::PNG::Libpng)
PDF::Builder::Resource::XObject::Image::PNM -- Support routines for PNM (Portable aNy Map) image library
PDF::Builder::Resource::XObject::Image::SVG -- Support routines for SVG (Scalable Vector Graphics) image library
PDF::Builder::Resource::XObject::Image::TIFF -- TIFF image support
PDF::Builder::Resource::XObject::Image::TIFF_GT -- TIFF image support (Graphics::TIFF enabled)

This page is https://www.catskilltech.com/Documentation/PDF/Builder/Resource/XObject/Image.html

Search Quotations database.

Last updated Sat, 19 Apr 2025 at 8:15 PM

 

Site Home    Discussions    Free Software    Documentation    Examples    Contact Us    The Catskills    Favorite Links    Site Map