php-doc-en/reference/image/functions/imagecolorclosest.xml
Hannes Magnusson c030e2adf7 Upgrade to DocBook5:
- All id attributes are now xml:id
 - Add docbook namespace to all root elements
 - Replace <ulink /> with <link xlink:href />
 - Minor markup fixes here and there


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
2007-06-20 22:25:43 +00:00

101 lines
2.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.imagecolorclosest" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imagecolorclosest</refname>
<refpurpose>Get the index of the closest color to the specified color</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>imagecolorclosest</methodname>
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
<methodparam><type>int</type><parameter>red</parameter></methodparam>
<methodparam><type>int</type><parameter>green</parameter></methodparam>
<methodparam><type>int</type><parameter>blue</parameter></methodparam>
</methodsynopsis>
<para>
Returns the index of the color in the palette of the image which
is "closest" to the specified <acronym>RGB</acronym> value.
</para>
<para>
The "distance" between the desired color and each color in the
palette is calculated as if the <acronym>RGB</acronym> values
represented points in three-dimensional space.
</para>
<para>
If you created the image from a file, only colors used in the image are
resolved. Colors present only in the pallete are not resolved.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&gd.image.description;
<varlistentry>
<term><parameter>red</parameter></term>
<listitem>
<para>
Value of red component
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>green</parameter></term>
<listitem>
<para>
Value of green component
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>blue</parameter></term>
<listitem>
<para>
Value of blue component
</para>
</listitem>
</varlistentry>
</variablelist>
The colors parameters are integers between 0 and 255 or hexadecimals
between 0x00 and 0xFF.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the index of the closest color, in the palette of the image, to
the specified one
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imagecolorexact</function></member>
</simplelist>
</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
-->