1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 331916 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagickpixel.getcolorasstring">
<refnamediv>
<refname>ImagickPixel::getColorAsString</refname>
<refpurpose>Returns the color as a string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ImagickPixel::getColorAsString</methodname>
<void/>
</methodsynopsis>
<para>
Returns the color of the ImagickPixel object as a string.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the color of the ImagickPixel object as a string.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Basic <function>Imagick::getColorAsString</function> usage</title>
<programlisting role="php">
<![CDATA[
<?php
//Create an ImagickPixel with the predefined color 'brown'
$color = new ImagickPixel('brown');
$color->setColorValue(Imagick::COLOR_ALPHA, 64 / 256.0);
$colorInfo = $color->getColorAsString();
print_r($colorInfo);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
rgb(165,42,42)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<title>Alpha not returned</title>
<para>
This function does not return the alpha value of the color in the string.
</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
-->
|