getcolor.xml

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

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>array</type><methodname>ImagickPixel::getColor</methodname>
   <methodparam choice="opt"><type>int</type><parameter>normalized</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Returns the color described by the ImagickPixel object, as an array. If the color has an
   opacity channel set, this is provided as a fourth value in the list.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>normalized</parameter></term>
     <listitem>
      <para>
       Normalize the color values. Possible values are <literal>0</literal>,
       <literal>1</literal> or <literal>2</literal>.
      </para>

      <table>
       <title>
        List of possible values for <parameter>normalized</parameter>
       </title>
       <tgroup cols="2">
        <thead>
         <row>
          <entry><parameter>normalized</parameter></entry>
          <entry>Description</entry>
         </row>
        </thead>
        <tbody>
         <row>
          <entry>
           <literal>0</literal>
          </entry>
          <entry>
           The RGB values are returned as <type>int</type>s in the range <literal>0</literal>
           to <literal>255</literal> (inclusive.)
           The alpha value is returned as <type>int</type> and is either <literal>0</literal>
           or <literal>1</literal>.
          </entry>
         </row>
         <row>
          <entry>
           <literal>1</literal>
          </entry>
          <entry>
           The RGBA values are returned as <type>float</type>s in the range <literal>0</literal>
           to <literal>1</literal> (inclusive.)
          </entry>
         </row>
         <row>
          <entry>
           <literal>2</literal>
          </entry>
          <entry>
           The RGBA values are returned as <type>int</type>s in the range <literal>0</literal>
           to <literal>255</literal> (inclusive.)
          </entry>
         </row>
        </tbody>
       </tgroup>
      </table>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   An array of channel values. Throws ImagickPixelException on error.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Basic <function>Imagick::getColor</function> usage</title>
    <programlisting role="php">
<![CDATA[
<?php

//Create an ImagickPixel with the predefined color 'brown'
$color = new ImagickPixel('brown');

//Set the color to have an alpha of 25%
$color->setColorValue(Imagick::COLOR_ALPHA, 64 / 256.0);

$colorInfo = $color->getColor();

echo "Standard values".PHP_EOL;
print_r($colorInfo);

$colorInfo = $color->getColor(1);

echo "Normalized values:".PHP_EOL;
print_r($colorInfo);

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
    <![CDATA[
Standard values
Array
(
    [r] => 165
    [g] => 42
    [b] => 42
    [a] => 0
)
Normalized values:
Array
(
    [r] => 0.64705882352941
    [g] => 0.16470588235294
    [b] => 0.16470588235294
    [a] => 0.25000381475547
)
    ]]>
    </screen>
   </example>
  </para>
 </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
-->