Documented imagecolorclosesthwb

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@260452 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Kalle Sommer Nielsen 2008-05-30 00:43:03 +00:00
parent 6d4a434cf5
commit d2dda26ce4

View file

@ -1,10 +1,11 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id='function.imagecolorclosesthwb' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imagecolorclosesthwb</refname>
<refpurpose>Get the index of the color which has the hue, white and blackness nearest to the given color</refpurpose>
<refpurpose>Get the index of the color which has the hue, white and blackness</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@ -14,8 +15,12 @@
<methodparam><type>int</type><parameter>green</parameter></methodparam>
<methodparam><type>int</type><parameter>blue</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Get the index of the color which has the hue,
white and blacknessnearest the given color.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -48,6 +53,45 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an integer with the index of the color which has
the hue, white and blackness nearest the given color.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Example of using <function>imagecolorclosesthwb</function></title>
<programlisting role="php">
<![CDATA[
<?php
$im = imagecreatefromgif('php.gif');
echo 'HWB: ' . imagecolorclosesthwb($im, 116, 115, 152);
imagedestroy($im);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
HWB: 33
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.no-windows;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file