NAME
App::GraphicsColorNamesUtils - Utilities related to Graphics::ColorNames
VERSION
This document describes version 0.005 of App::GraphicsColorNamesUtils (from Perl distribution App-GraphicsColorNamesUtils), released on 2020-06-10.
DESCRIPTION
This distributions provides the following command-line utilities:
FUNCTIONS
colorcode2name
Usage:
colorcode2name(%args) -> [status, msg, payload, meta]Convert RGB color code to name.
This function is not exported.
Arguments ('*' denotes required arguments):
approx => bool
When a name with exact code is not found, find the several closest ones.
code* => color::rgb24
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
colorname2code
Usage:
colorname2code(%args) -> [status, msg, payload, meta]Convert color name to code.
This function is not exported.
Arguments ('*' denotes required arguments):
name* => str
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
list_color_names
Usage:
list_color_names(%args) -> [status, msg, payload, meta]List all color names from a Graphics::ColorNames scheme.
This function is not exported.
Arguments ('*' denotes required arguments):
detail => true
scheme* => perl::colorscheme::modname
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
list_color_schemes
Usage:
list_color_schemes() -> [status, msg, payload, meta]List all installed Graphics::ColorNames schemes.
This function is not exported.
No arguments.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
show_color_swatch
Usage:
show_color_swatch(%args) -> [status, msg, payload, meta]List all color names from a Graphics::ColorNames scheme as a color swatch.
This function is not exported.
Arguments ('*' denotes required arguments):
columns => posint (default: 1)
row_height => posint (default: 3)
scheme* => perl::colorscheme::modname
table_width => posint (default: 80)
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/App-GraphicsColorNamesUtils.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-GraphicsColorNamesUtils.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-GraphicsColorNamesUtils
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
SEE ALSO
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2020, 2018 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.