svn: /phpdoc/en/trunk/ language-snippets.ent reference/imagick/imagick/setimagealphachannel.xml reference/imagick/transparentpaintimage.xml

From: Date: Sun, 09 Aug 2009 21:01:22 +0000
Subject: svn: /phpdoc/en/trunk/ language-snippets.ent reference/imagick/imagick/setimagealphachannel.xml reference/imagick/transparentpaintimage.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-4631@lists.php.net to get a copy of this message
mkoppanen Sun, 09 Aug 2009 21:01:22 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=286971 Log: Added documentation for transparentpaintimage and setimagealphachannel Changed paths: U phpdoc/en/trunk/language-snippets.ent A phpdoc/en/trunk/reference/imagick/imagick/setimagealphachannel.xml A phpdoc/en/trunk/reference/imagick/transparentpaintimage.xml Modified: phpdoc/en/trunk/language-snippets.ent =================================================================== --- phpdoc/en/trunk/language-snippets.ent 2009-08-09 20:50:34 UTC (rev 286970) +++ phpdoc/en/trunk/language-snippets.ent 2009-08-09 21:01:22 UTC (rev 286971) @@ -1014,6 +1014,16 @@ <!-- Imagick default channel information --> <!ENTITY imagick.default.channel.info 'Defaults to <constant>Imagick::CHANNEL_DEFAULT</constant>. Refer to this list of <link linkend="imagick.constants.channel">channel constants</link>'> +<!-- Fuzz parameter --> +<!ENTITY imagick.parameter.fuzz 'The amount of fuzz. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color.'> + +<!-- Channel parameter --> +<!ENTITY imagick.parameter.channel 'Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine <link linkend="imagick.constants.channel">channel constants</link> using bitwise operators. &imagick.default.channel.info;'> + +<!-- Alpha parameter --> +<!ENTITY imagick.parameter.alpha 'The level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.'> + + <!ENTITY imagick.imagickexception.throw 'Throw an <classname>ImagickException</classname> on error.'> Added: phpdoc/en/trunk/reference/imagick/imagick/setimagealphachannel.xml =================================================================== --- phpdoc/en/trunk/reference/imagick/imagick/setimagealphachannel.xml (rev 0) +++ phpdoc/en/trunk/reference/imagick/imagick/setimagealphachannel.xml 2009-08-09 21:01:22 UTC (rev 286971) @@ -0,0 +1,82 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!-- $Revision: 283818 $ --> +<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imagick-setimagealphachannel"> + <refnamediv> + <refname>Imagick::setImageAlphChannel</refname> + <refpurpose>Sets image alpha channel</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>Imagick::setImageAlphChannel</methodname> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> + <para> + Activate or deactivate image alpha channel. The <parameter>mode</parameter> + is one of the <constant>Imagick::ALPHACHANNEL_*</constant> constants. + &imagick.method.available.0x638; + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + One of the <constant>Imagick::ALPHACHANNEL_*</constant> constants + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &imagick.return.success; + </para> + </refsect1> + + <refsect1 role="errors"> + &reftitle.errors; + <para> + &imagick.imagick.throws; + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>Imagick::setImageMatte</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 +--> Added: phpdoc/en/trunk/reference/imagick/transparentpaintimage.xml =================================================================== --- phpdoc/en/trunk/reference/imagick/transparentpaintimage.xml (rev 0) +++ phpdoc/en/trunk/reference/imagick/transparentpaintimage.xml 2009-08-09 21:01:22 UTC (rev 286971) @@ -0,0 +1,93 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!-- $Revision: 286757 $ --> +<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imagick-transparentpaintimage"> + <refnamediv> + <refname>Imagick::transparentPaintImage</refname> + <refpurpose>Paints pixels transparent</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>Imagick::transparentPaintImage</methodname> + <methodparam><type>mixed</type><parameter>target</parameter></methodparam> + <methodparam><type>float</type><parameter>alpha</parameter></methodparam> + <methodparam><type>float</type><parameter>fuzz</parameter></methodparam> + <methodparam><type>bool</type><parameter>invert</parameter></methodparam> + </methodsynopsis> + + <para> + Paints pixels matching the target color transparent. + &imagick.method.available.0x638; + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>target</parameter></term> + <listitem> + <para> + The target color to paint + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>alpha</parameter></term> + <listitem> + <para> + &imagick.parameter.alpha; + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>fuzz</parameter></term> + <listitem> + <para> + &imagick.parameter.fuzz; + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>invert</parameter></term> + <listitem> + <para> + If &true; paints any pixel that does not match the target color. + </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:"../../../../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 +-->

« previous php.doc.cvs (#4631) next »