sethsl.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagickpixel.sethsl">
 <refnamediv>
  <refname>ImagickPixel::setHSL</refname>
  <refpurpose>Sets the normalized HSL color</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ImagickPixel::setHSL</methodname>
   <methodparam><type>float</type><parameter>hue</parameter></methodparam>
   <methodparam><type>float</type><parameter>saturation</parameter></methodparam>
   <methodparam><type>float</type><parameter>luminosity</parameter></methodparam>
  </methodsynopsis>
  <para>
   Sets the color described by the ImagickPixel object using normalized
   values for hue, saturation and luminosity.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>hue</parameter></term>
     <listitem>
      <para>
       The normalized value for hue, described as a fractional arc
       (between 0 and 1) of the hue circle, where the zero value is
       red.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>saturation</parameter></term>
     <listitem>
      <para>
       The normalized value for saturation, with 1 as full saturation.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>luminosity</parameter></term>
     <listitem>
      <para>
       The normalized value for luminosity, on a scale from black at
       0 to white at 1, with the full HS value at 0.5 luminosity.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &imagick.return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Use <function>ImagickPixel::setHSL</function> to modify a color</title>
    <programlisting role="php">
        <![CDATA[
<?php

//Create an almost pure red color
$color = new ImagickPixel('rgb(90%, 10%, 10%)');

//Get it's HSL values
$colorInfo = $color->getHSL();

//Rotate the hue by 180 degrees
$newHue = $colorInfo['hue'] + 0.5;
if ($newHue > 1) {
    $newHue = $newHue - 1;
}

//Set the ImagickPixel to the new color
$colorInfo = $color->setHSL($newHue, $colorInfo['saturation'], $colorInfo['luminosity']);

//Check that the new color is blue/green
$colorInfo = $color->getcolor();
print_r($colorInfo);

?>
        ]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [r] => 26
    [g] => 230
    [b] => 230
    [a] => 255
)
]]>
    </screen>
   </example>
  </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
-->