ImagickPixel::getHSL

(PECL imagick 2, PECL imagick 3)

ImagickPixel::getHSLReturns the normalized HSL color of the ImagickPixel object

Description

public ImagickPixel::getHSL(): array

Returns the normalized HSL color described by the ImagickPixel object, with each of the three values as floating point numbers between 0.0 and 1.0.

Parameters

This function has no parameters.

Return Values

Returns the HSL value in an array with the keys "hue", "saturation", and "luminosity". Throws ImagickPixelException on failure.

Examples

Example #1 Basic Imagick::getHSL() example

<?php

$color
= new ImagickPixel('rgb(90%, 10%, 10%)');

$colorInfo = $color->getHSL();

print_r($colorInfo);

?>

The above example will output:

Array
(
    [hue] => 0
    [saturation] => 0.80001220740379
    [luminosity] => 0.50000762951095
)

Notes

Note:

Available with ImageMagick library version 6.2.9 and higher.

add a note add a note

User Contributed Notes 1 note

up
1
rio at rio dot st
15 years ago
This function needs ImageMagick > 6.2.8

In imagickpixel_class.c
#if MagickLibVersion > 0x628
/* {{{ proto array ImagickPixel::getHSL()
        Returns the normalized HSL color of the pixel wand in an array with the keys "hue", "saturation", and "luminosity".
*/
To Top