/ 
Image-Imlib2-Thumbnail-Scaled-0.07
River stage zero No dependents
/ Image::Imlib2::Thumbnail::Scaled

NAME

Image::Imlib2::Thumbnail::Scaled - Create scaled thumbnails while keeping the aspect ratio

VERSION

Version 0.07

SYNOPSIS

use Image::Imlib2::Thumbnail::Scaled;
my $thumbnail = Image::Imlib2::Thumbnail::Scaled->new;

# generates a set of thumbnails for $source image in $directory
my $thumbnails = $thumbnail->generate( $source, $directory );

DESCRIPTION

This module creates a series of thumbnails using Image::Imlib2.

This module is essentially Image::Imlib2::Thumbnail, except it respects the aspect ratio of the original image when scaling, and there are some minor differences in terms of what functions take in and return.

It is possible using Image::Imlib2::Thumbnail to keep the aspect ratio of the image, however you have to decide whether to scale based on height or width, whereas Image::Imlib2::Thumbnail::Scaled figures this out for you based on the dimensions of the image.

This module by default generates sizes very similar to Image::Imlib2::Thumbnail:

Name       Width  Height
Square     75     75
Thumbnail  100    75
Small      240    180
Medium     500    375
Large      1024   768

SUBROUTINES/METHODS

new

my $thumbnail = Image::Imlib2::Thumbnail::Scaled->new;

Returns a new Image::Imlib2::Thumbnail::Scaled object. Can take in any of the subroutines as options (except "add_size"). For example:

my $thumbnail = Image::Imlib2::Thumbnail::Scaled->new(
  sizes => [
             {
               name => 'my_image',
               width => 180,
               height => 180,
             },
             {
               name => 'my_other_image',
               width => 240,
               height => 240,
             }
           ]
);

my $thumbnail = Image::Imlib2::Thumbnail::Scaled->new(include_original => 1);

#or multiple
my $thumbnail = Image::Imlib2::Thumbnail::Scaled->new(include_original => 1, delete_original => 1);

sizes

my $thumbnail = Image::Imlib2::Thumbnail::Scaled->new(
  sizes => [
             {
               name => 'my_image',
               width => 180,
               height => 180,
             },
             {
               name => 'my_other_image',
               width => 240,
               height => 240,
             }
           ]
);

sizes allows you to override the default sizes that are provided.

include_original

$thumbnail->include_original(1);

If set to 1, generate will return the original image along with the created thumbnails in the returned arrayref. Default is false.

delete_original

$thumbnail->delete_original(1);

If set to 1, the original image will be deleted once all resized images are made. Default is false.

move_original

$thumbnail->move_original(1);

If set to 1, the original image will be moved to the directory that is passed into "generate" along with all of the other resized images. Default is false.

add_size

Add an extra size:

$thumbnail->add_size(
    {
        name    => 'header',
        width   => 350,
        height  => 200,
        quality => 80,
    }
);

The quality is the JPEG quality compression ratio. This defaults to 75.

generate

Returns an arrayref a set of thumbnails for $source image in $directory. Will include the original image if include_original is set to 1.

my $thumbnails = $thumbnail->generate( $source, $directory );
for my $thumbnail (@$thumbnails) {
  my $name = $thumbnail->{name};
  my $width = $thumbnail->{width};
  my $requested_width = $thumbnail->{requested_width};
  my $height = $thumbnail->{height};
  my $requested_height = $thumbnail->{requested_height};
  my $filename = $thumbnail->{filename};
  my $mime_type = $thumbnail->{mime_type};
  print "$name $mime_type is $width x $height at $filename with requested width $requested_width requested height $requested_height\n";
}

Since the aspect ratio is kept, width and height will hold the resulting width and height after resizing, while requested_width and requested_height will hold the width and height that the image was requested to be resized to.

You can also pass in an optional third argument to "generate", which if set to true will return a hash of hashes for all of the resized images, where the key is the name provided in "sizes".

my $thumbnails = $thumbnail->generate( $source, $directory, 1 );
while(my ($name, $thumbnail) = each %$thumbnails) {
  my $name = $thumbnail->{name};
  my $width = $thumbnail->{width};
  my $requested_width = $thumbnail->{requested_width};
  my $height = $thumbnail->{height};
  my $requested_height = $thumbnail->{requested_height};
  my $filename = $thumbnail->{filename};
  my $mime_type = $thumbnail->{mime_type};
  print "$name $mime_type is $width x $height at $filename with requested width $requested_width requested height $requested_height\n";
}

original_width

my $original_width = $thumbnail->original_width;

This subroutine returns the width of the original image. (Can only be called after generate).

original_height

my $original_height = $thumbnail->original_height;

This subroutine returns the height of the original image. (Can only be called after generate).

AUTHOR

Adam Hopkins, <srchulo at cpan.org>

BUGS

Please report any bugs or feature requests to bug-image-imlib2-thumbnail-scaled at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Image-Imlib2-Thumbnail-Scaled. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Image::Imlib2::Thumbnail::Scaled

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2013 Adam Hopkins.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.