/ 
Convert-Color-0.02
River stage two • 17 direct dependents • 35 total dependents
/ Convert::Color::HSL

NAME

Convert::Color::HSL - a color value represented as hue/saturation/lightness

SYNOPSIS

Directly:

use Convert::Color::HSL;

my $red = Convert::Color::HSL->new( 0, 1, 0.5 );

# Can also parse strings
my $pink = Convert::Color::HSL->new( '0,1,0.8' );

Via Convert::Color:

use Convert::Color;

my $cyan = Convert::Color->new( 'hsl:300,1,0.5' );

DESCRIPTION

Objects in this class represent a color in HSL 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.

CONSTRUCTOR

$color = Convert::Color::HSL->new( $hue, $saturation, $lightness )

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.

$color = Convert::Color::HSL->new( $string )

Parses $string for values, and construct a new object similar to the above three-argument form. The string should be in the form

hue,saturation,lightnes

containing the three floating-point values in decimal notation.

METHODS

$h = $color->hue

$s = $color->saturation

$v = $color->lightness

Accessors for the three components of the color.

( $hue, $saturation, $lightness ) = $color->hsl

Returns the individual hue, saturation and lightness components of the color value.

SEE ALSO

AUTHOR

Paul Evans <leonerd@leonerd.org.uk>