diff --git a/Prima.pm b/Prima.pm index 723f117c5..9fdae0335 100644 --- a/Prima.pm +++ b/Prima.pm @@ -520,7 +520,7 @@ L - event filtering L - animate gif and webp files -L - hard-coded image files +L - hardcoded image files L - support of Windows-like initialization files diff --git a/Prima/Image/Animate.pm b/Prima/Image/Animate.pm index 8a500c37e..1bfc84434 100644 --- a/Prima/Image/Animate.pm +++ b/Prima/Image/Animate.pm @@ -558,21 +558,21 @@ The module provides high-level access to GIF, APNG, and WebP animation sequences =head2 new $CLASS, %OPTIONS Creates an empty animation container. If C<$OPTIONS{images}> is given, it is -expected to be an array of images, best if loaded from gif files with -C and C parameters set ( see L for +expected to be an array of images, best if loaded from files with +the C and C parameters set ( see L for details). =head2 detect_animation $HASH -Checks C<{extras} hash> obtained from a image loaded with C flag set, -to detect whether the image is an animation, and if loading all of its frame is -supported by the module. Returns file format name on success, undef otherwise. +Checks the C<{extras} hash> obtained from an image loaded with the +C flag set to detect whether the image is an animation or not, and +if loading of all of its frame is supported by the module. Returns the file +format name on success, undef otherwise. =head2 load $SOURCE, %OPTIONS -Loads GIF or WebP animation sequence from file or stream C<$SOURCE>. Options -are the same as understood by C, and are passed -down to it. +Loads a GIF, APNG, or WebP animation sequence from C<$SOURCE> which is either a +file or a stream. Options are the same as used by the C method. =head2 add $IMAGE @@ -580,36 +580,37 @@ Appends an image frame to the container. =head2 bgColor -Return the background color specified by the sequence as the preferred -background color to use when there is no specific background to superimpose the -animation to. +Returns the background color specified by the sequence as the preferred +color to use when there is no specific background to superimpose the +animation on. =head2 current -Return index of the current frame +Returns the index of the current frame =head2 draw $CANVAS, $X, $Y -Draws the current composite frame on C<$CANVAS> at the given coordinates. +Draws the current composite frame on C<$CANVAS> at the given coordinates =head2 draw_background $CANVAS, $X, $Y -Fills the background on C<$CANVAS> at the given coordinates if file provides that. -Returns whether the canvas was tainted or not. +Fills the background on C<$CANVAS> at the given coordinates if the file +provides the color to fill. Returns a boolean value whether the canvas was +drawn on or not. =head2 height -Returns height of the composite frame. +Returns the height of the composite frame =head2 icon -Creates and returns an icon object off the current composite frame. +Returns a new icon object created from the current composite frame =head2 image -Creates and returns an image object off the current composite frame. The +Returns a new image object created from the current composite frame The transparent pixels on the image are replaced with the preferred background -color. +color =head2 is_stopped @@ -619,46 +620,46 @@ call C. =head2 length -Returns total animation length (without repeats) in seconds. +Returns the total animation length (without repeats) in seconds. =head2 loopCount [ INTEGER ] -Sets and returns number of loops left, undef for indefinite. +Sets and returns the number of loops left, undef for indefinite. =head2 next Advances one animation frame. The step triggers changes to the internally kept -icon image that create effect of transparency, if needed. The method returns a -hash, where the following fields are initialized: +buffer image that creates the effect of transparency if needed. The method +returns a hash, where the following fields are initialized: =over =item left, bottom, right, top -Coordinates of the changed area since the last frame was updated. +Coordinates of the changed area since the last frame was updated =item delay -Time in seconds how long the frame is expected to be displayed. +Time in seconds how long the frame is expected to be displayed =back =head2 reset -Resets the animation sequence. This call is necessary either when image sequence was altered, -or when sequence display restart is needed. +Resets the animation sequence. This call is necessary either when the image +sequence was altered, or when the sequence display restart is needed. =head2 size -Returns width and height of the composite frame. +Returns the width and height of the composite frame =head2 total -Return number fo frames +Return the number of frames =head2 width -Returns width of the composite frame. +Returns the width of the composite frame =head1 SEE ALSO diff --git a/Prima/Image/TransparencyControl.pm b/Prima/Image/TransparencyControl.pm index c0794ce3d..f50e6c33c 100644 --- a/Prima/Image/TransparencyControl.pm +++ b/Prima/Image/TransparencyControl.pm @@ -293,17 +293,17 @@ sub OK_Click =head1 NAME -Prima::Image::TransparencyControl - standard dialog -for transparent color index selection. +Prima::Image::TransparencyControl - standard dialog for selecting transparent +color when saving an image to a file. =head1 DESCRIPTION -The module contains two classes - C -and C. The former provides a dialog, -used by image codec-specific save options dialogs to select a transparent -color index when saving an image to a file. C -is a widget class that displays the image palette and allow color rather than -index selection. +The module contains two classes - C and +C. The former provides the dialog used by +image codec-specific save options dialogs to select a transparent color index +when saving an image to a file. C is the +widget class that displays the image palette and allows color rather than index +selection. =for podview @@ -317,12 +317,12 @@ index selection. =item index INTEGER -Selects the palette index. +Selects the palette index =item image IMAGE -Selects image which palette is displayed, and the color -index can be selected from. +Selects the image, reads its palette, and displays it in such a manner that +only a color that is found in the palette can be selected by the user. =back @@ -332,7 +332,7 @@ index can be selected from. =item Change -Triggered when the user changes C property. +Triggered when the user changes the C property. =back @@ -344,11 +344,11 @@ Triggered when the user changes C property. =item transparent BOOLEAN -If 1, the transparent selection widgets are enabled, and the -user can select the palette index. If 0, the widgets are -disabled; the image file is saved with no transparent color index. +If 1, the transparent color widgets are enabled, and the user can select the +transparent color index in the image palette. If 0, the widgets are disabled; +the image file is saved with no transparent color index. -The property can be toggled interactively by a checkbox. +The property can also be toggled interactively by a checkbox. =back diff --git a/Prima/Image/base64.pm b/Prima/Image/base64.pm index f145b35c4..780d52bf2 100644 --- a/Prima/Image/base64.pm +++ b/Prima/Image/base64.pm @@ -86,11 +86,12 @@ sub save =head1 NAME -Prima::Image::base64 - hard-coded image files +Prima::Image::base64 - hardcoded image files =head1 DESCRIPTION -Handles base64-encoded data streams to load images directly from source code. +Loads and saves images from and to base64-encoded data streams. +This allows loading images directly from the source code. =head1 SYNOPSIS @@ -117,10 +118,11 @@ Same as C but returns a C instance. =item save IMAGE_OR_ICON, %OPTIONS -Saves image into a datastream and return it encoded in base64. -Unless C<$OPTIONS{codecID}> or C<$image->{extras}->{codecID}> is set, tries to find the best codec for the job. +Saves an image to a datastream and encodes it in base64. Unless the +C<$OPTIONS{codecID}> or C<$image->{extras}->{codecID}> field is set, tries to +deduce the best codec for the job. -Returns encoded content on success, or C on failure. +Returns the encoded content on success, or C on failure. =back diff --git a/Prima/Image/heif.pm b/Prima/Image/heif.pm index 0ddd7ff97..744e389d3 100644 --- a/Prima/Image/heif.pm +++ b/Prima/Image/heif.pm @@ -284,16 +284,16 @@ sub save_dialog =head1 NAME -Prima::Image::heif +Prima::Image::heif - standard HEIF image save dialog =head1 DESCRIPTION -HEIF image save dialog +Provides the standard dialog with save options for HEIF images =head1 INSTALLATION libheif so far could be built from the sources, and its dependencies as well, -as major distros are not yet providing its binaries. For windows you can grab +as major distros do not yet provide the binaries. For Windows, you can grab the distro from L.