php-doc-en/reference/imagick/imagickpixel/gethsl.xml
2012-01-12 05:08:38 +00:00

61 lines
1.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagickpixel.gethsl">
<refnamediv>
<refname>ImagickPixel::getHSL</refname>
<refpurpose>Returns the normalized HSL color of the ImagickPixel object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>ImagickPixel::getHSL</methodname>
<void/>
</methodsynopsis>
&warn.undocumented.func;
<para>
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.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the HSL value in an array with the keys "hue",
"saturation", and "luminosity". Throws ImagickPixelException on failure.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
Available with ImageMagick library version 6.2.9 and higher.
</para>
</note>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->