.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Graphics::Color::RGB 3pm"
.TH Graphics::Color::RGB 3pm "2022-06-14" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Graphics::Color::RGB \- RGB color model
.SH "VERSION"
.IX Header "VERSION"
version 0.31
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Graphics::Color::RGB;
\&
\&    my $color = Graphics::Color::RGB\->new({
\&        red     => 1,
\&        blue    => .31,
\&        green   => .25,
\&    });
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Graphics::Color::RGB represents a Color in the sRGB color space.  Individual
color channels are expressed as decimal values from 0 to 1, 0 being a lack
of that color (or opaque in the case of alpha) and 1 being full color (or
transparent in the case of alpha).  If no options are provided then new
instance of \s-1RGB\s0 are opaque white, (that is equivalent to red => 1, green => 1,
blue => 1, alpha => 1).
.PP
Convenience methods are supplied to convert to various string values.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "red"
.IX Subsection "red"
.SS "r"
.IX Subsection "r"
Set/Get the red component of this Color.  Aliased to 'r' as well.
.SS "green"
.IX Subsection "green"
.SS "g"
.IX Subsection "g"
Set/Get the green component of this Color. Aliased to 'g' as well.
.SS "blue"
.IX Subsection "blue"
.SS "b"
.IX Subsection "b"
Set/Get the blue component of this Color. Aliased to 'b' as well.
.SS "alpha"
.IX Subsection "alpha"
.SS "a"
.IX Subsection "a"
Set/Get the alpha component of this Color. Aliased to 'a' as well.
.SS "name"
.IX Subsection "name"
Get the name of this color.  Only valid if the color was created by name.
.SH "METHODS"
.IX Header "METHODS"
.SS "as_string"
.IX Subsection "as_string"
Get a string version of this Color in the form of \s-1RED,GREEN,BLUE,ALPHA\s0
.SS "as_integer_string"
.IX Subsection "as_integer_string"
Return an integer formatted value for this color.  This format is suitable for
\&\s-1CSS RGBA\s0 values.
.SS "as_css_hex"
.IX Subsection "as_css_hex"
Return a hex formatted value with a prepended '#' for use in \s-1CSS\s0 and \s-1HTML.\s0
.SS "as_hex_string ( [$prepend] )"
.IX Subsection "as_hex_string ( [$prepend] )"
Return a hex formatted value for this color.  The output ignores the alpha
channel because, per the W3C, there is no hexadecimal notiation for an \s-1RGBA\s0
value. Optionally allows you to include a string that will be prepended. This
is a common way to add the \f(CW\*(C`#\*(C'\fR.
.SS "as_percent_string"
.IX Subsection "as_percent_string"
Return a percent formatted value for this color.  This format is suitable for
\&\s-1CSS RGBA\s0 values.
.SS "as_array"
.IX Subsection "as_array"
Get the \s-1RGB\s0 values as an array.
.SS "as_array_with_alpha"
.IX Subsection "as_array_with_alpha"
Get the \s-1RGBA\s0 values as an array
.SS "equal_to"
.IX Subsection "equal_to"
Compares this color to the provided one.  Returns 1 if true, else 0;
.SS "not_equal_to"
.IX Subsection "not_equal_to"
The opposite of equal_to.
.SS "from_color_library ($color_id)"
.IX Subsection "from_color_library ($color_id)"
Attempts to retrieve the specified color-id using Color::Library.  The
result is then converted into a Graphics::Color::RGB object.
.SS "from_hex_string($hex)"
.IX Subsection "from_hex_string($hex)"
Attempts to create a Graphics::Color::RGB object from a hex string. Works with
or without the leading # and with either 3 or 6 character hex strings.
.SS "to_hsl"
.IX Subsection "to_hsl"
Creates this \s-1RGB\s0 color in \s-1HSL\s0 space.  Returns a Graphics::Color::HSL object.
.SS "to_hsv"
.IX Subsection "to_hsv"
Creates this \s-1RGB\s0 color in \s-1HSV\s0 space.  Returns a Graphics::Color::HSV object.
.SH "AUTHOR"
.IX Header "AUTHOR"
Cory G Watson <gphat@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2014 by Cold Hard Code, \s-1LLC.\s0
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.