.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Convert::Color::RGB16 3pm"
.TH Convert::Color::RGB16 3pm "2021-01-01" "perl v5.32.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"
"Convert::Color::RGB16" \- a color value represented as red/green/blue in
16\-bit integers
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Directly:
.PP
.Vb 1
\& use Convert::Color::RGB16;
\&
\& my $red = Convert::Color::RGB16\->new( 65535, 0, 0 );
\&
\& # Can also parse strings
\& my $pink = Convert::Color::RGB16\->new( \*(Aq65535,49152,49152\*(Aq );
\&
\& # or
\& $pink = Convert::Color::RGB16\->new( \*(Aqffffc000c000\*(Aq );
.Ve
.PP
Via Convert::Color:
.PP
.Vb 1
\& use Convert::Color;
\&
\& my $cyan = Convert::Color\->new( \*(Aqrgb16:0,65535,65535\*(Aq );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Objects in this class represent a color in \s-1RGB\s0 space, as a set of three
integer values in the range 0 to 65535; i.e. as 16 bits.
.PP
For representations using floating point values, see Convert::Color::RGB.
For representations using 8\-bit integers, see Convert::Color::RGB8.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.ie n .SS "$color = Convert::Color::RGB16\->new( $red, $green, $blue )"
.el .SS "\f(CW$color\fP = Convert::Color::RGB16\->new( \f(CW$red\fP, \f(CW$green\fP, \f(CW$blue\fP )"
.IX Subsection "$color = Convert::Color::RGB16->new( $red, $green, $blue )"
Returns a new object to represent the set of values given. These values should
be integers between 0 and 65535. Values outside of this range will be clamped.
.ie n .SS "$color = Convert::Color::RGB16\->new( $string )"
.el .SS "\f(CW$color\fP = Convert::Color::RGB16\->new( \f(CW$string\fP )"
.IX Subsection "$color = Convert::Color::RGB16->new( $string )"
Parses \f(CW$string\fR for values, and construct a new object similar to the above
three-argument form. The string should be in the form
.PP
.Vb 1
\& red,green,blue
.Ve
.PP
containing the three integer values in decimal notation. It can also be given
in the form of a hex encoded string, such as would be returned by the
\&\f(CW\*(C`rgb16_hex\*(C'\fR method:
.PP
.Vb 1
\& rrrrggggbbbb
.Ve
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "$r = $color\->red"
.el .SS "\f(CW$r\fP = \f(CW$color\fP\->red"
.IX Subsection "$r = $color->red"
.ie n .SS "$g = $color\->green"
.el .SS "\f(CW$g\fP = \f(CW$color\fP\->green"
.IX Subsection "$g = $color->green"
.ie n .SS "$b = $color\->blue"
.el .SS "\f(CW$b\fP = \f(CW$color\fP\->blue"
.IX Subsection "$b = $color->blue"
Accessors for the three components of the color.
.ie n .SS "( $red, $green, $blue ) = $color\->rgb16"
.el .SS "( \f(CW$red\fP, \f(CW$green\fP, \f(CW$blue\fP ) = \f(CW$color\fP\->rgb16"
.IX Subsection "( $red, $green, $blue ) = $color->rgb16"
Returns the individual red, green and blue color components of the color
value in \s-1RGB16\s0 space.
.ie n .SS "$str = $color\->hex"
.el .SS "\f(CW$str\fP = \f(CW$color\fP\->hex"
.IX Subsection "$str = $color->hex"
Returns a string representation of the color components in the \s-1RGB16\s0 space, in
a convenient \f(CW\*(C`RRRRGGGGBBBB\*(C'\fR hex string.
.ie n .SS "$mix = $color\->alpha_blend( $other, [ $alpha ] )"
.el .SS "\f(CW$mix\fP = \f(CW$color\fP\->alpha_blend( \f(CW$other\fP, [ \f(CW$alpha\fP ] )"
.IX Subsection "$mix = $color->alpha_blend( $other, [ $alpha ] )"
Return a new color which is a blended combination of the two passed into it.
The optional \f(CW$alpha\fR parameter defines the mix ratio between the two colors,
defaulting to 0.5 if not defined. Values closer to 0 will blend more of
\&\f(CW$color\fR, closer to 1 will blend more of \f(CW$other\fR.
.ie n .SS "$mix = $color\->alpha16_blend( $other, [ $alpha ] )"
.el .SS "\f(CW$mix\fP = \f(CW$color\fP\->alpha16_blend( \f(CW$other\fP, [ \f(CW$alpha\fP ] )"
.IX Subsection "$mix = $color->alpha16_blend( $other, [ $alpha ] )"
Similar to \f(CW\*(C`alpha_blend\*(C'\fR but works with integer arithmetic. \f(CW$alpha\fR should
be an integer in the range 0 to 65535.
.ie n .SS "$measure = $color\->dst_rgb16( $other )"
.el .SS "\f(CW$measure\fP = \f(CW$color\fP\->dst_rgb16( \f(CW$other\fP )"
.IX Subsection "$measure = $color->dst_rgb16( $other )"
Return a measure of the distance between the two colors. This is the
unweighted Euclidean distance of the three color components. Two identical
colors will have a measure of 0, pure black and pure white have a distance of
1, and all others will lie somewhere inbetween.
.ie n .SS "$measure = $color\->dst_rgb16_cheap( $other )"
.el .SS "\f(CW$measure\fP = \f(CW$color\fP\->dst_rgb16_cheap( \f(CW$other\fP )"
.IX Subsection "$measure = $color->dst_rgb16_cheap( $other )"
Return a measure of the distance between the two colors. This is the sum of
the squares of the differences of each of the color components. This is part
of the value used to calculate \f(CW\*(C`dst_rgb16\*(C'\fR, but since it involves no square
root it will be cheaper to calculate, for use in cases where only the relative
values matter, such as when picking the \*(L"best match\*(R" out of a set of colors.
It ranges between 0 for identical colours and 3*(65535^2) for the distance between
pure black and pure white.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
Convert::Color \- color space conversions
.SH "AUTHOR"
.IX Header "AUTHOR"
Paul Evans <leonerd@leonerd.org.uk>