Skip to content

michal-josef-spacek/Image-Random

Repository files navigation

NAME
    Image::Random - Perl class for creating random image.

SYNOPSIS
     use Image::Random;

     my $obj = Image::Random->new(%parameters);
     my $type = $obj->create($output_path);
     my ($width, $height) = $obj->sizes($new_width, $new_height);
     my $type = $obj->type($new_type);

METHODS
  "new"
     my $obj = Image::Random->new(%parameters);

    Constructor.

    *       "color"

             Color of image.
             Default value is undef.
             Undefined value means random color.

    *       "debug"

             Debug mode.
             Default value is 0.

    *       "height"

             Height of image.
             Default value is 1920.

    *       "type"

             Image type.
             List of supported types: bmp, gif, jpeg, png, pnm, raw, sgi, tga, tiff
             Default value is 'bmp'.

    *       "width"

             Width of image.
             Default value is 1080.

  "create"
     my $type = $obj->create($output_path);

    Create image.

    Returns scalar value of supported file type.

  "sizes"
     my ($width, $height) = $obj->sizes($new_width, $new_height);

    Set/Get image sizes.

    Both parameters are optional, used only for set sizes.

    Returns actual width and height.

  "type"
     my $type = $obj->type($new_type);

    Set/Get image type.

    Parameter $new_type is optional, used only for setting.

    Returns actual type of image.

ERRORS
     new():
             Bad background color definition. Use Imager::Color object.
             Image type '%s' doesn't supported.
             From Class::Utils:
                     Unknown parameter '%s'.

     create():
             Cannot write file to '$path'.
                     Error, %s
             Image type '%s' doesn't supported.

EXAMPLE
     use strict;
     use warnings;

     use File::Temp qw(tempfile);
     use Image::Random;

     # Temporary file.
     my (undef, $temp) = tempfile();

     # Object.
     my $obj = Image::Random->new;

     # Create image.
     my $type = $obj->create($temp);

     # Print out type.
     print $type."\n";

     # Unlink file.
     unlink $temp;

     # Output:
     # bmp

DEPENDENCIES
    Class::Utils, Error::Pure, File::Basename, Imager, Imager::Color,
    List::MoreUtils.

SEE ALSO
    Data::Random
        Perl module to generate random data

    Image::Select
        Perl class for creating random image.

REPOSITORY
    <https://github.com/michal-josef-spacek/Image-Random>.

AUTHOR
    Michal Josef Špaček <mailto:skim@cpan.org>

    <http://skim.cz>

LICENSE AND COPYRIGHT
    © 2013-2021 Michal Josef Špaček

    BSD 2-Clause License

VERSION
    0.11

About

Perl class for creating random image.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages