NAME

Firefox::Marionette::Display - Represents a display from the displays method

VERSION

Version 1.64

SYNOPSIS

    use Firefox::Marionette();
    use Encode();
    use v5.10;
    my $firefox = Firefox::Marionette->new( visible => 1, kiosk => 1 )->go('http://metacpan.org');;
    my $element = $firefox->find_id('metacpan_search-input');
    foreach my $display ($firefox->displays()) {
        say 'Can Firefox resize for "' . Encode::encode('UTF-8', $display->usage(), 1) . '"?';
        if ($firefox->resize($display->width(), $display->height())) {
            say 'Now displaying with a Pixel aspect ratio of ' . $display->par();
            say 'Now displaying with a Storage aspect ratio of ' . $display->sar();
            say 'Now displaying with a Display aspect ratio of ' . $display->dar();
        } else {
            say 'Apparently NOT!';
        }
    }

DESCRIPTION

This module handles the implementation of a display <https://en.wikipedia.org/wiki/List_of_common_resolutions>.

SUBROUTINES/METHODS

dar

returns the Display aspect ratio <https://en.wikipedia.org/wiki/Display_aspect_ratio> for the display.

designation

returns the designation <https://en.wikipedia.org/wiki/List_of_common_resolutions> value, such as "VGA" or "16K".

new

accepts a hash for the display with the following allowed keys;

designation - See the designation <https://en.wikipedia.org/wiki/List_of_common_resolutions> column.
usage - See the usage <https://en.wikipedia.org/wiki/List_of_common_resolutions> column.
width - The width of the entire firefox window.
height - The height of the entire firefox window.
sar - The Storage aspect ratio <https://en.wikipedia.org/wiki/Aspect_ratio_(image)#storage_aspect_ratio>, which is related to the below ratios with the equation SAR = PAR/DAR.
dar - The Display aspect ratio <https://en.wikipedia.org/wiki/Display_aspect_ratio>.
par - The Pixel aspect ratio <https://en.wikipedia.org/wiki/Pixel_aspect_ratio>.

par

returns the Pixel aspect ratio <https://en.wikipedia.org/wiki/Pixel_aspect_ratio> for the display.

sar

returns the Storage aspect ratio <https://en.wikipedia.org/wiki/Aspect_ratio_(image)#storage_aspect_ratio>, which is related to the below ratios with the equation SAR = PAR/DAR.

total

returns the product of height and width.

usage

returns the usage <https://en.wikipedia.org/wiki/List_of_common_resolutions> value such as "Apple PowerBook G4".

DIAGNOSTICS

None.

CONFIGURATION AND ENVIRONMENT

Firefox::Marionette::Display requires no configuration files or environment variables.

DEPENDENCIES

Firefox::Marionette::Display does not requires any non-core Perl modules

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

To report a bug, or view the current list of bugs, please visit <https://github.com/david-dick/firefox-marionette/issues>

AUTHOR

David Dick "<ddick@cpan.org>"

LICENSE AND COPYRIGHT

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See "perlartistic" in perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.