php-doc-en/reference/image/functions/imagelayereffect.xml
2007-10-13 17:52:19 +00:00

105 lines
3 KiB
XML
Executable file

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.imagelayereffect" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imagelayereffect</refname>
<refpurpose>Set the alpha blending flag to use the bundled libgd layering effects</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagelayereffect</methodname>
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
<methodparam><type>int</type><parameter>effect</parameter></methodparam>
</methodsynopsis>
<para>
Set the alpha blending flag to use the bundled libgd layering effects.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&gd.image.description;
<varlistentry>
<term><parameter>effect</parameter></term>
<listitem>
<para>
One of the following constants:
<variablelist>
<varlistentry>
<term><constant>IMG_EFFECT_REPLACE</constant></term>
<listitem>
<simpara>
Use pixel replacement (equivalent of passing &true; to
<function>imagealphablending</function>)
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>IMG_EFFECT_ALPHABLEND</constant></term>
<listitem>
<simpara>
Use normal pixel blending (equivalent of passing &false; to
<function>imagealphablending</function>)
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>IMG_EFFECT_NORMAL</constant></term>
<listitem>
<simpara>
Same as <constant>IMG_EFFECT_ALPHABLEND</constant>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>IMG_EFFECT_OVERLAY</constant></term>
<listitem>
<simpara>
Overlay has the effect that black background pixels will remain
black, white background pixels will remain white, but grey
background pixels will take the colour of the foreground pixel.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.bundled.gd;
&note.gd.2;
</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
-->