1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
|
<?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 layering effects</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagelayereffect</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type>int</type><parameter>effect</parameter></methodparam>
</methodsynopsis>
<para>
Set the alpha blending flag to use 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>
<varlistentry>
<term><constant>IMG_EFFECT_MULTIPLY</constant></term>
<listitem>
<simpara>
Overlays with a multiply effect.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&gd.changelog.image-param;
<row>
<entry>7.2.0</entry>
<entry>
Added <constant>IMG_EFFECT_MULTIPLY</constant> (requires system libgd >=
2.1.1 or the bundled libgd).
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</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>
</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
-->
|