/usr/share/perl5/Prima/Image.pod is in libprima-perl 1.28-1.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 | =for rcs $Id: Image.pod,v 1.23 2008/09/03 11:31:40 dk Exp $
=head1 NAME
Prima::Image - Bitmap routines
=head1 SYNOPSIS
use Prima qw(Application);
# create a new image from scratch
my $i = Prima::Image-> new(
width => 32,
height => 32,
type => im::BW, # same as im::bpp1 | im::GrayScale
);
# draw something
$i-> begin_paint;
$i-> color( cl::White);
$i-> ellipse( 5, 5, 10, 10);
$i-> end_paint;
# mangle
$i-> size( 64, 64);
# file operations
$i-> save('a.gif') or die "Error saving:$@\n";
$i-> load('a.gif') or die "Error loading:$@\n";
# draw on screen
$::application-> begin_paint;
# an image is drawn as specified by its palette
$::application-> set( color => cl::Red, backColor => cl::Green);
$::application-> put_image( 100, 100, $i);
# a bitmap is drawn as specified by destination device colors
$::application-> put_image( 200, 100, $i-> bitmap);
=head1 DESCRIPTION
I<Prima::Image>, I<Prima::Icon> and I<Prima::DeviceBitmap> are classes for
bitmap handling, including file and graphic input and output. I<Prima::Image>
and I<Prima::DeviceBitmap> are descendants of I<Prima::Drawable> and represent
bitmaps, stored in memory. I<Prima::Icon> is a descendant of I<Prima::Image>
and contains a transparency mask along with the regular data.
=head1 USAGE
Images usually are represented as a memory area, where pixel data are stored
row-wise. The Prima toolkit is no exception, however, it does not assume that
the GUI system uses the same memory format. The implicit conversion routines
are called when I<Prima::Image> is about to be drawn onto the screen, for
example. The conversions are not always efficient, therefore the
I<Prima::DeviceBitmap> class is introduced to represent a bitmap, stored in the
system memory in the system pixel format. These two basic classes serve the
different needs, but can be easily converted to each other, with C<image> and
C<bitmap> methods. I<Prima::Image> is a more general bitmap representation,
capable of file and graphic input and output, plus it is supplied with number
of conversion and scaling functions. The I<Prima::DeviceBitmap> class has
almost none of additional functionality, and is targeted to efficient graphic
input and output.
=head2 Graphic input and output
As descendants of I<Prima::Drawable>, all I<Prima::Image>, I<Prima::Icon> and
I<Prima::DeviceBitmap> objects are subject to three-state painting mode -
normal ( disabled ), painting ( enabled ) and informational.
I<Prima::DeviceBitmap> is, however, exists only in the enabled state, and can
not be switched to the other two.
When an object enters the enabled state, it serves as a canvas, and all
I<Prima::Drawable> operations can be performed on it. When the object is back
to the disabled state, the graphic information is stored into the object
associated memory, in the pixel format, supported by the toolkit. This
information can be visualized by using one of C<Prima::Drawable::put_image>
group methods. If the object enters the enabled state again, the graphic
information is presented as an initial state of a bitmap.
It must be noted, that if an implicit conversion takes place after an object
enters and before it leaves the enabled state, as it is with I<Prima::Image>
and I<Prima::Icon>, the bitmap is converted to the system pixel format. During
such conversion some information can be lost, due to down-sampling, and there
is no way to preserve the information. This does not happen with
I<Prima::DeviceBitmap>.
Image objects can be drawn upon images, as well as on the screen and
L<Prima::Widget> objects. This operation is performed via one of
I<Prima::Drawable::put_image> group methods ( see L<Prima::Drawable>), and can
be called with the image object disregarding the paint state. The following
code illustrates the dualism of an image object, where it can serve both as a
drawing surface and as a drawing tool:
my $a = Prima::Image-> create( width => 100, height => 100, type => im::RGB);
$a-> begin_paint;
$a-> clear;
$a-> color( cl::Green);
$a-> fill_ellipse( 50, 50, 30, 30);
$a-> end_paint;
$a-> rop( rop::XorPut);
$a-> put_image( 10, 10, $a);
$::application-> begin_paint;
$::application-> put_image( 0, 0, $a);
$::application-> end_paint;
It must be noted, that C<put_image>, C<stretch_image> and C<put_image_indirect>
are only painting methods that allow drawing on an image that is in its
paint-disabled state. Moreover, in such context they only allow C<Prima::Image>
descendants to be passed as a source image object. This functionality does not
imply that the image is internally switched to the paint-enabled state and
back; the painting is performed without switching and without interference with
the system's graphical layer.
Another special case is a 1-bit ( monochrome ) DeviceBitmap. When it is drawn
upon a drawable with bit depth greater than 1, the drawable's color and
backColor properties are used to reflect 1 and 0 bits, respectively. On a 1-bit
drawable this does not happen, and the color properties are not used.
=head2 File input and output
Depending on the toolkit configuration, images can be read and written in
different formats. This functionality in accessible via C<load()> and C<save()>
methods. L<Prima::image-load> is dedicated to the description of loading and
saving parameters, that can be passed to the methods, so they can handle
different aspects of file format-specific options, such as multi-frame
operations, auto conversion when a format does not support a particular pixel
format etc. In this document, C<load()> and C<save()> methods are illustrated
only in their basic, single-frame functionality. When called with no extra
parameters, these methods fail only if a disk I/O error occurred or an unknown
image format was used.
When an image is loaded, the old bitmap memory content is discarded,
and the image attributes are changed accordingly to the loaded image.
Along with these, an image palette is loaded, if available, and
a pixel format is assigned, closest or identical to the pixel format
in the image file.
=head2 Pixel formats
I<Prima::Image> supports a number of pixel formats, governed by the C<::type>
property. It is reflected by an integer value, a combination of C<im::XXX>
constants. The whole set of pixel formats is represented by colored formats,
like, 16-color, 256-color and 16M-color, and by gray-scale formats, mapped to C
data types - unsigned char, unsigned short, unsigned long, float and double.
The gray-scale formats are further subdivided to real-number formats and
complex-number format; the last ones are represented by two real values per
pixel, containing the real and the imaginary values.
I<Prima::Image> can also be initialized from other formats, that it does not
support, but can convert data from. Currently these are represented by a set of
permutations of 32-bit RGBA format, and 24-bit BGR format. These formats can
only be used in conjunction with C<::data> property.
The conversions can be performed between any of the supported formats ( to do
so, C<::type> property is to be set-called ). An image of any of these formats
can be drawn on the screen, but if the system can not accept the pixel format (
as it is with non-integer or complex formats ), the bitmap data are implicitly
converted. The conversion does not change the data if the image is about to be
drawn; the conversion is performed only when the image is about to be served as
a drawing surface. If, by any reason, it is desired that the pixel format is
not to be changed, the C<::preserveType> property must be set to 1. It does not
prevent the conversion, but it detects if the image was implicitly converted
inside C<end_paint()> call, and reverts it to its previous pixel format.
There are situations, when pixel format must be changed together while
down-sampling the image. One of four down-sampling methods can be selected -
normal, 8x8 ordered halftoning, error diffusion, and error diffusion
combined with optimized palette. These can be set to
the C<::conversion> property with one of C<ict::XXX> constants.
When there is no information loss, C<::conversion> property is not used.
Another special case of conversion is a conversion with a palette. The following
calls,
$image-> type( im::bpp4);
$image-> palette( $palette);
and
$image-> palette( $palette);
$image-> type( im::bpp4);
produce different results, but none of these takes into account eventual
palette remapping, because C<::palette> property does not change bitmap pixel
data, but overwrites palette information. A proper call syntax here would be
$image-> set(
palette => $palette,
type => im::bpp4,
);
This call produces also palette pixel mapping. This syntax is most powerful
when conversion is set to C<ict::Optimized> ( by default ). It not
only allows remapping or downsampling to a predefined colors set, but also can
be used to limit palette size to a particular number, without knowing the actual
values of the final color palette. For example, for an 24-bit image,
$image-> set( type => im::bpp8, palette => 32);
call would calculate colors in the image, compress them to an optimized palette of
32 cells and finally converts to a 8-bit format.
Instead of C<palette> property, C<colormap> can also be used.
=head2 Data access
The pixel values can be accessed in I<Prima::Drawable> style, via C<::pixel>
property. However, I<Prima::Image> introduces several helper functions,
for different aims. The C<::data> property is used to set or retrieve
a scalar representation of bitmap data. The data are expected to be lined
up to a 'line size' margin ( 4-byte boundary ), which is calculated as
$lineSize = int(( $image->width * ( $image-> type & im::BPP) + 31) / 32) * 4;
or returned from the read-only property C<::lineSize>.
This is the line size for the data as lined up internally in memory, however
C<::data> should not necessarily should be aligned like this, and can be
accompanied with a write-only flag 'lineSize' if pixels are aligned differently:
$image-> set( width => 1, height=> 2);
$image-> type( im::RGB);
$image-> set(
data => 'RGB----RGB----',
lineSize => 7,
);
print $image-> data, "\n";
output: RGB-RGB-
Internally, Prima contains images in memory so that the first scanline is
the farthest away from the memory start; this is consistent with general
Y-axis orientation in Prima drawable terminology, but might be inconvenient
when importing data organized otherwise. Another write-only boolean flag C<reverse>
can be set to 1 so data then are treated as if the first scanline of the image
is the closest to the start of data:
$image-> set( width => 1, height=> 2, type => im::RGB);
$image-> set(
data => 'RGB-123-',
reverse => 1,
);
print $image-> data, "\n";
output: RGB-123-
Although it is possible to perform all kinds of calculations and modification
with the pixels, returned by C<::data>, it is not advisable unless the speed
does not matter. Standalone PDL package with help of L<PDL::PrimaImage>
package, and Prima-derived IPA package provide routines for data and image
analysis. Also, L<Prima::Image::Magick> connects L<ImageMagick> with Prima.
I<Prima::Image> itself provides only the simplest statistic information,
namely: lowest and highest pixel values, pixel sum, sum of square pixels, mean,
variance, and standard deviation.
=head2 Standalone usage
The image functionality can be used standalone, with all other parts of the
toolkit being uninitialized. This is useful in non-interactive programs,
running in evnironments with no GUI access, a cgi-script with no access to
X11 display, for example. Normally, Prima fails to start in such situations,
but can be told not to initialize its GUI part by explicitly operating
system-dependent options. To do so, invoke
use Prima::noX11;
in the beginning of your program. See L<Prima::noX11> for more.
=head2 Prima::Icon
I<Prima::Icon> inherits all properties of I<Prima::Image>, and it also provides
a 1-bit depth transparency mask. This mask can also be loaded and saved into
image files, if the format supports a transparency information.
Similar to I<Prima::Image::data> property, I<Prima::Icon::mask> property
provides access to the binary mask data. The mask can be updated
automatically, after an icon object was subject to painting, resizing, or other
destructive change. The auxiliary properties C<::autoMasking> and
C<::maskColor>/C<::maskIndex> regulate mask update procedure. For example, if
an icon was loaded with the color ( vs. bitmap ) transparency information, the
binary mask will be generated anyway, but it will be also recorded that a
particular color serves as a transparent indicator, so eventual conversions can
rely on the color value, instead of the mask bitmap.
If an icon is drawn upon a graphic canvas, the image output is constrained to
the mask. On raster displays it is typically simulated by a combination of and-
and xor- operation modes, therefore attempts to put an icon with C<::rop>,
different from C<rop::CopyPut>, usually fail.
=head1 API
=head2 Prima::Image properties
=over
=item colormap @PALETTE
A color palette, used for representing 1, 4, and 8-bit bitmaps, when an image
object is to be visualized. @PALETTE contains individual colors component
triplets, in RGB format. For example, black-and-white monochrome image may
contain colormap as C<0,0xffffff>.
See also C<palette>.
=item conversion TYPE
Selects the type of dithering algorithm to be used for pixel down-sampling.
TYPE is one of C<ict::XXX> constants:
ict::None - no dithering
ict::Halftone - 8x8 ordered halftone dithering
ict::ErrorDiffusion - error diffusion dithering with static palette
ict::Optimized - error diffusion dithering with optimized palette
As an example, if a 4x4 color image with every pixel set to RGB(32,32,32),
converted to a 1-bit image, the following results occur:
ict::None:
[ 0 0 0 0 ]
[ 0 0 0 0 ]
[ 0 0 0 0 ]
[ 0 0 0 0 ]
ict::Halftone:
[ 0 0 0 0 ]
[ 0 0 1 0 ]
[ 0 0 0 0 ]
[ 1 0 0 0 ]
ict::ErrorDiffusion, ict::Ordered:
[ 0 0 1 0 ]
[ 0 0 0 1 ]
[ 0 0 0 0 ]
[ 0 0 0 0 ]
=item data SCALAR
Provides access to the bitmap data. On get-call, returns all bitmap pixels,
aligned to 4-byte boundary. On set-call, stores the provided data with same
alignment. The alignment can be altered by submitting 'lineSize' write-only
flag to set call; the ordering of scan lines can be altered by setting
'reverse' write-only flag ( see L<Data access> ).
=item height INTEGER
Manages the vertical dimension of the image data.
On set-call, the image data are changed accordingly to the new height,
and depending on C<::vScaling> property,
the pixel values are either scaled or truncated.
=item hScaling BOOLEAN
If 1, the bitmap data will be scaled when image changes its
horizontal extent. If 0, the data will be stripped or padded
with zeros.
=item lineSize INTEGER
A read-only property, returning the length of an image row in bytes, as
represented internally in memory. Data returned by C<::data> property are
aligned with C<::lineSize> bytes per row, and setting C<::data> expects data
aligned with this value, unless C<lineSize> is set together with C<data> to
indicate another alignment. See L<Data access> for more.
=item mean
Returns mean value of pixels.
Mean value is C<::sum> of pixel values, divided by number of pixels.
=item palette [ @PALETTE ]
A color palette, used for representing 1, 4, and 8-bit bitmaps, when an image
object is to be visualized. @PALETTE contains individual color component
triplets, in BGR format. For example, black-and-white monochrome image may
contain palette as C<[0,0,0,255,255,255]>.
See also C<colormap>.
=item pixel ( X_OFFSET, Y_OFFSET ) PIXEL
Provides per-pixel access to the image data when
image object is in disabled paint state. Otherwise,
same as C<Prima::Drawable::pixel>.
=item preserveType BOOLEAN
If 1, reverts the image type to its old value if an
implicit conversion was called during C<end_paint()>.
=item rangeHi
Returns maximum pixel value in the image data.
=item rangeLo
Returns minimum pixel value in the image data.
=item size WIDTH, HEIGHT
Manages dimensions of the image. On set-call,
the image data are changed accordingly to the new dimensions,
and depending on C<::vScaling> and C<::hScaling> properties,
the pixel values are either scaled or truncated.
=item stats ( INDEX ) VALUE
Returns one of calculated values, that correspond to INDEX, which is one
of the following C<is::XXX> constants:
is::RangeLo - minimum pixel value
is::RangeHi - maximum pixel value
is::Mean - mean value
is::Variance - variance
is::StdDev - standard deviation
is::Sum - sum of pixel values
is::Sum2 - sum of squares of pixel values
The values are re-calculated on request and cached.
On set-call VALUE is stored in the cache, and is returned on next get-call.
The cached values are discarded every time the image data changes.
These values are also accessible via set of alias
properties: C<::rangeLo>, C<::rangeHi>, C<::mean>, C<::variance>,
C<::stdDev>, C<::sum>, C<::sum2>.
=item stdDev
Returns standard deviation of the image data.
Standard deviation is the square root of C<::variance>.
=item sum
Returns sum of pixel values of the image data
=item sum2
Returns sum of squares of pixel values of the image data
=item type TYPE
Governs the image pixel format type. TYPE is a combination
of C<im::XXX> constants. The constants are collected in groups:
Bit-depth constants provide size of pixel is bits. Their actual
value is same as number of bits, so C<im::bpp1> value is 1,
C<im::bpp4> - 4, etc. The valid constants represent bit depths
from 1 to 128:
im::bpp1
im::bpp4
im::bpp8
im::bpp16
im::bpp24
im::bpp32
im::bpp64
im::bpp128
The following values designate the pixel format category:
im::Color
im::GrayScale
im::RealNumber
im::ComplexNumber
im::TrigComplexNumber
Value of C<im::Color> is 0, whereas other category constants
represented by unique bit value, so combination of
C<im::RealNumber> and C<im::ComplexNumber> is possible.
There also several mnemonic constants defined:
im::Mono - im::bpp1
im::BW - im::bpp1 | im::GrayScale
im::16 - im::bpp4
im::Nibble - im::bpp4
im::256 - im::bpp8
im::RGB - im::bpp24
im::Triple - im::bpp24
im::Byte - gray 8-bit unsigned integer
im::Short - gray 16-bit unsigned integer
im::Long - gray 32-bit unsigned integer
im::Float - float
im::Double - double
im::Complex - dual float
im::DComplex - dual double
im::TrigComplex - dual float
im::TrigDComplex - dual double
Bit depths of float- and double- derived pixel formats
depend on a platform.
The groups can be masked out with the mask values:
im::BPP - bit depth constants
im::Category - category constants
im::FMT - extra format constants
The extra formats are the pixel formats, not supported by C<::type>,
but recognized within the combined set-call, like
$image-> set(
type => im::fmtBGRI,
data => 'BGR-BGR-',
);
The data, supplied with the extra image format specification will
be converted to the closest supported format. Currently, the following
extra pixel formats are recognized:
im::fmtBGR
im::fmtRGBI
im::fmtIRGB
im::fmtBGRI
im::fmtIBGR
=item variance
Returns variance of pixel values of the image data.
Variance is C<::sum2>, divided by number of pixels
minus square of C<::sum> of pixel values.
=item vScaling BOOLEAN
If 1, the bitmap data will be scaled when image changes its
vertical extent. If 0, the data will be stripped or padded
with zeros.
=item width INTEGER
Manages the horizontal dimension of the image data.
On set-call, the image data are changed accordingly to the new width,
and depending on C<::hScaling> property,
the pixel values are either scaled or truncated.
=back
=head2 Prima::Icon properties
=over
=item autoMasking TYPE
Selects whether the mask information should be updated
automatically with C<::data> change or not. Every
C<::data> change is mirrored in C<::mask>, using TYPE,
one of C<am::XXX> constants:
am::None - no mask update performed
am::MaskColor - mask update based on ::maskColor property
am::MaskIndex - mask update based on ::maskIndex property
am::Auto - mask update based on corner pixel values
The C<::maskColor> color value is used as a transparent color if
TYPE is C<am::MaskColor>. The transparency mask generation algorithm,
turned on by C<am::Auto> checks corner pixel values, assuming that
majority of the corner pixels represents a transparent color. Once
such color is found, the mask is generated as in C<am::MaskColor>
case.
C<::maskIndex> is the same as C<::maskColor>, except that it points
to a specific color index in the palette.
When image C<::data> is stretched, C<::mask> is stretched accordingly,
disregarding the C<::autoMasking> value.
=item mask SCALAR
Provides access to the transparency bitmap. On get-call, returns
all bitmap pixels, aligned to 4-byte boundary in 1-bit format. On set-call,
stores the provided transparency data with same alignment.
=item maskColor COLOR
When C<::autoMasking> set to C<am::MaskColor>, COLOR
is used as a transparency value.
=item maskIndex INDEX
When C<::autoMasking> set to C<am::MaskIndex>, INDEXth
color in teh current palette is used as a transparency value.
=back
=head2 Prima::DeviceBitmap properties
=over
=item monochrome BOOLEAN
A read-only property, that can only be set during creation,
reflects whether the system bitmap is black-and-white 1-bit (monochrome) or not.
The color depth of a bitmap can be read via C<get_bpp()> method; monochrome
bitmaps always have bit depth of 1.
=back
=head2 Prima::Image methods
=over
=item bitmap
Returns newly created I<Prima::DeviceBitmap> instance,
with the image dimensions and with the bitmap pixel
values copied to.
=item codecs
Returns array of hashes, each describing the supported image
format. If the array is empty, the toolkit was set up so
it can not load and save images.
See L<Prima::image-load> for details.
This method can be called without object instance.
=item dup
Returns a duplicate of the object, a newly created I<Prima::Image>, with all
information copied to it.
=item extract X_OFFSET, Y_OFFSET, WIDTH, HEIGHT
Returns a newly created image object with WIDTH and HEIGHT dimensions,
initialized with pixel data from X_OFFSET and Y_OFFSET
in the bitmap.
=item get_bpp
Returns the bit depth of the pixel format. Same as C<::type & im::BPP>.
=item get_handle
Returns a system handle for an image object.
=item load (FILENAME or FILEGLOB) [ %PARAMETERS ]
Loads image from file FILENAME or stream FILEGLOB into an object, and returns the success flag.
The semantics of C<load()> is extensive, and can be influenced by
PARAMETERS hash. C<load()> can be called either in a context of an existing object,
then a boolean success flag is returned, or in a class context, then a newly
created object ( or C<undef> ) is returned. If an error occurs, C<$@> variable
contains the error description string. These two invocation semantics are
equivalent:
my $x = Prima::Image-> create();
die "$@" unless $x-> load( ... );
and
my $x = Prima::Image-> load( ... );
die "$@" unless $x;
See L<Prima::image-load> for details.
NB! When loading from streams on win32, mind C<binmode>.
=item map COLOR
Performs iterative mapping of bitmap pixels, setting every pixel
to C<::color> property with respect to C<::rop> type if a pixel
equals to COLOR, and to C<::backColor> property with respect
to C<::rop2> type otherwise.
C<rop::NoOper> type can be used for color masking.
Examples:
width => 4, height => 1, data => [ 1, 2, 3, 4]
color => 10, backColor => 20, rop => rop::CopyPut
rop2 => rop::CopyPut
input: map(2) output: [ 20, 10, 20, 20 ]
rop2 => rop::NoOper
input: map(2) output: [ 1, 10, 3, 4 ]
=item resample SRC_LOW, SRC_HIGH, DEST_LOW, DEST_HIGH
Performs linear scaling of gray pixel values from range (SRC_LOW - SRC_HIGH)
to range (DEST_LOW - DEST_HIGH). Can be used to visualize
gray non-8 bit pixel values, by the code:
$image-> resample( $image-> rangeLo, $image-> rangeHi, 0, 255);
=item save (FILENAME or FILEGLOB), [ %PARAMETERS ]
Stores image data into image file FILENAME or stream FILEGLOB, and returns the success flag.
The semantics of C<save()> is extensive, and can be influenced by
PARAMETERS hash. If error occurs, C<$@> variable
contains error description string.
Note that when saving to a stream, C<codecID> must be explicitly given in C<%PARAMETERS>.
See L<Prima::image-load> for details.
NB! When saving to streams on win32, mind C<binmode>.
=back
=head2 Prima::Image events
C<Prima::Image>-specific events occur only from inside L<load> call, to report
image loading progress. Not all codecs (currently JPEG,PNG,TIFF only) are able
to report the progress to the caller. See L<Prima::image-load/"Loading with
progress indicator"> for details, L<Prima::ImageViewer/watch_load_progress> and
L<Prima::ImageDialog/load> for suggested use.
=over
=item HeaderReady
Called whenever image header is read, and image dimensions and pixel type
is changed accordingly to accomodate image data.
=item DataReady X, Y, WIDTH, HEIGHT
Called whenever image data that cover area designated by X,Y,WIDTH,HEIGHT
is acquired. Use C<load> option C<eventDelay> to limit the rate of C<DataReady>
event.
=back
=head2 Prima::Icon methods
=over
=item split
Returns two new I<Prima::Image> objects of same dimension.
Pixels in the first is are duplicated from C<::data> storage,
in the second - from C<::mask> storage.
=item combine DATA, MASK
Copies information from DATA and MASK images into C<::data>
and C<::mask> property. DATA and MASK are expected to be images
of same dimension.
=back
=head2 Prima::DeviceBitmap methods
=over
=item icon
Returns a newly created I<Prima::Icon> object instance, with the
pixel information copied from the object.
=item image
Returns a newly created I<Prima::Image> object instance, with the
pixel information copied from the object.
=item get_handle
Returns a system handle for a system bitmap object.
=back
=head1 AUTHOR
Dmitry Karasik, E<lt>dmitry@karasik.eu.orgE<gt>.
=head1 SEE ALSO
L<Prima>, L<Prima::Drawable>, L<Prima::image-load>, L<Prima::codecs>.
L<PDL>, L<PDL::PrimaImage>, L<IPA>
L<ImageMagick>, L<Prima::Image::Magick>
|