php-doc-en/reference/imagick/imagickpixel/getcolorvalue.xml
Mehdi Achour df66766a88 Use OO syntax
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@249575 c90b9560-bf6c-de11-be94-00142212c4b1
2007-12-31 19:40:12 +00:00

70 lines
1.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imagickpixel-getcolorvalue">
<refnamediv>
<refname>ImagickPixel::getColorValue</refname>
<refpurpose>Gets the normalized value of the provided color channel</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>ImagickPixel</classname></ooclass>
<methodsynopsis>
<type>float</type><methodname>getColorValue</methodname>
<methodparam><type>int</type><parameter>color</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
&warn.undocumented.func;
<para>
Retrieves the value of the color channel specified, as a floating-point
number between 0 and 1.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>color</parameter></term>
<listitem>
<para>
The channel to check, specified as one of the Imagick channel constants.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The value of the channel, as a normalized floating-point number, throwing
ImagickPixelException on error.
</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:"../../../../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
-->