mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00
196abbabb4
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322115 c90b9560-bf6c-de11-be94-00142212c4b1
79 lines
2.1 KiB
XML
79 lines
2.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagickpixel.issimilar">
|
|
<refnamediv>
|
|
<refname>ImagickPixel::isSimilar</refname>
|
|
<refpurpose>Check the distance between this color and another</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ImagickPixel::isSimilar</methodname>
|
|
<methodparam><type>ImagickPixel</type><parameter>color</parameter></methodparam>
|
|
<methodparam><type>float</type><parameter>fuzz</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.undocumented.func;
|
|
<para>
|
|
Checks the distance between the color described by this ImagickPixel
|
|
object and that of the provided object, by plotting their RGB values
|
|
on the color cube. If the distance between the two points is less than
|
|
the fuzz value given, the colors are similar.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>color</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The ImagickPixel object to compare this object against.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>fuzz</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The maximum distance within which to consider these colors as similar.
|
|
The theoretical maximum for this value is the square root of three
|
|
(1.732).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&imagick.return.success;
|
|
</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
|
|
-->
|