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 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
|
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<refentry id="function.imagefilter">
<refnamediv>
<refname>imagefilter</refname>
<refpurpose>
Applies a filter to an image
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>imagefilter</methodname>
<methodparam><type>resource</type><parameter>src_im</parameter></methodparam>
<methodparam><type>int</type><parameter>filtertype</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>arg1</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>arg2</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>arg3</parameter></methodparam>
</methodsynopsis>
<para>
<function>imagefilter</function> applies the filter
<parameter>filtertype</parameter> to the image, using
<parameter>arg1</parameter>, <parameter>arg2</parameter> and
<parameter>arg3</parameter> where necessary.
</para>
<para>
<parameter>filtertype</parameter> can be one of the following:
<itemizedlist>
<listitem>
<simpara>
<parameter>IMG_FILTER_NEGATE</parameter>: Reverses all colors of
the image.
</simpara>
</listitem>
<listitem>
<simpara>
<parameter>IMG_FILTER_GRAYSCALE</parameter>: Converts the image into
grayscale.
</simpara>
</listitem>
<listitem>
<simpara>
<parameter>IMG_FILTER_BRIGHTNESS</parameter>: Changes the brightness
of the image. Use <parameter>arg1</parameter> to set the level of
brightness.
</simpara>
</listitem>
<listitem>
<simpara>
<parameter>IMG_FILTER_CONTRAST</parameter>: Changes the contrast of
the image. Use <parameter>arg1</parameter> to set the level of
contrast.
</simpara>
</listitem>
<listitem>
<simpara>
<parameter>IMG_FILTER_COLORIZE</parameter>: Like
<parameter>IMG_FILTER_GRAYSCALE</parameter>, except you can specify the
color. Use <parameter>arg1</parameter>, <parameter>arg2</parameter> and
<parameter>arg3</parameter> in the form of
<parameter>red</parameter>, <parameter>blue</parameter>,
<parameter>green</parameter>. The range for each color is 0 to 255.
</simpara>
</listitem>
<listitem>
<simpara>
<parameter>IMG_FILTER_EDGEDETECT</parameter>: Uses edge detection to
highlight the edges in the image.
</simpara>
</listitem>
<listitem>
<simpara>
<parameter>IMG_FILTER_EMBOSS</parameter>: Embosses the image.
</simpara>
</listitem>
<listitem>
<simpara>
<parameter>IMG_FILTER_GAUSSIAN_BLUR</parameter>: Blurs the image using
the Gaussian method.
</simpara>
</listitem>
<listitem>
<simpara>
<parameter>IMG_FILTER_SELECTIVE_BLUR</parameter>: Blurs the image.
</simpara>
</listitem>
<listitem>
<simpara>
<parameter>IMG_FILTER_MEAN_REMOVAL</parameter>: Uses mean removal to
achieve a "sketchy" effect.
</simpara>
</listitem>
<listitem>
<simpara>
<parameter>IMG_FILTER_SMOOTH</parameter>: Makes the image smoother.
Use <parameter>arg1</parameter> to set the level of smoothness.
</simpara>
</listitem>
</itemizedlist>
</para>
¬e.bundled.gd;
<para>
&return.success;
</para>
<para>
<example>
<title><function>imagefilter</function> grayscale example</title>
<programlisting role="php">
<![CDATA[
<?php
$im = imagecreatefrompng('dave.png');
if ($im && imagefilter($im, IMG_FILTER_GRAYSCALE)) {
echo 'Image converted to grayscale.';
imagepng($im, 'dave.png');
} else {
echo 'Conversion to grayscale failed.';
}
imagedestroy($im);
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title><function>imagefilter</function> brightness example</title>
<programlisting role="php">
<![CDATA[
<?php
$im = imagecreatefrompng('sean.png');
if ($im && imagefilter($im, IMG_FILTER_BRIGHTNESS, 20)) {
echo 'Image brightness changed.';
imagepng($im, 'sean.png');
} else {
echo 'Image brightness change failed.';
}
imagedestroy($im);
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title><function>imagefilter</function> colorize example</title>
<programlisting role="php">
<![CDATA[
<?php
$im = imagecreatefrompng('philip.png');
/* R, G, B, so 0, 255, 0 is green */
if ($im && imagefilter($im, IMG_FILTER_COLORIZE, 0, 255, 0)) {
echo 'Image successfully shaded green.';
imagepng($im, 'philip.png');
} else {
echo 'Green shading failed.';
}
imagedestroy($im);
?>
]]>
</programlisting>
</example>
</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
-->
|