.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" 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::HSL 3pm" .TH Convert::Color::HSL 3pm "2023-06-26" "perl v5.36.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::HSL" \- a color value represented as hue/saturation/lightness .SH "SYNOPSIS" .IX Header "SYNOPSIS" Directly: .PP .Vb 1 \& use Convert::Color::HSL; \& \& my $red = Convert::Color::HSL\->new( 0, 1, 0.5 ); \& \& # Can also parse strings \& my $pink = Convert::Color::HSL\->new( \*(Aq0,1,0.8\*(Aq ); .Ve .PP Via Convert::Color: .PP .Vb 1 \& use Convert::Color; \& \& my $cyan = Convert::Color\->new( \*(Aqhsl:300,1,0.5\*(Aq ); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Objects in this class represent a color in \s-1HSL\s0 space, as a set of three floating-point values. Hue is stored as a value in degrees, in the range 0 to 360 (exclusive). Saturation and lightness are in the range 0 to 1. .PP This color space may be considered as a cylinder, of height and radius 1. Hue represents the position of the color as the angle around the axis, the saturation as the distance from the axis, and the lightness the height above the base. In this shape, the entire base of the cylinder is pure black, the axis through the centre represents the range of greys, and the entire top of the cylinder is pure white. The circumference of the circular cross-section midway along the axis contains the pure-saturated color wheel. .PP Because both surfaces of this cylinder contain pure black or white discs, a closely-related color space can be created by reshaping the cylinder into a bi-cone such that the top and bottom of the cylinder become single points. The radius from the axis of this shape is called the chroma (though this is a different definition of \*(L"chroma\*(R" than that used by \s-1CIE\s0). .PP While the components of this space are called Hue-Chroma-Lightness, it should not be confused with the similarly-named Hue-Chroma-Luminance (\s-1HCL\s0) space. .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .SS "new" .IX Subsection "new" .Vb 1 \& $color = Convert::Color::HSL\->new( $hue, $saturation, $lightness ) .Ve .PP Returns a new object to represent the set of values given. The hue should be in the range 0 to 360 (exclusive), and saturation and lightness should be between 0 and 1. Values outside of these ranges will be clamped. .PP .Vb 1 \& $color = Convert::Color::HSL\->new( $string ) .Ve .PP 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 \& hue,saturation,lightnes .Ve .PP containing the three floating-point values in decimal notation. .SH "METHODS" .IX Header "METHODS" .SS "hue" .IX Subsection "hue" .Vb 1 \& $h = $color\->hue .Ve .SS "saturation" .IX Subsection "saturation" .Vb 1 \& $s = $color\->saturation .Ve .SS "lightness" .IX Subsection "lightness" .Vb 1 \& $v = $color\->lightness .Ve .PP Accessors for the three components of the color. .SS "chroma" .IX Subsection "chroma" .Vb 1 \& $c = $color\->chroma .Ve .PP Returns the derived property of \*(L"chroma\*(R", which maps the color space onto a bicone instead of a cylinder. This more closely measures the intuitive concept of how \*(L"colorful\*(R" the color is than the saturation value and is useful for distance calculations. .SS "hsl" .IX Subsection "hsl" .Vb 1 \& ( $hue, $saturation, $lightness ) = $color\->hsl .Ve .PP Returns the individual hue, saturation and lightness components of the color value. .SS "dst_hsl" .IX Subsection "dst_hsl" .Vb 1 \& $measure = $color\->dst_hsl( $other ) .Ve .PP Returns a measure of the distance between the two colors. This is the Euclidean distance between the two colors as points in the chroma-adjusted cone space. .SS "dst_hsl_cheap" .IX Subsection "dst_hsl_cheap" .Vb 1 \& $measure = $color\->dst_hsl_cheap( $other ) .Ve .PP Returns a measure of the distance between the two colors. This is used in the calculation of \f(CW\*(C`dst_hsl\*(C'\fR but since it omits the final square-root and scaling it is 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 colors and 4 for the distance between complementary pure-saturated colors. .SH "SEE ALSO" .IX Header "SEE ALSO" .IP "\(bu" 4 Convert::Color \- color space conversions .IP "\(bu" 4 Convert::Color::RGB \- a color value represented as red/green/blue .IP "\(bu" 4 \- \s-1HSL\s0 and \s-1HSV\s0 on Wikipedia .SH "AUTHOR" .IX Header "AUTHOR" Paul Evans