Image::Magick::Brand - Perl extension for creating branded images with ImageMagick.

- NAME
- SYNOPSIS
- DESCRIPTION
- PREREQUISITES
- PARAMETERS

- REQUIRED PARAMETERS
- OPTIONAL PARAMETERS

- EXPORT
- VERSION HISTORY
- SEE ALSO
- AUTHOR
- COPYRIGHT AND LICENSE

# NAME

Image::Magick::Brand - Perl extension for creating branded images with ImageMagick.

# SYNOPSIS

      use Image::Magick::Brand;
      my $b = new Image::Magick::Brand;

      $b->debug(1); # debugging statements on

      # Required parameters
      $b->brand( source => 'brand.png',
                 target => 'photo.jpg',
                 output => 'branded.jpg' );

      # Required and optional parameters
      $b->brand( source    => 'brand.png',
                 target    => 'photo.jpg',
                 output    => 'branded.jpg',
                 gravity   => 'SouthWest',
                 format    => 'jpg',
                 composite => 'over',
                 quality   => 75 );

# DESCRIPTION

Create branded images by composing one image on top of another. For optimal results, use a transparent png (or gif...if you must) as the source image. Note: You must have the appropriate system libraries installed to use certain image formats (ie: lipjpeg, libpng). ImageMagick will complain if you don't.

Source + Target = Branded Image

           +---------+   +---------+
           |         |   |         |
           |         |   |         |
           |         |   | +--+    |
    +--+   |         |   | |  |    |
    |  | + |         | = | +--+    |
    +--+   +---------+   +---------+

# PREREQUISITES

`Image::Magick`

# PARAMETERS

## REQUIRED PARAMETERS

source
  The input path of the source image ('brand image').

target
  The input path of the target image.

output
  The output path of the branded image.

## OPTIONAL PARAMETERS

gravity
  The gravity (location) of the source image on top of the target image.

       +---------+
       | 1  2  3 |
       |    4    |
       | 5  6  7 |
       +----------

       1 = NorthWest
       2 = North
       3 = NorthEast
       4 = Center
       5 = SouthWest (default)
       6 = South
       7 = SouthEast

quality
  Quality for JPG/MIFF/PNG output (0-100). Default = 100.

composite
  The 'composite' value as passed to ImageMagick's composite function. Default = 'over'. Read the docs for the other possible values.

format
  The output format. Default = jpg.

# EXPORT

None by default.

# VERSION HISTORY

Version 0.01 (03 May 2005): Initial Revision

# SEE ALSO

the Image::Magick manpage

the Image::Magick::Thumbnail::Fixed manpage

http://imagemagick.org/script/perl-magick.php

# AUTHOR

Adam Roth, <aroth@cpan.org>

Originally developed for http://www.fetishcyclesfanclub.com. Let me know if you find this module useful.

# COPYRIGHT AND LICENSE

Copyright 2005 by Adam Roth

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