php-doc-en/reference/image/functions/imagelayereffect.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<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="examples">
  &reftitle.examples;
  <example>
   <title><function>imagelayereffect</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
// Setup an image
$im = imagecreatetruecolor(100, 100);

// Set a background
imagefilledrectangle($im, 0, 0, 100, 100, imagecolorallocate($im, 220, 220, 220));

// Apply the overlay alpha blending flag
imagelayereffect($im, IMG_EFFECT_OVERLAY);

// Draw two grey ellipses
imagefilledellipse($im, 50, 50, 40, 40, imagecolorallocate($im, 100, 255, 100));
imagefilledellipse($im, 50, 50, 50, 80, imagecolorallocate($im, 100, 100, 255));
imagefilledellipse($im, 50, 50, 80, 50, imagecolorallocate($im, 255, 100, 100));

// Output
header('Content-type: image/png');

imagepng($im);
imagedestroy($im);
?>
]]>
   </programlisting>
   &example.outputs.similar;
    <mediaobject>
     <alt>Output of example : imagelayereffect()</alt>
     <imageobject>
      <imagedata fileref="en/reference/image/figures/imagelayereffect.png"/>
     </imageobject>
    </mediaobject>
  </example>
 </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:"~/.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
-->