cvs: phpdoc /en language-snippets.ent /en/reference/image/functions gd-info.xml getimagesize.xml image-type-to-extension.xml
image-type-to-mime-type.xml image2wbmp.xml imagealphablending.xml imageantialias.xml imagearc.xml imagechar.xml imagecharup.xml imagecolorallocate.xml
imagecolorallocatealpha.xml imagecolorat.xml imagecolorclosest.xml imagecolorclosestalpha.xml imagecolorclosesthwb.xml imagecolordeallocate.xml
imagecolorexact.xml imagecolorexactalpha.xml imagecolormatch.xml imagecolorresolve.xml imagecolorresolvealpha.xml imagecolorset.xml
imagecolorsforindex.xml imagecolorstotal.xml imagecolortransparent.xml imageconvolution.xml imagecopy.xml imagecopymerge.xml imagecopymergegray.xml
imagecopyresampled.xml imagecopyresized.xml imagecreate.xml imagecreatefromgd.xml imagecreatefromgd2.xml imagecreatefromgd2part.xml
imagecreatefromgif.xml imagecreatefromjpeg.xml imagecreatefrompng.xml imagecreatefromstring.xml imagecreatefromwbmp.xml imagecreatefromxbm.xml imag!
ecreatefromxpm.xml imagecreatetruecolor.xml imagedashedline.xml imagedestroy.xml imageellipse.xml imagefill.xml imagefilledarc.xml
imagefilledellipse.xml imagefilledpolygon.xml imagefilledrectangle.xml imagefilltoborder.xml imagefilter.xml imagefontheight.xml imagefontwidth.xml
imageftbbox.xml imagefttext.xml imagegammacorrect.xml imagegd.xml imagegd2.xml imagegif.xml imageinterlace.xml imageistruecolor.xml imagejpeg.xml
imagelayereffect.xml imageline.xml imageloadfont.xml imagepalettecopy.xml imagepng.xml imagepolygon.xml imagepsbbox.xml imagepsencodefont.xml
imagepsextendfont.xml imagepsfreefont.xml imagepsloadfont.xml imagepsslantfont.xml imagepstext.xml imagerectangle.xml imagerotate.xml
imagesavealpha.xml imagesetbrush.xml imagesetpixel.xml imagesetstyle.xml imagesetthickness.xml imagesettile.xml imagestring.xml imagestringup.xml
imagesx.xml imagesy.xml imagetruecolortopalette.xml imagettfbbox.xml imagettftext.xml imagetypes.xml imagewbmp.xml imagexbm.xml iptcembed.xml!
iptcparse.xml jpeg2wbmp.xml png2wbmp.xml

didou Sun Jan 14 03:15:22 2007 UTC Modified files: /phpdoc/en language-snippets.ent /phpdoc/en/reference/image/functions gd-info.xml getimagesize.xml image-type-to-extension.xml image-type-to-mime-type.xml image2wbmp.xml imagealphablending.xml imageantialias.xml imagearc.xml imagechar.xml imagecharup.xml imagecolorallocate.xml imagecolorallocatealpha.xml imagecolorat.xml imagecolorclosest.xml imagecolorclosestalpha.xml imagecolorclosesthwb.xml imagecolordeallocate.xml imagecolorexact.xml imagecolorexactalpha.xml imagecolormatch.xml imagecolorresolve.xml imagecolorresolvealpha.xml imagecolorset.xml imagecolorsforindex.xml imagecolorstotal.xml imagecolortransparent.xml imageconvolution.xml imagecopy.xml imagecopymerge.xml imagecopymergegray.xml imagecopyresampled.xml imagecopyresized.xml imagecreate.xml imagecreatefromgd.xml imagecreatefromgd2.xml imagecreatefromgd2part.xml imagecreatefromgif.xml imagecreatefromjpeg.xml imagecreatefrompng.xml imagecreatefromstring.xml imagecreatefromwbmp.xml imagecreatefromxbm.xml imagecreatefromxpm.xml imagecreatetruecolor.xml imagedashedline.xml imagedestroy.xml imageellipse.xml imagefill.xml imagefilledarc.xml imagefilledellipse.xml imagefilledpolygon.xml imagefilledrectangle.xml imagefilltoborder.xml imagefilter.xml imagefontheight.xml imagefontwidth.xml imageftbbox.xml imagefttext.xml imagegammacorrect.xml imagegd.xml imagegd2.xml imagegif.xml imageinterlace.xml imageistruecolor.xml imagejpeg.xml imagelayereffect.xml imageline.xml imageloadfont.xml imagepalettecopy.xml imagepng.xml imagepolygon.xml imagepsbbox.xml imagepsencodefont.xml imagepsextendfont.xml imagepsfreefont.xml imagepsloadfont.xml imagepsslantfont.xml imagepstext.xml imagerectangle.xml imagerotate.xml imagesavealpha.xml imagesetbrush.xml imagesetpixel.xml imagesetstyle.xml imagesetthickness.xml imagesettile.xml imagestring.xml imagestringup.xml imagesx.xml imagesy.xml imagetruecolortopalette.xml imagettfbbox.xml imagettftext.xml imagetypes.xml imagewbmp.xml imagexbm.xml iptcembed.xml iptcparse.xml jpeg2wbmp.xml png2wbmp.xml Log: gd: switch to new docstyle

http://cvs.php.net/viewvc.cgi/phpdoc/en/language-snippets.ent?r1=1.179&r2=1.180&diff_format=u Index: phpdoc/en/language-snippets.ent diff -u phpdoc/en/language-snippets.ent:1.179 phpdoc/en/language-snippets.ent:1.180 --- phpdoc/en/language-snippets.ent:1.179 Thu Jan 11 00:17:18 2007 +++ phpdoc/en/language-snippets.ent Sun Jan 14 03:15:21 2007 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.179 $ --> +<!-- $Revision: 1.180 $ --> <!-- Keep 'em sorted --> @@ -229,6 +229,16 @@ <!ENTITY note.gd.2 '<note><simpara>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</simpara></note>'> +<!ENTITY gd.image.description '<varlistentry><term><parameter> +image</parameter></term><listitem><para>An image resource, returned by one of the image creation functions, +such as <function>imagecreatetruecolor</function>.</para></listitem></varlistentry>'> + +<!ENTITY gd.font.description '<varlistentry><term><parameter> +font</parameter></term><listitem><para>Can be 1, 2, 3, 4, 5 for built-in +fonts (where higher numbers corresponding to larger fonts) or any of your +own font identifiers registered with <function>imageloadfont</function>. +</para></listitem></varlistentry>'> + <!-- Date and time entities --> <!ENTITY date.timezone.errors.description '<para> Every call to a date/time function will generate a <constant>E_NOTICE</constant> @@ -441,7 +451,7 @@ <!ENTITY sqlsafemode '<link linkend="ini.sql.safe-mode">SQL safe mode</link>'> -<!-- XMLWriter Notes --> +<!-- APD Notes --> <!ENTITY apd.debug-level.description '<varlistentry><term><parameter> debug_level</parameter></term><listitem><para>An integer which is formed by adding together the <literal>XXX_TRACE</literal> constants.</para><para>It is not recommended http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/gd-info.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/gd-info.xml diff -u phpdoc/en/reference/image/functions/gd-info.xml:1.5 phpdoc/en/reference/image/functions/gd-info.xml:1.6 --- phpdoc/en/reference/image/functions/gd-info.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/gd-info.xml Sun Jan 14 03:15:21 2007 @@ -1,20 +1,26 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id='function.gd-info'> <refnamediv> <refname>gd_info</refname> <refpurpose>Retrieve information about the currently installed GD library</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>gd_info</methodname> <void/> </methodsynopsis> - <simpara> - Returns an associative array describing the version and capabilities of - the installed GD library. - </simpara> + <para> + Gets information about the version and capabilities of the installed GD + library. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an associative array. + </para> <para> <table> <title>Elements of array returned by <function>gd_info</function></title> @@ -85,6 +91,9 @@ </tgroup> </table> </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Using <function>gd_info</function></title> @@ -95,9 +104,7 @@ ?> ]]> </programlisting> - <para> - The typical output is : - </para> + &example.outputs.similar; <screen> <![CDATA[ array(9) { @@ -124,13 +131,18 @@ </screen> </example> </para> - <simpara> - See also <function>imagepng</function>, - <function>imagejpeg</function>, - <function>imagegif</function>, - <function>imagewbmp</function>, and - <function>imagetypes</function>. - </simpara> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>imagepng</function></member> + <member><function>imagejpeg</function></member> + <member><function>imagegif</function></member> + <member><function>imagewbmp</function></member> + <member><function>imagetypes</function></member> + </simplelist> + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/getimagesize.xml?r1=1.27&r2=1.28&diff_format=u Index: phpdoc/en/reference/image/functions/getimagesize.xml diff -u phpdoc/en/reference/image/functions/getimagesize.xml:1.27 phpdoc/en/reference/image/functions/getimagesize.xml:1.28 --- phpdoc/en/reference/image/functions/getimagesize.xml:1.27 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/getimagesize.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.27 $ --> +<!-- $Revision: 1.28 $ --> <refentry id="function.getimagesize"> <refnamediv> <refname>getimagesize</refname> <refpurpose>Get the size of an image</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>getimagesize</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> @@ -14,144 +14,213 @@ </methodsynopsis> <para> The <function>getimagesize</function> function will determine the - size of any <acronym>GIF</acronym>, <acronym>JPG</acronym>, - <acronym>PNG</acronym>, <acronym>SWF</acronym>, - <acronym>SWC</acronym>, <acronym>PSD</acronym>, - <acronym>TIFF</acronym>, <acronym>BMP</acronym>, - <acronym>IFF</acronym>, <acronym>JP2</acronym>, - <acronym>JPX</acronym>, <acronym>JB2</acronym>, - <acronym>JPC</acronym>, <acronym>XBM</acronym>, or - <acronym>WBMP</acronym> image file and return the dimensions along with - the file type and a height/width text string to be used inside a normal - <acronym>HTML</acronym> <sgmltag>IMG</sgmltag> tag. - </para> - <para> - If accessing the <parameter>filename</parameter> image is impossible, - or if it isn't a valid picture, <function>getimagesize</function> - will return &false; and generate an error of level - <varname>E_WARNING</varname>. + size of any given image file and return the dimensions along with + the file type and a height/width text string to be used inside a + normal <acronym>HTML</acronym> <sgmltag>IMG</sgmltag> tag and the + correspondant <acronym>HTTP</acronym> content type. + </para> + <para> + <function>getimagesize</function> can also return some more information + in <parameter>imageinfo</parameter> parameter. </para> - <note> - <para> - Support for <acronym>JPC</acronym>, <acronym>JP2</acronym>, - <acronym>JPX</acronym>, <acronym>JB2</acronym>, - <acronym>XBM</acronym>, and <acronym>WBMP</acronym> became available in - PHP 4.3.2. Support for <acronym>SWC</acronym> exists as of PHP 4.3.0 - and <acronym>TIFF</acronym> support was added in PHP 4.2.0 - </para> - </note> <note> <simpara> - JPEG 2000 support was added in PHP 4.3.2. Note that JPC and JP2 are - capable of having components with different bit depths. In this case, - the value for "bits" is the highest bit depth encountered. Also, JP2 + Note that JPC and JP2 are capable of having components with different + bit depths. In this case, the value for "bits" is the highest bit depth encountered. Also, JP2 files may contain multiple JPEG 2000 codestreams. In this case, <function>getimagesize</function> returns the values for the first codestream it encounters in the root of the file. </simpara> </note> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>imageinfo</parameter></term> + <listitem> + <para> + This optional parameter allows you to extract some extended + information from the image file. Currently, this will return the + different <acronym>JPG</acronym> APP markers as an associative array. + Some programs use these APP markers to embed text information in + images. A very common one is to embed + <ulink url="&url.iptc;">IPTC</ulink> information in the APP13 marker. + You can use the <function>iptcparse</function> function to parse the + binary APP13 marker into something readable. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array with 5 elements. + </para> + <para> + Index 0 and 1 contains respectively the width and the height of the image. + </para> <note> - <simpara> - The <function>getimagesize</function> function does not require the GD - image library. - </simpara> + <para> + Some formats may contain no image or may contain multiple images. In these + cases, <function>getimagesize</function> might not be able to properly + determine the image size. <function>getimagesize</function> will return + zero for width and height in these cases. + </para> </note> <para> - Returns an array with 4 elements. Index 0 contains the width of - the image in pixels. Index 1 contains the height. Index 2 is a - flag indicating the type of the image: 1 = GIF, 2 = JPG, 3 = - PNG, 4 = SWF, 5 = PSD, 6 = BMP, 7 = TIFF(intel byte order), - 8 = TIFF(motorola byte order), 9 = JPC, 10 = JP2, 11 = JPX, 12 = - JB2, 13 = SWC, 14 = IFF, 15 = WBMP, 16 = XBM. These values correspond to - the IMAGETYPE constants that were added in PHP 4.3.0. Index 3 is a text - string with the correct height="yyy" width="xxx" string that can be used + Index 2 is one of the <literal>IMAGETYPE_XXX</literal> constants indicating + the type of the image. + </para> + <para> + Index 3 is a text string with the correct + <literal>height="yyy" width="xxx"</literal> string that can be used directly in an IMG tag. + </para> + <para> + <literal>mime</literal> is the correspondant MIME type of the image. + This information can be used to deliver images with correct the HTTP + <literal>Content-type</literal> header: <example> - <title>getimagesize (file)</title> + <title>getimagesize() and MIME types</title> <programlisting role="php"> <![CDATA[ <?php -list($width, $height, $type, $attr) = getimagesize("img/flag.jpg"); -echo "<img src=\"img/flag.jpg\" $attr alt=\"getimagesize() example\" />"; +$size = getimagesize($filename); +$fp = fopen($filename, "rb"); +if ($size && $fp) { + header("Content-type: {$size['mime']}"); + fpassthru($fp); + exit; +} else { + // error +} ?> ]]> </programlisting> </example> </para> <para> - URL support was added in PHP 4.0.5 + <literal>channels</literal> will be 3 for RGB pictures and 4 for CMYK + pictures. <literal>bits</literal> is the number of bits for each color. + However, for some image types, the presence of these values can be a bit + confusing. As an example, <acronym>GIF</acronym> always uses 3 channels + per pixel, but the number of bits per pixel cannot be calculated for an + animated <acronym>GIF</acronym> with a global color table. + </para> + <para> + On failure, &false; is returned. + </para> + </refsect1> + <refsect1 role="errors"> + &reftitle.errors; + <para> + If accessing the <parameter>filename</parameter> image is impossible, or + if it isn't a valid picture, <function>getimagesize</function> will + generate an error of level <varname>E_WARNING</varname>. + </para> + </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.3.2</entry> + <entry> + Support for <acronym>JPC</acronym>, <acronym>JP2</acronym>, + <acronym>JPX</acronym>, <acronym>JB2</acronym>, + <acronym>XBM</acronym>, and <acronym>WBMP</acronym> became available. + </entry> + </row> + <row> + <entry>4.3.2</entry> + <entry> + JPEG 2000 support was added for the <parameter>imageinfo</parameter> + parameter. + </entry> + </row> + <row> + <entry>4.3.0</entry> + <entry> + <literal>bits</literal> and <literal>channels</literal> are present + for other image types, too. + </entry> + </row> + <row> + <entry>4.3.0</entry> + <entry> + <literal>mime</literal> was added. + </entry> + </row> + <row> + <entry>4.3.0</entry> + <entry> + Support for <acronym>SWC</acronym> was added. + </entry> + </row> + <row> + <entry>4.2.0</entry> + <entry> + Support for <acronym>TIFF</acronym> was added. + </entry> + </row> + <row> + <entry>4.0.5</entry> + <entry> + URL support was added. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> <example> - <title>getimagesize (URL)</title> + <title>getimagesize (file)</title> <programlisting role="php"> <![CDATA[ <?php -$size = getimagesize("http://www.example.com/gifs/logo.gif"); - -// if the file name has space in it, encode it properly -$size = getimagesize("http://www.example.com/gifs/lo%20go.gif"); - +list($width, $height, $type, $attr) = getimagesize("img/flag.jpg"); +echo "<img src=\"img/flag.jpg\" $attr alt=\"getimagesize() example\" />"; ?> ]]> </programlisting> </example> - </para> - <para> - With <acronym>JPG</acronym> images, two extra indexes are returned: - <literal>channels</literal> and <literal>bits</literal>. - <literal>channels</literal> will be 3 for RGB pictures and 4 for CMYK - pictures. <literal>bits</literal> is the number of bits for each color. - </para> - <para> - Beginning with PHP 4.3.0, <literal>bits</literal> and - <literal>channels</literal> are present for other image types, too. - However, the presence of these values can be a bit confusing. As an - example, <acronym>GIF</acronym> always uses 3 channels per pixel, but the - number of bits per pixel cannot be calculated for an animated - <acronym>GIF</acronym> with a global color table. - </para> - <para> - Some formats may contain no image or may contain multiple images. In these - cases, <function>getimagesize</function> might not be able to properly - determine the image size. <function>getimagesize</function> will return - zero for width and height in these cases. - </para> - <para> - Beginning with PHP 4.3.0, <function>getimagesize</function> also returns an - additional parameter, <literal>mime</literal>, that corresponds with the - MIME type of the image. This information can be used to deliver images - with correct HTTP Content-type headers: <example> - <title>getimagesize() and MIME types</title> + <title>getimagesize (URL)</title> <programlisting role="php"> <![CDATA[ <?php -$size = getimagesize($filename); -$fp=fopen($filename, "rb"); -if ($size && $fp) { - header("Content-type: {$size['mime']}"); - fpassthru($fp); - exit; -} else { - // error -} +$size = getimagesize("http://www.example.com/gifs/logo.gif"); + +// if the file name has space in it, encode it properly +$size = getimagesize("http://www.example.com/gifs/lo%20go.gif"); + ?> ]]> </programlisting> </example> - </para> - <para> - The optional <parameter>imageinfo</parameter> parameter allows - you to extract some extended information from the image - file. Currently, this will return the different - <acronym>JPG</acronym> APP markers as an associative array. Some - programs use these APP markers to embed text information in - images. A very common one is to embed <acronym>IPTC</acronym> - <ulink url="&url.iptc;">&url.iptc;</ulink> information in the - APP13 marker. You can use the <function>iptcparse</function> - function to parse the binary APP13 marker into something - readable. - </para> - <para> <example> <title>getimagesize() returning IPTC</title> <programlisting role="php"> @@ -167,11 +236,25 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + The <function>getimagesize</function> function does not require the GD + image library. + </para> + </note> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>image_type_to_mime_type</function>, - <function>exif_imagetype</function>, - <function>exif_read_data</function>, and - <function>exif_thumbnail</function>. + <simplelist> + <member><function>image_type_to_mime_type</function></member> + <member><function>exif_imagetype</function></member> + <member><function>exif_read_data</function></member> + <member><function>exif_thumbnail</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/image-type-to-extension.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/image/functions/image-type-to-extension.xml diff -u phpdoc/en/reference/image/functions/image-type-to-extension.xml:1.2 phpdoc/en/reference/image/functions/image-type-to-extension.xml:1.3 --- phpdoc/en/reference/image/functions/image-type-to-extension.xml:1.2 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/image-type-to-extension.xml Sun Jan 14 03:15:21 2007 @@ -1,20 +1,50 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.image-type-to-extension"> <refnamediv> <refname>image_type_to_extension</refname> <refpurpose>Get file extension for image type</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>image_type_to_extension</methodname> <methodparam><type>int</type><parameter>imagetype</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>include_dot</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; -<!-- returned by getimagesize, exif_read_data, exif_thumbnail, exif_imagetype --> + <para> + Returns the extension for the given <literal>IMAGETYPE_XXX</literal> + constant. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>imagetype</parameter></term> + <listitem> + <para> + One of the <literal>IMAGETYPE_XXX</literal> constant. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>include_dot</parameter></term> + <listitem> + <para> + Wether to prepend a dot to the extension or not. Default to &true;. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + A string with the extension corresponding to the given image type. + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/image-type-to-mime-type.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/image/functions/image-type-to-mime-type.xml diff -u phpdoc/en/reference/image/functions/image-type-to-mime-type.xml:1.6 phpdoc/en/reference/image/functions/image-type-to-mime-type.xml:1.7 --- phpdoc/en/reference/image/functions/image-type-to-mime-type.xml:1.6 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/image-type-to-mime-type.xml Sun Jan 14 03:15:21 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.image-type-to-mime-type"> <refnamediv> <refname>image_type_to_mime_type</refname> <refpurpose>Get Mime-Type for image-type returned by getimagesize, exif_read_data, exif_thumbnail, exif_imagetype</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>image_type_to_mime_type</methodname> <methodparam><type>int</type><parameter>imagetype</parameter></methodparam> @@ -15,17 +15,25 @@ <para> The <function>image_type_to_mime_type</function> function will determine the Mime-Type for an IMAGETYPE constant. - <example> - <title>image_type_to_mime_type (file)</title> - <programlisting role="php"> -<![CDATA[ -<?php -header("Content-type: " . image_type_to_mime_type(IMAGETYPE_PNG)); -?> -]]> - </programlisting> - </example> </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>imagetype</parameter></term> + <listitem> + <para> + One of the <literal>IMAGETYPE_XXX</literal> constants + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> The returned values are as follows <table> @@ -108,18 +116,39 @@ </tgroup> </table> </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> - <note> - <simpara> - This function does not require the GD image library. - </simpara> - </note> + <example> + <title>image_type_to_mime_type (file)</title> + <programlisting role="php"> +<![CDATA[ +<?php +header("Content-type: " . image_type_to_mime_type(IMAGETYPE_PNG)); +?> +]]> + </programlisting> + </example> </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function does not require the GD image library. + </para> + </note> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>getimagesize</function>, - <function>exif_imagetype</function>, - <function>exif_read_data</function> and - <function>exif_thumbnail</function>. + <simplelist> + <member><function>getimagesize</function></member> + <member><function>exif_imagetype</function></member> + <member><function>exif_read_data</function></member> + <member><function>exif_thumbnail</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/image2wbmp.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/image/functions/image2wbmp.xml diff -u phpdoc/en/reference/image/functions/image2wbmp.xml:1.8 phpdoc/en/reference/image/functions/image2wbmp.xml:1.9 --- phpdoc/en/reference/image/functions/image2wbmp.xml:1.8 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/image2wbmp.xml Sun Jan 14 03:15:21 2007 @@ -1,32 +1,55 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.image2wbmp"> <refnamediv> <refname>image2wbmp</refname> <refpurpose>Output image to browser or file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>image2wbmp</methodname> + <type>bool</type><methodname>image2wbmp</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>threshold</parameter></methodparam> </methodsynopsis> <para> - <function>image2wbmp</function> creates the - <acronym>WBMP</acronym> file in filename from the image - <parameter>image</parameter>. The <parameter>image</parameter> argument - is the return from one of the image create functions, such as - <function>imagecreatetruecolor</function>. + <function>image2wbmp</function> outputs or save a <acronym>WBMP</acronym> + version of the given <parameter>image</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The filename argument is optional, and if left off, the raw image - stream will be output directly. - By sending an <acronym>image/vnd.wap.wbmp</acronym> content-type - using <function>header</function>, you can create - a PHP script that outputs WBMP images directly. + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + Path to the saved file. If not given, the raw image stream will be + outputed directly. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>threshold</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>image2wbmp</function> example</title> @@ -45,14 +68,22 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; <note> <para> - WBMP support is only available if PHP was compiled - against GD-1.8 or later. + WBMP support is only available if PHP was compiled against GD-1.8 or + later. </para> </note> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagewbmp</function>. + <simplelist> + <member><function>imagewbmp</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagealphablending.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/image/functions/imagealphablending.xml diff -u phpdoc/en/reference/image/functions/imagealphablending.xml:1.7 phpdoc/en/reference/image/functions/imagealphablending.xml:1.8 --- phpdoc/en/reference/image/functions/imagealphablending.xml:1.7 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagealphablending.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.imagealphablending"> <refnamediv> <refname>imagealphablending</refname> <refpurpose>Set the blending mode for an image</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagealphablending</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -23,10 +23,32 @@ non-blending mode, the drawing color is copied literally with its alpha channel information, replacing the destination pixel. Blending mode is not available when drawing on palette images. - If <parameter>blendmode</parameter> is &true;, then blending mode is enabled, otherwise - disabled. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>blendmode</parameter></term> + <listitem> + <para> + Wether to enable the blending mode or not. Default to &false;. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> &return.success; </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.gd.2; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imageantialias.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/image/functions/imageantialias.xml diff -u phpdoc/en/reference/image/functions/imageantialias.xml:1.8 phpdoc/en/reference/image/functions/imageantialias.xml:1.9 --- phpdoc/en/reference/image/functions/imageantialias.xml:1.8 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imageantialias.xml Sun Jan 14 03:15:21 2007 @@ -1,34 +1,64 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.imageantialias"> <refnamediv> <refname>imageantialias</refname> <refpurpose>Should antialias functions be used or not</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imageantialias</methodname> - <methodparam><type>resource</type><parameter>im</parameter></methodparam> + <methodparam><type>resource</type><parameter>image</parameter></methodparam> <methodparam><type>bool</type><parameter>on</parameter></methodparam> </methodsynopsis> <para> - Activate the fast drawing antialiased methods for lines and wired polygons. - It does not support alpha components. It works using a direct blend - operation. It works only with truecolor images. + Activate the fast drawing antialiased methods for lines and wired polygons. + It does not support alpha components. It works using a direct blend + operation. It works only with truecolor images. </para> <para> - Thickness and styled are not supported. + Thickness and styled are not supported. </para> <para> - Using antialiased primitives with transparent background color can end with - some unexpected results. The blend method uses the background color as any - other colors. The lack of alpha component support does not allow an alpha - based antialiasing method. + Using antialiased primitives with transparent background color can end with + some unexpected results. The blend method uses the background color as any + other colors. The lack of alpha component support does not allow an alpha + based antialiasing method. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>on</parameter></term> + <listitem> + <para> + Wether to enable antialiasing or not. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.bundled.gd; + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecreatetruecolor</function>. + <simplelist> + <member><function>imagecreatetruecolor</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagearc.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/image/functions/imagearc.xml diff -u phpdoc/en/reference/image/functions/imagearc.xml:1.10 phpdoc/en/reference/image/functions/imagearc.xml:1.11 --- phpdoc/en/reference/image/functions/imagearc.xml:1.10 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagearc.xml Sun Jan 14 03:15:21 2007 @@ -1,37 +1,107 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <refentry id="function.imagearc"> <refnamediv> <refname>imagearc</refname> - <refpurpose>Draw a partial ellipse</refpurpose> + <refpurpose>Draws an arc</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagearc</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> <methodparam><type>int</type><parameter>cx</parameter></methodparam> <methodparam><type>int</type><parameter>cy</parameter></methodparam> - <methodparam><type>int</type><parameter>w</parameter></methodparam> - <methodparam><type>int</type><parameter>h</parameter></methodparam> - <methodparam><type>int</type><parameter>s</parameter></methodparam> - <methodparam><type>int</type><parameter>e</parameter></methodparam> + <methodparam><type>int</type><parameter>width</parameter></methodparam> + <methodparam><type>int</type><parameter>height</parameter></methodparam> + <methodparam><type>int</type><parameter>start</parameter></methodparam> + <methodparam><type>int</type><parameter>end</parameter></methodparam> <methodparam><type>int</type><parameter>color</parameter></methodparam> </methodsynopsis> <para> - <function>imagearc</function> draws a partial ellipse centered at - <parameter>cx</parameter>, <parameter>cy</parameter> (top left is - 0, 0) in the image represented by <parameter>image</parameter>. - <parameter>W</parameter> - and <parameter>h</parameter> specifies the ellipse's width and - height respectively while the start and end points are specified - in degrees indicated by the <parameter>s</parameter> and - <parameter>e</parameter> arguments. 0&deg; is located at the three-o'clock - position, and the arc is drawn clockwise. + <function>imagearc</function> draws an arc of circle centered at the given + coordinates. </para> - <example> - <title>Drawing a circle with <function>imagearc</function></title> - <programlisting role="php"> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>cx</parameter></term> + <listitem> + <para> + x-coordinate of the center + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>cy</parameter></term> + <listitem> + <para> + y-coordinate of the center + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The arc width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + The arc height + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>start</parameter></term> + <listitem> + <para> + The arc start angle, in degrees. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>end</parameter></term> + <listitem> + <para> + The arc end angle, in degrees. + 0&deg; is located at the three-o'clock position, and the arc is drawn + clockwise. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + A color identifier created with + <function>imagecolorallocate</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Drawing a circle with <function>imagearc</function></title> + <programlisting role="php"> <![CDATA[ <?php @@ -54,12 +124,18 @@ ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imageellipse</function>, - <function>imagefilledellipse</function>, and - <function>imagefilledarc</function>. + <simplelist> + <member><function>imagefilledarc</function></member> + <member><function>imageellipse</function></member> + <member><function>imagefilledellipse</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagechar.xml?r1=1.11&r2=1.12&diff_format=u Index: phpdoc/en/reference/image/functions/imagechar.xml diff -u phpdoc/en/reference/image/functions/imagechar.xml:1.11 phpdoc/en/reference/image/functions/imagechar.xml:1.12 --- phpdoc/en/reference/image/functions/imagechar.xml:1.11 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagechar.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> +<!-- $Revision: 1.12 $ --> <refentry id="function.imagechar"> <refnamediv> <refname>imagechar</refname> <refpurpose>Draw a character horizontally</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagechar</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -21,10 +21,59 @@ <parameter>c</parameter> in the image identified by <parameter>image</parameter> with its upper-left at <parameter>x</parameter>,<parameter>y</parameter> (top left is 0, - 0) with the color <parameter>color</parameter>. If <parameter>font</parameter> - is 1, 2, 3, 4 or 5, a built-in font is used (with higher numbers - corresponding to larger fonts). + 0) with the color <parameter>color</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + &gd.font.description; + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + x-coordinate of the start + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + y-coordinate of the start + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>c</parameter></term> + <listitem> + <para> + The character to draw + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + A color identifier created with + <function>imagecolorallocate</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imagechar</function> example</title> @@ -50,9 +99,14 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecharup</function> and - <function>imageloadfont</function>. + <simplelist> + <member><function>imagecharup</function></member> + <member><function>imageloadfont</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecharup.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/image/functions/imagecharup.xml diff -u phpdoc/en/reference/image/functions/imagecharup.xml:1.10 phpdoc/en/reference/image/functions/imagecharup.xml:1.11 --- phpdoc/en/reference/image/functions/imagecharup.xml:1.10 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecharup.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <refentry id="function.imagecharup"> <refnamediv> <refname>imagecharup</refname> <refpurpose>Draw a character vertically</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagecharup</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -17,14 +17,60 @@ <methodparam><type>int</type><parameter>color</parameter></methodparam> </methodsynopsis> <para> - <function>imagecharup</function> draws the character - <parameter>c</parameter> vertically in the image identified by - <parameter>image</parameter> at coordinates - <parameter>x</parameter>, <parameter>y</parameter> (top left is - 0, 0) with the color <parameter>color</parameter>. - If <parameter>font</parameter> is 1, 2, 3, 4 or 5, a built-in font is - used. + Draws the character <parameter>c</parameter> vertically at the specified + coordinate on the given <parameter>image</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + &gd.font.description; + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + x-coordinate of the start + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + y-coordinate of the start + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>c</parameter></term> + <listitem> + <para> + The character to draw + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + A color identifier created with + <function>imagecolorallocate</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imagecharup</function> example</title> @@ -50,9 +96,14 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagechar</function> and - <function>imageloadfont</function>. + <simplelist> + <member><function>imagechar</function></member> + <member><function>imageloadfont</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecolorallocate.xml?r1=1.12&r2=1.13&diff_format=u Index: phpdoc/en/reference/image/functions/imagecolorallocate.xml diff -u phpdoc/en/reference/image/functions/imagecolorallocate.xml:1.12 phpdoc/en/reference/image/functions/imagecolorallocate.xml:1.13 --- phpdoc/en/reference/image/functions/imagecolorallocate.xml:1.12 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecolorallocate.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.12 $ --> +<!-- $Revision: 1.13 $ --> <refentry id="function.imagecolorallocate"> <refnamediv> <refname>imagecolorallocate</refname> <refpurpose>Allocate a color for an image</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imagecolorallocate</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -15,13 +15,10 @@ <methodparam><type>int</type><parameter>blue</parameter></methodparam> </methodsynopsis> <para> - <function>imagecolorallocate</function> returns a color - identifier representing the color composed of the given + Returns a color identifier representing the color composed of the given <acronym>RGB</acronym> components. - <parameter>red</parameter>, <parameter>green</parameter> and - <parameter>blue</parameter> are the values of the red, green and blue - component of the requested color respectively. These parameters are - integers between 0 and 255 or hexadecimals between 0x00 and 0xFF. + </para> + <para> <function>imagecolorallocate</function> must be called to create each color that is to be used in the image represented by <parameter>image</parameter>. @@ -33,6 +30,49 @@ <function>imagecreate</function>. </para> </note> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>red</parameter></term> + <listitem> + <para> + Value of red component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>green</parameter></term> + <listitem> + <para> + Value of green component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>blue</parameter></term> + <listitem> + <para> + Value of blue component + </para> + </listitem> + </varlistentry> + </variablelist> + These parameters are integers between 0 and 255 or hexadecimals between + 0x00 and 0xFF. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + A color identifier or -1 if the allocation failed. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imagecolorallocate</function> example</title> @@ -58,12 +98,14 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - Returns -1 if the allocation failed. - </para> - <para> - See also <function>imagecolorallocatealpha</function> and - <function>imagecolordeallocate</function>. + <simplelist> + <member><function>imagecolorallocatealpha</function></member> + <member><function>imagecolordeallocate</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecolorallocatealpha.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/image/functions/imagecolorallocatealpha.xml diff -u phpdoc/en/reference/image/functions/imagecolorallocatealpha.xml:1.7 phpdoc/en/reference/image/functions/imagecolorallocatealpha.xml:1.8 --- phpdoc/en/reference/image/functions/imagecolorallocatealpha.xml:1.7 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecolorallocatealpha.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.imagecolorallocatealpha"> <refnamediv> <refname>imagecolorallocatealpha</refname> <refpurpose>Allocate a color for an image</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imagecolorallocatealpha</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -18,14 +18,61 @@ <para> <function>imagecolorallocatealpha</function> behaves identically to <function>imagecolorallocate</function> with the addition of the transparency - parameter <parameter>alpha</parameter> which may have a value between - <literal>0</literal> and <literal>127</literal>. <literal>0</literal> - indicates completely opaque while <literal>127</literal> indicates - completely transparent. + parameter <parameter>alpha</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Returns &false; if the allocation failed. + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>red</parameter></term> + <listitem> + <para> + Value of red component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>green</parameter></term> + <listitem> + <para> + Value of green component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>blue</parameter></term> + <listitem> + <para> + Value of blue component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>alpha</parameter></term> + <listitem> + <para> + A value between <literal>0</literal> and <literal>127</literal>. + <literal>0</literal> indicates completely opaque while + <literal>127</literal> indicates completely transparent. + </para> + </listitem> + </varlistentry> + </variablelist> + The colors parameters are integers between 0 and 255 or hexadecimals + between 0x00 and 0xFF. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + A color identifier or &false; if the allocation failed. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Example of using <function>imagecolorallocatealpha</function></title> @@ -70,10 +117,18 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.gd.2; + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecolorallocate</function> and - <function>imagecolordeallocate</function>. + <simplelist> + <member><function>imagecolorallocate</function></member> + <member><function>imagecolordeallocate</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecolorat.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagecolorat.xml diff -u phpdoc/en/reference/image/functions/imagecolorat.xml:1.5 phpdoc/en/reference/image/functions/imagecolorat.xml:1.6 --- phpdoc/en/reference/image/functions/imagecolorat.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecolorat.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagecolorat"> <refnamediv> <refname>imagecolorat</refname> <refpurpose>Get the index of the color of a pixel</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imagecolorat</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -22,6 +22,41 @@ truecolor image, this function returns the RGB value of that pixel as integer. Use bitshifting and masking to access the distinct red, green and blue component values: + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + x-coordinate of the point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + y-coordinate of the point + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the index of the color. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> <example> <title>Access distinct RGB values</title> <programlisting role="php"> @@ -37,9 +72,14 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecolorset</function> and - <function>imagecolorsforindex</function>. + <simplelist> + <member><function>imagecolorset</function></member> + <member><function>imagecolorsforindex</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecolorclosest.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagecolorclosest.xml diff -u phpdoc/en/reference/image/functions/imagecolorclosest.xml:1.5 phpdoc/en/reference/image/functions/imagecolorclosest.xml:1.6 --- phpdoc/en/reference/image/functions/imagecolorclosest.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecolorclosest.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagecolorclosest"> <refnamediv> <refname>imagecolorclosest</refname> <refpurpose>Get the index of the closest color to the specified color</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imagecolorclosest</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -27,8 +27,54 @@ If you created the image from a file, only colors used in the image are resolved. Colors present only in the pallete are not resolved. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>red</parameter></term> + <listitem> + <para> + Value of red component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>green</parameter></term> + <listitem> + <para> + Value of green component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>blue</parameter></term> + <listitem> + <para> + Value of blue component + </para> + </listitem> + </varlistentry> + </variablelist> + The colors parameters are integers between 0 and 255 or hexadecimals + between 0x00 and 0xFF. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the index of the closest color, in the palette of the image, to + the specified one + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecolorexact</function>. + <simplelist> + <member><function>imagecolorexact</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecolorclosestalpha.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/image/functions/imagecolorclosestalpha.xml diff -u phpdoc/en/reference/image/functions/imagecolorclosestalpha.xml:1.6 phpdoc/en/reference/image/functions/imagecolorclosestalpha.xml:1.7 --- phpdoc/en/reference/image/functions/imagecolorclosestalpha.xml:1.6 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecolorclosestalpha.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imagecolorclosestalpha"> <refnamediv> <refname>imagecolorclosestalpha</refname> <refpurpose>Get the index of the closest color to the specified color + alpha</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imagecolorclosestalpha</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -17,11 +17,70 @@ </methodsynopsis> <para> Returns the index of the color in the palette of the image which - is "closest" to the specified <acronym>RGB</acronym> value and <parameter>alpha</parameter> level. + is "closest" to the specified <acronym>RGB</acronym> value and + <parameter>alpha</parameter> level. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>red</parameter></term> + <listitem> + <para> + Value of red component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>green</parameter></term> + <listitem> + <para> + Value of green component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>blue</parameter></term> + <listitem> + <para> + Value of blue component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>alpha</parameter></term> + <listitem> + <para> + A value between <literal>0</literal> and <literal>127</literal>. + <literal>0</literal> indicates completely opaque while + <literal>127</literal> indicates completely transparent. + </para> + </listitem> + </varlistentry> + </variablelist> + The colors parameters are integers between 0 and 255 or hexadecimals + between 0x00 and 0xFF. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the index of the closest color in the palette. + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.gd.2; + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecolorexactalpha</function>. + <simplelist> + <member><function>imagecolorexactalpha</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecolorclosesthwb.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/image/functions/imagecolorclosesthwb.xml diff -u phpdoc/en/reference/image/functions/imagecolorclosesthwb.xml:1.4 phpdoc/en/reference/image/functions/imagecolorclosesthwb.xml:1.5 --- phpdoc/en/reference/image/functions/imagecolorclosesthwb.xml:1.4 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecolorclosesthwb.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id='function.imagecolorclosesthwb'> <refnamediv> <refname>imagecolorclosesthwb</refname> <refpurpose>Get the index of the color which has the hue, white and blackness nearest to the given color</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imagecolorclosesthwb</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -14,8 +14,38 @@ <methodparam><type>int</type><parameter>green</parameter></methodparam> <methodparam><type>int</type><parameter>blue</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>red</parameter></term> + <listitem> + <para> + Value of red component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>green</parameter></term> + <listitem> + <para> + Value of green component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>blue</parameter></term> + <listitem> + <para> + Value of blue component + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecolordeallocate.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/image/functions/imagecolordeallocate.xml diff -u phpdoc/en/reference/image/functions/imagecolordeallocate.xml:1.8 phpdoc/en/reference/image/functions/imagecolordeallocate.xml:1.9 --- phpdoc/en/reference/image/functions/imagecolordeallocate.xml:1.8 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecolordeallocate.xml Sun Jan 14 03:15:21 2007 @@ -1,23 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.imagecolordeallocate"> <refnamediv> <refname>imagecolordeallocate</refname> <refpurpose>De-allocate a color for an image</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagecolordeallocate</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> <methodparam><type>int</type><parameter>color</parameter></methodparam> </methodsynopsis> <para> - The <function>imagecolordeallocate</function> function - de-allocates a color previously allocated with + De-allocates a color previously allocated with <function>imagecolorallocate</function> or <function>imagecolorallocatealpha</function>. - <informalexample> + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + The color identifier + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Using <function>imagecolordeallocate</function></title> <programlisting role="php"> <![CDATA[ <?php @@ -26,11 +53,16 @@ ?> ]]> </programlisting> - </informalexample> + </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecolorallocate</function> and - <function>imagecolorallocatealpha</function>. + <simplelist> + <member><function>imagecolorallocate</function></member> + <member><function>imagecolorallocatealpha</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecolorexact.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagecolorexact.xml diff -u phpdoc/en/reference/image/functions/imagecolorexact.xml:1.5 phpdoc/en/reference/image/functions/imagecolorexact.xml:1.6 --- phpdoc/en/reference/image/functions/imagecolorexact.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecolorexact.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagecolorexact"> <refnamediv> <refname>imagecolorexact</refname> <refpurpose>Get the index of the specified color</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imagecolorexact</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -19,15 +19,55 @@ image. </para> <para> - If the color does not exist in the image's palette, -1 is - returned. - </para> - <para> If you created the image from a file, only colors used in the image are resolved. Colors present only in the pallete are not resolved. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>red</parameter></term> + <listitem> + <para> + Value of red component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>green</parameter></term> + <listitem> + <para> + Value of green component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>blue</parameter></term> + <listitem> + <para> + Value of blue component + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the index of the specified color in the palette, or -1 if the + color does not exist. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecolorclosest</function>. + <simplelist> + <member><function>imagecolorclosest</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecolorexactalpha.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagecolorexactalpha.xml diff -u phpdoc/en/reference/image/functions/imagecolorexactalpha.xml:1.5 phpdoc/en/reference/image/functions/imagecolorexactalpha.xml:1.6 --- phpdoc/en/reference/image/functions/imagecolorexactalpha.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecolorexactalpha.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagecolorexactalpha"> <refnamediv> <refname>imagecolorexactalpha</refname> <refpurpose>Get the index of the specified color + alpha</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imagecolorexactalpha</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -19,13 +19,68 @@ Returns the index of the specified color+alpha in the palette of the image. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - If the color does not exist in the image's palette, -1 is - returned. + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>red</parameter></term> + <listitem> + <para> + Value of red component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>green</parameter></term> + <listitem> + <para> + Value of green component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>blue</parameter></term> + <listitem> + <para> + Value of blue component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>alpha</parameter></term> + <listitem> + <para> + A value between <literal>0</literal> and <literal>127</literal>. + <literal>0</literal> indicates completely opaque while + <literal>127</literal> indicates completely transparent. + </para> + </listitem> + </varlistentry> + </variablelist> + The colors parameters are integers between 0 and 255 or hexadecimals + between 0x00 and 0xFF. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the index of the specified color+alpha in the palette of the + image, or -1 if the color does not exist in the image's palette. + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.gd.2; + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecolorclosestalpha</function>. + <simplelist> + <member><function>imagecolorclosestalpha</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecolormatch.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagecolormatch.xml diff -u phpdoc/en/reference/image/functions/imagecolormatch.xml:1.5 phpdoc/en/reference/image/functions/imagecolormatch.xml:1.6 --- phpdoc/en/reference/image/functions/imagecolormatch.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecolormatch.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagecolormatch"> <refnamediv> <refname>imagecolormatch</refname> <refpurpose>Makes the colors of the palette version of an image more closely match the true color version</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagecolormatch</methodname> <methodparam><type>resource</type><parameter>image1</parameter></methodparam> @@ -15,19 +15,48 @@ &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>image1</parameter> must be Truecolor, - <parameter>image2</parameter> must be Palette, and - both <parameter>image1</parameter> and <parameter>image2</parameter> - must be the same size. + <variablelist> + <varlistentry> + <term><parameter>image1</parameter></term> + <listitem> + <para> + A truecolor image link resource + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>image2</parameter></term> + <listitem> + <para> + A palette image link resource pointing to an image that has the same + size as <parameter>image1</parameter> + </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> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecreatetruecolor</function>. + <simplelist> + <member><function>imagecreatetruecolor</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecolorresolve.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagecolorresolve.xml diff -u phpdoc/en/reference/image/functions/imagecolorresolve.xml:1.5 phpdoc/en/reference/image/functions/imagecolorresolve.xml:1.6 --- phpdoc/en/reference/image/functions/imagecolorresolve.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecolorresolve.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagecolorresolve"> <refnamediv> <refname>imagecolorresolve</refname> <refpurpose>Get the index of the specified color or its closest possible alternative</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imagecolorresolve</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -23,8 +23,51 @@ If you created the image from a file, only colors used in the image are resolved. Colors present only in the pallete are not resolved. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>red</parameter></term> + <listitem> + <para> + Value of red component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>green</parameter></term> + <listitem> + <para> + Value of green component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>blue</parameter></term> + <listitem> + <para> + Value of blue component + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a color index. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecolorclosest</function>. + <simplelist> + <member><function>imagecolorclosest</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecolorresolvealpha.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagecolorresolvealpha.xml diff -u phpdoc/en/reference/image/functions/imagecolorresolvealpha.xml:1.5 phpdoc/en/reference/image/functions/imagecolorresolvealpha.xml:1.6 --- phpdoc/en/reference/image/functions/imagecolorresolvealpha.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecolorresolvealpha.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagecolorresolvealpha"> <refnamediv> <refname>imagecolorresolvealpha</refname> <refpurpose>Get the index of the specified color + alpha or its closest possible alternative</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imagecolorresolvealpha</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -20,9 +20,67 @@ requested color, either the exact color or the closest possible alternative. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>red</parameter></term> + <listitem> + <para> + Value of red component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>green</parameter></term> + <listitem> + <para> + Value of green component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>blue</parameter></term> + <listitem> + <para> + Value of blue component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>alpha</parameter></term> + <listitem> + <para> + A value between <literal>0</literal> and <literal>127</literal>. + <literal>0</literal> indicates completely opaque while + <literal>127</literal> indicates completely transparent. + </para> + </listitem> + </varlistentry> + </variablelist> + The colors parameters are integers between 0 and 255 or hexadecimals + between 0x00 and 0xFF. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a color index. + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.gd.2; + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecolorclosestalpha</function>. + <simplelist> + <member><function>imagecolorclosestalpha</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecolorset.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/image/functions/imagecolorset.xml diff -u phpdoc/en/reference/image/functions/imagecolorset.xml:1.6 phpdoc/en/reference/image/functions/imagecolorset.xml:1.7 --- phpdoc/en/reference/image/functions/imagecolorset.xml:1.6 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecolorset.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imagecolorset"> <refnamediv> <refname>imagecolorset</refname> <refpurpose>Set the color for the specified palette index</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>imagecolorset</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -21,8 +21,59 @@ palleted images without the overhead of performing the actual flood-fill. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>index</parameter></term> + <listitem> + <para> + An index in the palette + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>red</parameter></term> + <listitem> + <para> + Value of red component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>green</parameter></term> + <listitem> + <para> + Value of green component + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>blue</parameter></term> + <listitem> + <para> + Value of blue component + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecolorat</function>. + <simplelist> + <member><function>imagecolorat</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecolorsforindex.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagecolorsforindex.xml diff -u phpdoc/en/reference/image/functions/imagecolorsforindex.xml:1.5 phpdoc/en/reference/image/functions/imagecolorsforindex.xml:1.6 --- phpdoc/en/reference/image/functions/imagecolorsforindex.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecolorsforindex.xml Sun Jan 14 03:15:21 2007 @@ -1,22 +1,45 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagecolorsforindex"> <refnamediv> <refname>imagecolorsforindex</refname> <refpurpose>Get the colors for an index</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imagecolorsforindex</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> <methodparam><type>int</type><parameter>index</parameter></methodparam> </methodsynopsis> <para> - This returns an associative array with red, green, blue and alpha - keys that contain the appropriate values for the specified color - index. + Gets the color for a specified index. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>index</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an associative array with red, green, blue and alpha keys that + contain the appropriate values for the specified color index. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imagecolorsforindex</function> example</title> @@ -36,16 +59,12 @@ $color_tran = imagecolorsforindex($im, $color_index); // what is it ? -echo '<pre>'; print_r($color_tran); -echo '</pre>'; ?> ]]> </programlisting> - <para> - This example will output : - </para> + &example.outputs.similar; <screen> <![CDATA[ Array @@ -59,9 +78,14 @@ </screen> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecolorat</function> and - <function>imagecolorexact</function>. + <simplelist> + <member><function>imagecolorat</function></member> + <member><function>imagecolorexact</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecolorstotal.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagecolorstotal.xml diff -u phpdoc/en/reference/image/functions/imagecolorstotal.xml:1.5 phpdoc/en/reference/image/functions/imagecolorstotal.xml:1.6 --- phpdoc/en/reference/image/functions/imagecolorstotal.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecolorstotal.xml Sun Jan 14 03:15:21 2007 @@ -1,23 +1,43 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagecolorstotal"> <refnamediv> <refname>imagecolorstotal</refname> <refpurpose>Find out the number of colors in an image's palette</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imagecolorstotal</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> </methodsynopsis> <para> - This returns the number of colors in the specified image's - palette or 0 for truecolor images. + Returns the number of colors in an image palette. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of colors in the specified image's palette or 0 for + truecolor images. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecolorat</function> and - <function>imagecolorsforindex</function>, <function>imageistruecolor</function>. + <simplelist> + <member><function>imagecolorat</function></member> + <member><function>imagecolorsforindex</function></member> + <member><function>imageistruecolor</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecolortransparent.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/image/functions/imagecolortransparent.xml diff -u phpdoc/en/reference/image/functions/imagecolortransparent.xml:1.8 phpdoc/en/reference/image/functions/imagecolortransparent.xml:1.9 --- phpdoc/en/reference/image/functions/imagecolortransparent.xml:1.8 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecolortransparent.xml Sun Jan 14 03:15:21 2007 @@ -1,43 +1,61 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.imagecolortransparent"> <refnamediv> <refname>imagecolortransparent</refname> <refpurpose>Define a color as transparent</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imagecolortransparent</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>color</parameter></methodparam> </methodsynopsis> <para> - <function>imagecolortransparent</function> sets the transparent - color in the <parameter>image</parameter> image to - <parameter>color</parameter>. <parameter>image</parameter> is the - image identifier returned by <function>imagecreatetruecolor</function> and - <parameter>color</parameter> is a color identifier returned by - <function>imagecolorallocate</function>. + Sets the transparent color in the given <parameter>image</parameter>. </para> - <note> - <para> - The transparent color is a property of the image, transparency is not a - property of the color. Once you have set a color to be the transparent - color, any regions of the image in that color that were drawn previously - will be transparent. - </para> - </note> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + A color identifier created with + <function>imagecolorallocate</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> The identifier of the new (or current, if none is specified) transparent color is returned. </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; <note> <para> Transparency is copied only with <function>imagecopymerge</function> and true color images, not with <function>imagecopy</function> or pallete images. </para> </note> + <note> + <para> + The transparent color is a property of the image, transparency is not a + property of the color. Once you have set a color to be the transparent + color, any regions of the image in that color that were drawn previously + will be transparent. + </para> + </note> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imageconvolution.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/image/functions/imageconvolution.xml diff -u phpdoc/en/reference/image/functions/imageconvolution.xml:1.2 phpdoc/en/reference/image/functions/imageconvolution.xml:1.3 --- phpdoc/en/reference/image/functions/imageconvolution.xml:1.2 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imageconvolution.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.imageconvolution"> <refnamediv> <refname>imageconvolution</refname> <refpurpose>Apply a 3x3 convolution matrix, using coefficient div and offset</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imageconvolution</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -14,10 +14,45 @@ <methodparam><type>float</type><parameter>div</parameter></methodparam> <methodparam><type>float</type><parameter>offset</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>matrix3x3</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>div</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>offset</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> - &warn.undocumented.func; + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.bundled.gd; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecopy.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/image/functions/imagecopy.xml diff -u phpdoc/en/reference/image/functions/imagecopy.xml:1.4 phpdoc/en/reference/image/functions/imagecopy.xml:1.5 --- phpdoc/en/reference/image/functions/imagecopy.xml:1.4 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecopy.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.imagecopy"> <refnamediv> <refname>imagecopy</refname> <refpurpose>Copy part of an image</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagecopy</methodname> <methodparam><type>resource</type><parameter>dst_im</parameter></methodparam> @@ -28,6 +28,83 @@ <parameter>dst_y</parameter>. </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dst_im</parameter></term> + <listitem> + <para> + Destination image link resource + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_im</parameter></term> + <listitem> + <para> + Source image link resource + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dst_x</parameter></term> + <listitem> + <para> + x-coordinate of destination point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dst_y</parameter></term> + <listitem> + <para> + y-coordinate of destination point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_x</parameter></term> + <listitem> + <para> + x-coordinate of source point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_y</parameter></term> + <listitem> + <para> + y-coordinate of source point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_w</parameter></term> + <listitem> + <para> + Source width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_h</parameter></term> + <listitem> + <para> + Source height + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecopymerge.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagecopymerge.xml diff -u phpdoc/en/reference/image/functions/imagecopymerge.xml:1.5 phpdoc/en/reference/image/functions/imagecopymerge.xml:1.6 --- phpdoc/en/reference/image/functions/imagecopymerge.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecopymerge.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagecopymerge"> <refnamediv> <refname>imagecopymerge</refname> <refpurpose>Copy and merge part of an image</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagecopymerge</methodname> <methodparam><type>resource</type><parameter>dst_im</parameter></methodparam> @@ -27,13 +27,96 @@ <parameter>src_h</parameter>. The portion defined will be copied onto the x,y coordinates, <parameter>dst_x</parameter> and <parameter>dst_y</parameter>. - The two images will be merged according to <parameter>pct</parameter> - which can range from 0 to 100. When <parameter>pct</parameter> = 0, - no action is taken, when 100 this function behaves identically - to <function>imagecopy</function> for pallete images, while it - implements alpha transparency for true colour images. </para> - <note><para>This function was added in PHP 4.0.6</para></note> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dst_im</parameter></term> + <listitem> + <para> + Destination image link resource + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_im</parameter></term> + <listitem> + <para> + Source image link resource + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dst_x</parameter></term> + <listitem> + <para> + x-coordinate of destination point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dst_y</parameter></term> + <listitem> + <para> + y-coordinate of destination point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_x</parameter></term> + <listitem> + <para> + x-coordinate of source point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_y</parameter></term> + <listitem> + <para> + y-coordinate of source point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_w</parameter></term> + <listitem> + <para> + Source width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_h</parameter></term> + <listitem> + <para> + Source height + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>pct</parameter></term> + <listitem> + <para> + The two images will be merged according to <parameter>pct</parameter> + which can range from 0 to 100. When <parameter>pct</parameter> = 0, + no action is taken, when 100 this function behaves identically + to <function>imagecopy</function> for pallete images, while it + implements alpha transparency for true colour images. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecopymergegray.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagecopymergegray.xml diff -u phpdoc/en/reference/image/functions/imagecopymergegray.xml:1.5 phpdoc/en/reference/image/functions/imagecopymergegray.xml:1.6 --- phpdoc/en/reference/image/functions/imagecopymergegray.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecopymergegray.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagecopymergegray"> <refnamediv> <refname>imagecopymergegray</refname> <refpurpose>Copy and merge part of an image with gray scale</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagecopymergegray</methodname> <methodparam><type>resource</type><parameter>dst_im</parameter></methodparam> @@ -27,17 +27,101 @@ <parameter>src_h</parameter>. The portion defined will be copied onto the x,y coordinates, <parameter>dst_x</parameter> and <parameter>dst_y</parameter>. - The two images will be merged according to <parameter>pct</parameter> - which can range from 0 to 100. When <parameter>pct</parameter> = 0, - no action is taken, when 100 this function behaves identically - to <function>imagecopy</function>. </para> <para> This function is identical to <function>imagecopymerge</function> except that when merging it preserves the hue of the source by converting the destination pixels to gray scale before the copy operation. </para> - <note><para>This function was added in PHP 4.0.6</para></note> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dst_im</parameter></term> + <listitem> + <para> + Destination image link resource + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_im</parameter></term> + <listitem> + <para> + Source image link resource + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dst_x</parameter></term> + <listitem> + <para> + x-coordinate of destination point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dst_y</parameter></term> + <listitem> + <para> + y-coordinate of destination point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_x</parameter></term> + <listitem> + <para> + x-coordinate of source point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_y</parameter></term> + <listitem> + <para> + y-coordinate of source point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_w</parameter></term> + <listitem> + <para> + Source width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_h</parameter></term> + <listitem> + <para> + Source height + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>pct</parameter></term> + <listitem> + <para> + The two images will be merged according to <parameter>pct</parameter> + which can range from 0 to 100. When <parameter>pct</parameter> = 0, + no action is taken, when 100 this function behaves identically + to <function>imagecopy</function> for pallete images, while it + implements alpha transparency for true colour images. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecopyresampled.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/image/functions/imagecopyresampled.xml diff -u phpdoc/en/reference/image/functions/imagecopyresampled.xml:1.8 phpdoc/en/reference/image/functions/imagecopyresampled.xml:1.9 --- phpdoc/en/reference/image/functions/imagecopyresampled.xml:1.8 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecopyresampled.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.imagecopyresampled"> <refnamediv> <refname>imagecopyresampled</refname> <refpurpose>Copy and resize part of an image with resampling</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagecopyresampled</methodname> <methodparam><type>resource</type><parameter>dst_image</parameter></methodparam> @@ -25,12 +25,9 @@ portion of one image to another image, smoothly interpolating pixel values so that, in particular, reducing the size of an image still retains a great deal of clarity. - &return.success; </para> <para> - <parameter>dst_image</parameter> is the destination image, - <parameter>src_image</parameter> is the source image identifier. If - the source and destination coordinates and width and heights + If the source and destination coordinates and width and heights differ, appropriate stretching or shrinking of the image fragment will be performed. The coordinates refer to the upper left corner. This function can be used to copy regions within the @@ -38,25 +35,102 @@ <parameter>src_image</parameter>) but if the regions overlap the results will be unpredictable. </para> - <note> - <para> - There is a problem due to palette image limitations (255+1 colors). - Resampling or filtering an image commonly needs more colors than 255, a - kind of approximation is used to calculate the new resampled pixel and its - color. With a palette image we try to allocate a new color, if that - failed, we choose the closest (in theory) computed color. This is - not always the closest visual color. That may produce a weird result, like - blank (or visually blank) images. To skip this problem, please use a - truecolor image as a destination image, such as one created by - <function>imagecreatetruecolor</function>. - </para> - </note> - &note.gd.2; </refsect1> - - <refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dst_im</parameter></term> + <listitem> + <para> + Destination image link resource + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_im</parameter></term> + <listitem> + <para> + Source image link resource + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dst_x</parameter></term> + <listitem> + <para> + x-coordinate of destination point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dst_y</parameter></term> + <listitem> + <para> + y-coordinate of destination point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_x</parameter></term> + <listitem> + <para> + x-coordinate of source point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_y</parameter></term> + <listitem> + <para> + y-coordinate of source point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dst_w</parameter></term> + <listitem> + <para> + Destination width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dst_h</parameter></term> + <listitem> + <para> + Destination height + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_w</parameter></term> + <listitem> + <para> + Source width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_h</parameter></term> + <listitem> + <para> + Source height + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> &reftitle.examples; - <para> <example> <title>Simple example</title> @@ -90,7 +164,6 @@ </programlisting> </example> </para> - <para> <example> <title>Resampling an image proportionally</title> @@ -135,8 +208,23 @@ </example> </para> </refsect1> - - <refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + There is a problem due to palette image limitations (255+1 colors). + Resampling or filtering an image commonly needs more colors than 255, a + kind of approximation is used to calculate the new resampled pixel and its + color. With a palette image we try to allocate a new color, if that + failed, we choose the closest (in theory) computed color. This is + not always the closest visual color. That may produce a weird result, like + blank (or visually blank) images. To skip this problem, please use a + truecolor image as a destination image, such as one created by + <function>imagecreatetruecolor</function>. + </para> + </note> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> <function>imagecopyresized</function> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecopyresized.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/image/functions/imagecopyresized.xml diff -u phpdoc/en/reference/image/functions/imagecopyresized.xml:1.7 phpdoc/en/reference/image/functions/imagecopyresized.xml:1.8 --- phpdoc/en/reference/image/functions/imagecopyresized.xml:1.7 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecopyresized.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.imagecopyresized"> <refnamediv> <refname>imagecopyresized</refname> <refpurpose>Copy and resize part of an image</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagecopyresized</methodname> <methodparam><type>resource</type><parameter>dst_image</parameter></methodparam> @@ -33,22 +33,101 @@ <parameter>src_image</parameter>) but if the regions overlap the results will be unpredictable. </para> - <note> - <para> - There is a problem due to palette image limitations (255+1 colors). - Resampling or filtering an image commonly needs more colors than 255, a - kind of approximation is used to calculate the new resampled pixel and its - color. With a palette image we try to allocate a new color, if that - failed, we choose the closest (in theory) computed color. This is - not always the closest visual color. That may produce a weird result, like - blank (or visually blank) images. To skip this problem, please use a - truecolor image as a destination image, such as one created by - <function>imagecreatetruecolor</function>. - </para> - </note> </refsect1> - - <refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dst_im</parameter></term> + <listitem> + <para> + Destination image link resource + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_im</parameter></term> + <listitem> + <para> + Source image link resource + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dst_x</parameter></term> + <listitem> + <para> + x-coordinate of destination point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dst_y</parameter></term> + <listitem> + <para> + y-coordinate of destination point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_x</parameter></term> + <listitem> + <para> + x-coordinate of source point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_y</parameter></term> + <listitem> + <para> + y-coordinate of source point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dst_w</parameter></term> + <listitem> + <para> + Destination width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dst_h</parameter></term> + <listitem> + <para> + Destination height + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_w</parameter></term> + <listitem> + <para> + Source width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>src_h</parameter></term> + <listitem> + <para> + Source height + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> <example> @@ -90,8 +169,23 @@ </example> </para> </refsect1> - - <refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + There is a problem due to palette image limitations (255+1 colors). + Resampling or filtering an image commonly needs more colors than 255, a + kind of approximation is used to calculate the new resampled pixel and its + color. With a palette image we try to allocate a new color, if that + failed, we choose the closest (in theory) computed color. This is + not always the closest visual color. That may produce a weird result, like + blank (or visually blank) images. To skip this problem, please use a + truecolor image as a destination image, such as one created by + <function>imagecreatetruecolor</function>. + </para> + </note> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> <function>imagecopyresampled</function> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecreate.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/image/functions/imagecreate.xml diff -u phpdoc/en/reference/image/functions/imagecreate.xml:1.9 phpdoc/en/reference/image/functions/imagecreate.xml:1.10 --- phpdoc/en/reference/image/functions/imagecreate.xml:1.9 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecreate.xml Sun Jan 14 03:15:21 2007 @@ -1,25 +1,56 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <refentry id="function.imagecreate"> <refnamediv> <refname>imagecreate</refname> <refpurpose>Create a new palette based image</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>imagecreate</methodname> - <methodparam><type>int</type><parameter>x_size</parameter></methodparam> - <methodparam><type>int</type><parameter>y_size</parameter></methodparam> + <methodparam><type>int</type><parameter>width</parameter></methodparam> + <methodparam><type>int</type><parameter>height</parameter></methodparam> </methodsynopsis> <para> <function>imagecreate</function> returns an image identifier - representing a blank image of size <parameter>x_size</parameter> - by <parameter>y_size</parameter>. + representing a blank image of specified size. </para> <para> We recommend the use of <function>imagecreatetruecolor</function>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The image width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + The image height + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an image resource identifier on success, &false; on errors. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title> @@ -41,9 +72,14 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagedestroy</function> and - <function>imagecreatetruecolor</function>. + <simplelist> + <member><function>imagedestroy</function></member> + <member><function>imagecreatetruecolor</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecreatefromgd.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagecreatefromgd.xml diff -u phpdoc/en/reference/image/functions/imagecreatefromgd.xml:1.5 phpdoc/en/reference/image/functions/imagecreatefromgd.xml:1.6 --- phpdoc/en/reference/image/functions/imagecreatefromgd.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecreatefromgd.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id='function.imagecreatefromgd'> <refnamediv> <refname>imagecreatefromgd</refname> <refpurpose>Create a new image from GD file or URL</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>imagecreatefromgd</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> @@ -15,6 +15,23 @@ &warn.undocumented.func; </para> &tip.fopen-wrapper; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &warn.no-win32-fopen-wrapper; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecreatefromgd2.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/image/functions/imagecreatefromgd2.xml diff -u phpdoc/en/reference/image/functions/imagecreatefromgd2.xml:1.6 phpdoc/en/reference/image/functions/imagecreatefromgd2.xml:1.7 --- phpdoc/en/reference/image/functions/imagecreatefromgd2.xml:1.6 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecreatefromgd2.xml Sun Jan 14 03:15:21 2007 @@ -1,21 +1,36 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id='function.imagecreatefromgd2'> <refnamediv> <refname>imagecreatefromgd2</refname> <refpurpose>Create a new image from GD2 file or URL</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>imagecreatefromgd2</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + &tip.fopen-wrapper; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.gd.2; - &tip.fopen-wrapper; &warn.no-win32-fopen-wrapper; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecreatefromgd2part.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/image/functions/imagecreatefromgd2part.xml diff -u phpdoc/en/reference/image/functions/imagecreatefromgd2part.xml:1.6 phpdoc/en/reference/image/functions/imagecreatefromgd2part.xml:1.7 --- phpdoc/en/reference/image/functions/imagecreatefromgd2part.xml:1.6 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecreatefromgd2part.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id='function.imagecreatefromgd2part'> <refnamediv> <refname>imagecreatefromgd2part</refname> <refpurpose>Create a new image from a given part of GD2 file or URL</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>imagecreatefromgd2part</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> @@ -15,11 +15,54 @@ <methodparam><type>int</type><parameter>width</parameter></methodparam> <methodparam><type>int</type><parameter>height</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + &tip.fopen-wrapper; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>srcX</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>srcY</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.gd.2; - &tip.fopen-wrapper; &warn.no-win32-fopen-wrapper; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecreatefromgif.xml?r1=1.14&r2=1.15&diff_format=u Index: phpdoc/en/reference/image/functions/imagecreatefromgif.xml diff -u phpdoc/en/reference/image/functions/imagecreatefromgif.xml:1.14 phpdoc/en/reference/image/functions/imagecreatefromgif.xml:1.15 --- phpdoc/en/reference/image/functions/imagecreatefromgif.xml:1.14 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecreatefromgif.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.14 $ --> +<!-- $Revision: 1.15 $ --> <refentry id="function.imagecreatefromgif"> <refnamediv> <refname>imagecreatefromgif</refname> <refpurpose>Create a new image from file or URL</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>imagecreatefromgif</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> @@ -16,10 +16,7 @@ representing the image obtained from the given filename. </para> <para> - <function>imagecreatefromgif</function> returns an empty string - on failure. It also outputs an error message, which unfortunately - displays as a broken link in a browser. To ease debugging the - following example will produce an error GIF: + To ease debugging the following example will produce an error GIF: <example> <title>Example to handle an error during creation</title> <programlisting role="php"> @@ -42,15 +39,39 @@ ]]> </programlisting> </example> - <note> - <para> - GIF support was removed from the GD library in Version 1.6, - and added back in Version 2.0.28. This function is not - available between these versions. - </para> - </note> </para> &tip.fopen-wrapper; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + Path to the WBMP image + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an image resource identifier on success, &false; on errors. + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + GIF support was removed from the GD library in Version 1.6, + and added back in Version 2.0.28. This function is not + available between these versions. + </para> + </note> &warn.no-win32-fopen-wrapper; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecreatefromjpeg.xml?r1=1.14&r2=1.15&diff_format=u Index: phpdoc/en/reference/image/functions/imagecreatefromjpeg.xml diff -u phpdoc/en/reference/image/functions/imagecreatefromjpeg.xml:1.14 phpdoc/en/reference/image/functions/imagecreatefromjpeg.xml:1.15 --- phpdoc/en/reference/image/functions/imagecreatefromjpeg.xml:1.14 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecreatefromjpeg.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.14 $ --> +<!-- $Revision: 1.15 $ --> <refentry id="function.imagecreatefromjpeg"> <refnamediv> <refname>imagecreatefromjpeg</refname> <refpurpose>Create a new image from file or URL</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>imagecreatefromjpeg</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> @@ -43,8 +43,32 @@ </programlisting> </example> </para> - &note.config.jpeg; &tip.fopen-wrapper; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + Path to the JPEG image + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an image resource identifier on success, &false; on errors. + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + &note.config.jpeg; &warn.no-win32-fopen-wrapper; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecreatefrompng.xml?r1=1.11&r2=1.12&diff_format=u Index: phpdoc/en/reference/image/functions/imagecreatefrompng.xml diff -u phpdoc/en/reference/image/functions/imagecreatefrompng.xml:1.11 phpdoc/en/reference/image/functions/imagecreatefrompng.xml:1.12 --- phpdoc/en/reference/image/functions/imagecreatefrompng.xml:1.11 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecreatefrompng.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> +<!-- $Revision: 1.12 $ --> <refentry id="function.imagecreatefrompng"> <refnamediv> <refname>imagecreatefrompng</refname> <refpurpose>Create a new image from file or URL</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>imagecreatefrompng</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> @@ -44,6 +44,30 @@ </example> </para> &tip.fopen-wrapper; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + Path to the PNG image + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an image resource identifier on success, &false; on errors. + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &warn.no-win32-fopen-wrapper; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecreatefromstring.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/image/functions/imagecreatefromstring.xml diff -u phpdoc/en/reference/image/functions/imagecreatefromstring.xml:1.9 phpdoc/en/reference/image/functions/imagecreatefromstring.xml:1.10 --- phpdoc/en/reference/image/functions/imagecreatefromstring.xml:1.9 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecreatefromstring.xml Sun Jan 14 03:15:21 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <refentry id="function.imagecreatefromstring"> <refnamediv> <refname>imagecreatefromstring</refname> @@ -9,16 +9,30 @@ &reftitle.description; <methodsynopsis> <type>resource</type><methodname>imagecreatefromstring</methodname> - <methodparam><type>string</type><parameter>image</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> </methodsynopsis> <para> <function>imagecreatefromstring</function> returns an image identifier - representing the image obtained from the given string. These types - will be automatically detected if your build of PHP supports them: - JPEG, PNG, GIF, WBMP, and GD2. + representing the image obtained from the given <parameter>data</parameter> + These types will be automatically detected if your build of PHP supports + them: JPEG, PNG, GIF, WBMP, and GD2. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>image</parameter></term> + <listitem> + <para> + A string containing the image data + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> - <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> @@ -27,7 +41,6 @@ or the image is corrupt and cannot be loaded. </para> </refsect1> - <refsect1 role="examples"> &reftitle.examples; <para> @@ -56,7 +69,6 @@ </example> </para> </refsect1> - <refsect1 role="seealso"> &reftitle.seealso; <para> @@ -68,7 +80,6 @@ </simplelist> </para> </refsect1> - </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecreatefromwbmp.xml?r1=1.12&r2=1.13&diff_format=u Index: phpdoc/en/reference/image/functions/imagecreatefromwbmp.xml diff -u phpdoc/en/reference/image/functions/imagecreatefromwbmp.xml:1.12 phpdoc/en/reference/image/functions/imagecreatefromwbmp.xml:1.13 --- phpdoc/en/reference/image/functions/imagecreatefromwbmp.xml:1.12 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecreatefromwbmp.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.12 $ --> +<!-- $Revision: 1.13 $ --> <refentry id="function.imagecreatefromwbmp"> <refnamediv> <refname>imagecreatefromwbmp</refname> <refpurpose>Create a new image from file or URL</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>imagecreatefromwbmp</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> @@ -43,8 +43,32 @@ </programlisting> </example> </para> - &note.config.wbmp; &tip.fopen-wrapper; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + Path to the WBMP image + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an image resource identifier on success, &false; on errors. + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + &note.config.wbmp; &warn.no-win32-fopen-wrapper; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecreatefromxbm.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagecreatefromxbm.xml diff -u phpdoc/en/reference/image/functions/imagecreatefromxbm.xml:1.5 phpdoc/en/reference/image/functions/imagecreatefromxbm.xml:1.6 --- phpdoc/en/reference/image/functions/imagecreatefromxbm.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecreatefromxbm.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagecreatefromxbm"> <refnamediv> <refname>imagecreatefromxbm</refname> <refpurpose>Create a new image from file or URL</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>imagecreatefromxbm</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> @@ -18,6 +18,27 @@ &tip.fopen-wrapper; &warn.no-win32-fopen-wrapper; </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + Path to the XBM image + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an image resource identifier on success, &false; on errors. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecreatefromxpm.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/image/functions/imagecreatefromxpm.xml diff -u phpdoc/en/reference/image/functions/imagecreatefromxpm.xml:1.7 phpdoc/en/reference/image/functions/imagecreatefromxpm.xml:1.8 --- phpdoc/en/reference/image/functions/imagecreatefromxpm.xml:1.7 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecreatefromxpm.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.imagecreatefromxpm"> <refnamediv> <refname>imagecreatefromxpm</refname> <refpurpose>Create a new image from file or URL</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>imagecreatefromxpm</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> @@ -15,8 +15,32 @@ <function>imagecreatefromxpm</function> returns an image identifier representing the image obtained from the given filename. </para> - &note.bundled.gd; &tip.fopen-wrapper; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + Path to the XPM image + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an image resource identifier on success, &false; on errors. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + &note.bundled.gd; &warn.no-win32-fopen-wrapper; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagecreatetruecolor.xml?r1=1.11&r2=1.12&diff_format=u Index: phpdoc/en/reference/image/functions/imagecreatetruecolor.xml diff -u phpdoc/en/reference/image/functions/imagecreatetruecolor.xml:1.11 phpdoc/en/reference/image/functions/imagecreatetruecolor.xml:1.12 --- phpdoc/en/reference/image/functions/imagecreatetruecolor.xml:1.11 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagecreatetruecolor.xml Sun Jan 14 03:15:21 2007 @@ -1,21 +1,20 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> +<!-- $Revision: 1.12 $ --> <refentry id="function.imagecreatetruecolor"> <refnamediv> <refname>imagecreatetruecolor</refname> <refpurpose>Create a new true color image</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>imagecreatetruecolor</methodname> - <methodparam><type>int</type><parameter>x_size</parameter></methodparam> - <methodparam><type>int</type><parameter>y_size</parameter></methodparam> + <methodparam><type>int</type><parameter>width</parameter></methodparam> + <methodparam><type>int</type><parameter>height</parameter></methodparam> </methodsynopsis> <para> <function>imagecreatetruecolor</function> returns an image identifier - representing a black image of size <parameter>x_size</parameter> - by <parameter>y_size</parameter>. + representing a black image of the specified size. </para> <para> Depending on your PHP and GD versions this function is defined or not. With @@ -25,6 +24,38 @@ warning instead of an error. Other versions only define this function, if the correct GD version is installed. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + Image width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + Image height + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an image resource identifier on success, &false; on errors. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title> @@ -45,15 +76,23 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.gd.2; <note> <para> This function will not work with GIF file formats. </para> </note> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagedestroy</function> and - <function>imagecreate</function>. + <simplelist> + <member><function>imagedestroy</function></member> + <member><function>imagecreate</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagedashedline.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/image/functions/imagedashedline.xml diff -u phpdoc/en/reference/image/functions/imagedashedline.xml:1.6 phpdoc/en/reference/image/functions/imagedashedline.xml:1.7 --- phpdoc/en/reference/image/functions/imagedashedline.xml:1.6 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagedashedline.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imagedashedline"> <refnamediv> <refname>imagedashedline</refname> <refpurpose>Draw a dashed line</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagedashedline</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagedestroy.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/image/functions/imagedestroy.xml diff -u phpdoc/en/reference/image/functions/imagedestroy.xml:1.6 phpdoc/en/reference/image/functions/imagedestroy.xml:1.7 --- phpdoc/en/reference/image/functions/imagedestroy.xml:1.6 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagedestroy.xml Sun Jan 14 03:15:21 2007 @@ -1,21 +1,33 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imagedestroy"> <refnamediv> <refname>imagedestroy</refname> <refpurpose>Destroy an image</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagedestroy</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> </methodsynopsis> <para> <function>imagedestroy</function> frees any memory associated - with image <parameter>image</parameter>. <parameter>image</parameter> - is the image identifier returned by one of the image create functions, - such as <function>imagecreatetruecolor</function>. + with image <parameter>image</parameter>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imageellipse.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/image/functions/imageellipse.xml diff -u phpdoc/en/reference/image/functions/imageellipse.xml:1.10 phpdoc/en/reference/image/functions/imageellipse.xml:1.11 --- phpdoc/en/reference/image/functions/imageellipse.xml:1.10 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imageellipse.xml Sun Jan 14 03:15:21 2007 @@ -1,33 +1,82 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <refentry id="function.imageellipse"> <refnamediv> <refname>imageellipse</refname> <refpurpose>Draw an ellipse</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imageellipse</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> <methodparam><type>int</type><parameter>cx</parameter></methodparam> <methodparam><type>int</type><parameter>cy</parameter></methodparam> - <methodparam><type>int</type><parameter>w</parameter></methodparam> - <methodparam><type>int</type><parameter>h</parameter></methodparam> + <methodparam><type>int</type><parameter>width</parameter></methodparam> + <methodparam><type>int</type><parameter>height</parameter></methodparam> <methodparam><type>int</type><parameter>color</parameter></methodparam> </methodsynopsis> <para> - <function>imageellipse</function> draws an ellipse centered at - <parameter>cx</parameter>, <parameter>cy</parameter> (top left is - 0, 0) in the image represented by <parameter>image</parameter>. - <parameter>W</parameter> and <parameter>h</parameter> specifies the - ellipse's width and height respectively. The color of the ellipse is - specified by <parameter>color</parameter>. + Draws an ellipse centered at the specified coordinates. </para> - <note><para> - This function was added in PHP 4.0.6 and requires GD 2.0.2 or later - which can be obtained at <ulink url="&url.gd;">&url.gd;</ulink> - </para></note> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>cx</parameter></term> + <listitem> + <para> + x-coordinate of the center + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>cy</parameter></term> + <listitem> + <para> + y-coordinate of the center + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The ellipse width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + The ellipse height + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + The color of the ellipse. A color identifier created with + <function>imagecolorallocate</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imageellipse</function> example</title> @@ -56,9 +105,22 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function requires GD 2.0.2 or later. + </para> + </note> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagefilledellipse</function> and - <function>imagearc</function>. + <simplelist> + <member><function>imagefilledellipse</function></member> + <member><function>imagearc</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagefill.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/image/functions/imagefill.xml diff -u phpdoc/en/reference/image/functions/imagefill.xml:1.8 phpdoc/en/reference/image/functions/imagefill.xml:1.9 --- phpdoc/en/reference/image/functions/imagefill.xml:1.8 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagefill.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.imagefill"> <refnamediv> <refname>imagefill</refname> <refpurpose>Flood fill</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagefill</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -15,11 +15,52 @@ <methodparam><type>int</type><parameter>color</parameter></methodparam> </methodsynopsis> <para> - <function>imagefill</function> performs a flood fill starting at - coordinate <parameter>x</parameter>, <parameter>y</parameter> - (top left is 0, 0) with color <parameter>color</parameter> in the - image <parameter>image</parameter>. + Performs a flood fill starting at the given coordinate (top left is 0, 0) + with the given <parameter>color</parameter> in the + <parameter>image</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + x-coordinate of start point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + y-coordinate of start point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + The fill color. A color identifier created with + <function>imagecolorallocate</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imagefill</function> example</title> @@ -41,8 +82,13 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecolorallocate</function>. + <simplelist> + <member><function>imagecolorallocate</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagefilledarc.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/image/functions/imagefilledarc.xml diff -u phpdoc/en/reference/image/functions/imagefilledarc.xml:1.10 phpdoc/en/reference/image/functions/imagefilledarc.xml:1.11 --- phpdoc/en/reference/image/functions/imagefilledarc.xml:1.10 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagefilledarc.xml Sun Jan 14 03:15:21 2007 @@ -1,51 +1,127 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <refentry id="function.imagefilledarc"> <refnamediv> <refname>imagefilledarc</refname> <refpurpose>Draw a partial ellipse and fill it</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagefilledarc</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> <methodparam><type>int</type><parameter>cx</parameter></methodparam> <methodparam><type>int</type><parameter>cy</parameter></methodparam> - <methodparam><type>int</type><parameter>w</parameter></methodparam> - <methodparam><type>int</type><parameter>h</parameter></methodparam> - <methodparam><type>int</type><parameter>s</parameter></methodparam> - <methodparam><type>int</type><parameter>e</parameter></methodparam> + <methodparam><type>int</type><parameter>width</parameter></methodparam> + <methodparam><type>int</type><parameter>height</parameter></methodparam> + <methodparam><type>int</type><parameter>start</parameter></methodparam> + <methodparam><type>int</type><parameter>end</parameter></methodparam> <methodparam><type>int</type><parameter>color</parameter></methodparam> <methodparam><type>int</type><parameter>style</parameter></methodparam> </methodsynopsis> <para> - <function>imagefilledarc</function> draws a partial ellipse centered at - <parameter>cx</parameter>, <parameter>cy</parameter> (top left is - 0, 0) in the image represented by <parameter>image</parameter>. + Draws a partial ellipse centered at the specified coordinate in the + given <parameter>image</parameter>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>cx</parameter></term> + <listitem> + <para> + x-coordinate of the center + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>cy</parameter></term> + <listitem> + <para> + y-coordinate of the center + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The arc width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + The arc height + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>start</parameter></term> + <listitem> + <para> + The arc start angle, in degrees. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>end</parameter></term> + <listitem> + <para> + The arc end angle, in degrees. + 0&deg; is located at the three-o'clock position, and the arc is drawn + clockwise. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + A color identifier created with + <function>imagecolorallocate</function> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>style</parameter></term> + <listitem> + <para> + A bitwise OR of the following possibilities: + <orderedlist> + <listitem><simpara><constant>IMG_ARC_PIE</constant></simpara></listitem> + <listitem><simpara><constant>IMG_ARC_CHORD</constant></simpara></listitem> + <listitem><simpara><constant>IMG_ARC_NOFILL</constant></simpara></listitem> + <listitem><simpara><constant>IMG_ARC_EDGED</constant></simpara></listitem> + </orderedlist> + <constant>IMG_ARC_PIE</constant> and <constant>IMG_ARC_CHORD</constant> are + mutually exclusive; <constant>IMG_ARC_CHORD</constant> just + connects the starting and ending angles with a straight line, while + <constant>IMG_ARC_PIE</constant> produces a rounded edge. + <constant>IMG_ARC_NOFILL</constant> indicates that the arc + or chord should be outlined, not filled. <constant>IMG_ARC_EDGED</constant>, + used together with <constant>IMG_ARC_NOFILL</constant>, indicates that the + beginning and ending angles should be connected to the center - this is a + good way to outline (rather than fill) a 'pie slice'. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> &return.success; - <parameter>W</parameter> - and <parameter>h</parameter> specifies the ellipse's width and - height respectively while the start and end points are specified - in degrees indicated by the <parameter>s</parameter> and - <parameter>e</parameter> arguments. - <parameter>style</parameter> is a bitwise OR of the following possibilities: - <orderedlist> - <listitem><simpara><constant>IMG_ARC_PIE</constant></simpara></listitem> - <listitem><simpara><constant>IMG_ARC_CHORD</constant></simpara></listitem> - <listitem><simpara><constant>IMG_ARC_NOFILL</constant></simpara></listitem> - <listitem><simpara><constant>IMG_ARC_EDGED</constant></simpara></listitem> - </orderedlist> - <constant>IMG_ARC_PIE</constant> and <constant>IMG_ARC_CHORD</constant> are - mutually exclusive; <constant>IMG_ARC_CHORD</constant> just - connects the starting and ending angles with a straight line, while - <constant>IMG_ARC_PIE</constant> produces a rounded edge. - <constant>IMG_ARC_NOFILL</constant> indicates that the arc - or chord should be outlined, not filled. <constant>IMG_ARC_EDGED</constant>, - used together with <constant>IMG_ARC_NOFILL</constant>, indicates that the - beginning and ending angles should be connected to the center - this is a - good way to outline (rather than fill) a 'pie slice'. </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Creating a 3D looking pie</title> @@ -86,6 +162,9 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.gd.2; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagefilledellipse.xml?r1=1.13&r2=1.14&diff_format=u Index: phpdoc/en/reference/image/functions/imagefilledellipse.xml diff -u phpdoc/en/reference/image/functions/imagefilledellipse.xml:1.13 phpdoc/en/reference/image/functions/imagefilledellipse.xml:1.14 --- phpdoc/en/reference/image/functions/imagefilledellipse.xml:1.13 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagefilledellipse.xml Sun Jan 14 03:15:21 2007 @@ -1,29 +1,83 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.13 $ --> +<!-- $Revision: 1.14 $ --> <refentry id="function.imagefilledellipse"> <refnamediv> <refname>imagefilledellipse</refname> <refpurpose>Draw a filled ellipse</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagefilledellipse</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> <methodparam><type>int</type><parameter>cx</parameter></methodparam> <methodparam><type>int</type><parameter>cy</parameter></methodparam> - <methodparam><type>int</type><parameter>w</parameter></methodparam> - <methodparam><type>int</type><parameter>h</parameter></methodparam> + <methodparam><type>int</type><parameter>width</parameter></methodparam> + <methodparam><type>int</type><parameter>height</parameter></methodparam> <methodparam><type>int</type><parameter>color</parameter></methodparam> </methodsynopsis> <para> - <function>imagefilledellipse</function> draws an ellipse centered at - <parameter>cx</parameter>, <parameter>cy</parameter> (top left is - 0, 0) in the image represented by <parameter>image</parameter>. - <parameter>W</parameter> and <parameter>h</parameter> specifies the - ellipse's width and height respectively. The ellipse is filled using - <parameter>color</parameter>. &return.success; + Draws an ellipse centered at the specified coordinate on the given + <parameter>image</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>cx</parameter></term> + <listitem> + <para> + x-coordinate of the center + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>cy</parameter></term> + <listitem> + <para> + y-coordinate of the center + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The arc width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + The arc height + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + The fill color. A color identifier created with + <function>imagecolorallocate</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imagefilledellipse</function> example</title> @@ -52,10 +106,18 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.gd.2; + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imageellipse</function> and - <function>imagefilledarc</function>. + <simplelist> + <member><function>imageellipse</function></member> + <member><function>imagefilledarc</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagefilledpolygon.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/image/functions/imagefilledpolygon.xml diff -u phpdoc/en/reference/image/functions/imagefilledpolygon.xml:1.10 phpdoc/en/reference/image/functions/imagefilledpolygon.xml:1.11 --- phpdoc/en/reference/image/functions/imagefilledpolygon.xml:1.10 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagefilledpolygon.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <refentry id="function.imagefilledpolygon"> <refnamediv> <refname>imagefilledpolygon</refname> <refpurpose>Draw a filled polygon</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagefilledpolygon</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -16,17 +16,51 @@ </methodsynopsis> <para> <function>imagefilledpolygon</function> creates a filled polygon - in image <parameter>image</parameter>. + in the given <parameter>image</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>points</parameter> is an array containing the - <literal>x</literal> and <literal>y</literal> co-ordinates - of the polygons vertices consecutively. + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>points</parameter></term> + <listitem> + <para> + An array containing the <literal>x</literal> and <literal>y</literal> + coordinates of the polygons vertices consecutively + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>num_points</parameter></term> + <listitem> + <para> + Total number of vertices, which must be bigger than 3 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + A color identifier created with + <function>imagecolorallocate</function> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The parameter <parameter>num_points</parameter> is the total - number of vertices, which must be larger than 3. + &return.success; </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imagefilledpolygon</function> example</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagefilledrectangle.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/image/functions/imagefilledrectangle.xml diff -u phpdoc/en/reference/image/functions/imagefilledrectangle.xml:1.6 phpdoc/en/reference/image/functions/imagefilledrectangle.xml:1.7 --- phpdoc/en/reference/image/functions/imagefilledrectangle.xml:1.6 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagefilledrectangle.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imagefilledrectangle"> <refnamediv> <refname>imagefilledrectangle</refname> <refpurpose>Draw a filled rectangle</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagefilledrectangle</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -17,13 +17,64 @@ <methodparam><type>int</type><parameter>color</parameter></methodparam> </methodsynopsis> <para> - <function>imagefilledrectangle</function> creates a filled - rectangle of color <parameter>color</parameter> in image - <parameter>image</parameter> starting at upper left coordinates - <parameter>x1</parameter>, <parameter>y1</parameter> and ending - at bottom right coordinates <parameter>x2</parameter>, - <parameter>y2</parameter>. 0, 0 is the top left corner of the - image. + Creates a rectangle filled with <parameter>color</parameter> in the given + <parameter>image</parameter> starting at point 1 and ending at point 2. + 0, 0 is the top left corner of the image. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>x1</parameter></term> + <listitem> + <para> + x-coordinate for point 1 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y1</parameter></term> + <listitem> + <para> + y-coordinate for point 1 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x2</parameter></term> + <listitem> + <para> + x-coordinate for point 2 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y2</parameter></term> + <listitem> + <para> + y-coordinate for point 2 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + The fill color. A color identifier created with + <function>imagecolorallocate</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagefilltoborder.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/image/functions/imagefilltoborder.xml diff -u phpdoc/en/reference/image/functions/imagefilltoborder.xml:1.6 phpdoc/en/reference/image/functions/imagefilltoborder.xml:1.7 --- phpdoc/en/reference/image/functions/imagefilltoborder.xml:1.6 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagefilltoborder.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imagefilltoborder"> <refnamediv> <refname>imagefilltoborder</refname> <refpurpose>Flood fill to specific color</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagefilltoborder</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -23,6 +23,54 @@ filled with color <parameter>color</parameter>. </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + x-coordinate of start + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + y-coordinate of start + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>border</parameter></term> + <listitem> + <para> + The border color. A color identifier created with + <function>imagecolorallocate</function> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + The fill color. A color identifier created with + <function>imagecolorallocate</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagefilter.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagefilter.xml diff -u phpdoc/en/reference/image/functions/imagefilter.xml:1.5 phpdoc/en/reference/image/functions/imagefilter.xml:1.6 --- phpdoc/en/reference/image/functions/imagefilter.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagefilter.xml Sun Jan 14 03:15:21 2007 @@ -1,105 +1,142 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagefilter"> <refnamediv> <refname>imagefilter</refname> <refpurpose>Applies a filter to an image</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagefilter</methodname> - <methodparam><type>resource</type><parameter>src_im</parameter></methodparam> + <methodparam><type>resource</type><parameter>image</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. + <function>imagefilter</function> applies the given filter + <parameter>filtertype</parameter> on the <parameter>image</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <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> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>filtertype</parameter></term> + <listitem> + <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> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>arg1</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>arg2</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>arg3</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> - &note.bundled.gd; + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imagefilter</function> grayscale example</title> @@ -119,8 +156,6 @@ ]]> </programlisting> </example> - </para> - <para> <example> <title><function>imagefilter</function> brightness example</title> <programlisting role="php"> @@ -139,8 +174,6 @@ ]]> </programlisting> </example> - </para> - <para> <example> <title><function>imagefilter</function> colorize example</title> <programlisting role="php"> @@ -163,6 +196,10 @@ </example> </para> </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + &note.bundled.gd; + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagefontheight.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/image/functions/imagefontheight.xml diff -u phpdoc/en/reference/image/functions/imagefontheight.xml:1.3 phpdoc/en/reference/image/functions/imagefontheight.xml:1.4 --- phpdoc/en/reference/image/functions/imagefontheight.xml:1.3 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagefontheight.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.imagefontheight"> <refnamediv> <refname>imagefontheight</refname> <refpurpose>Get font height</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imagefontheight</methodname> <methodparam><type>int</type><parameter>font</parameter></methodparam> @@ -14,9 +14,28 @@ <para> Returns the pixel height of a character in the specified font. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.font.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the height of the pixel. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagefontwidth</function> and - <function>imageloadfont</function>. + <simplelist> + <member><function>imagefontwidth</function></member> + <member><function>imageloadfont</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagefontwidth.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/image/functions/imagefontwidth.xml diff -u phpdoc/en/reference/image/functions/imagefontwidth.xml:1.3 phpdoc/en/reference/image/functions/imagefontwidth.xml:1.4 --- phpdoc/en/reference/image/functions/imagefontwidth.xml:1.3 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagefontwidth.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.imagefontwidth"> <refnamediv> <refname>imagefontwidth</refname> <refpurpose>Get font width</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imagefontwidth</methodname> <methodparam><type>int</type><parameter>font</parameter></methodparam> @@ -14,9 +14,28 @@ <para> Returns the pixel width of a character in font. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.font.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the width of the pixel + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagefontheight</function> and - <function>imageloadfont</function>. + <simplelist> + <member><function>imagefontheight</function></member> + <member><function>imageloadfont</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imageftbbox.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/image/functions/imageftbbox.xml diff -u phpdoc/en/reference/image/functions/imageftbbox.xml:1.7 phpdoc/en/reference/image/functions/imageftbbox.xml:1.8 --- phpdoc/en/reference/image/functions/imageftbbox.xml:1.7 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imageftbbox.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id='function.imageftbbox'> <refnamediv> <refname>imageftbbox</refname> <refpurpose>Give the bounding box of a text using fonts via freetype2</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imageftbbox</methodname> <methodparam><type>float</type><parameter>size</parameter></methodparam> @@ -15,16 +15,82 @@ <methodparam><type>string</type><parameter>text</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>extrainfo</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>size</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>angle</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>font_file</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>extrainfo</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + &note.gd.2; + &note.freetype; + </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; <para> - &warn.undocumented.func; - &note.gd.2; - &note.freetype; + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.3.5</entry> + <entry> + <parameter>extrainfo</parameter> was made optional. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </para> - <note> - <para> - Parameter <parameter>extrainfo</parameter> is optional since PHP 4.3.5. - </para> - </note> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagefttext.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/image/functions/imagefttext.xml diff -u phpdoc/en/reference/image/functions/imagefttext.xml:1.8 phpdoc/en/reference/image/functions/imagefttext.xml:1.9 --- phpdoc/en/reference/image/functions/imagefttext.xml:1.8 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagefttext.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id='function.imagefttext'> <refnamediv> <refname>imagefttext</refname> <refpurpose>Write text to the image using fonts using FreeType 2</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imagefttext</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -19,16 +19,104 @@ <methodparam><type>string</type><parameter>text</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>extrainfo</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>size</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>angle</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>col</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>font_file</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>extrainfo</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + &note.gd.2; + &note.freetype; + </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; <para> - &warn.undocumented.func; - &note.gd.2; - &note.freetype; + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.3.5</entry> + <entry> + <parameter>extrainfo</parameter> was made optional. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </para> - <note> - <para> - Parameter <parameter>extrainfo</parameter> is optional since PHP 4.3.5. - </para> - </note> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagegammacorrect.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagegammacorrect.xml diff -u phpdoc/en/reference/image/functions/imagegammacorrect.xml:1.5 phpdoc/en/reference/image/functions/imagegammacorrect.xml:1.6 --- phpdoc/en/reference/image/functions/imagegammacorrect.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagegammacorrect.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagegammacorrect"> <refnamediv> <refname>imagegammacorrect</refname> <refpurpose>Apply a gamma correction to a GD image</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagegammacorrect</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -14,11 +14,38 @@ <methodparam><type>float</type><parameter>outputgamma</parameter></methodparam> </methodsynopsis> <para> - The <function>imagegammacorrect</function> function applies gamma - correction to a gd image stream (<parameter>image</parameter>) given - an input gamma, the parameter <parameter>inputgamma</parameter> - and an output gamma, the parameter - <parameter>outputgamma</parameter>. + Applies gamma correction to the given gd <parameter>image</parameter> + given an input and an output gamma. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>inputgamma</parameter></term> + <listitem> + <para> + The input gamma + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>outputgamma</parameter></term> + <listitem> + <para> + The output gamma + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagegd.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/image/functions/imagegd.xml diff -u phpdoc/en/reference/image/functions/imagegd.xml:1.7 phpdoc/en/reference/image/functions/imagegd.xml:1.8 --- phpdoc/en/reference/image/functions/imagegd.xml:1.7 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagegd.xml Sun Jan 14 03:15:21 2007 @@ -1,35 +1,59 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id='function.imagegd'> <refnamediv> <refname>imagegd</refname> <refpurpose>Output GD image to browser or file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagegd</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> <para> - <function>imagegd</function> outputs a GD image to - <parameter>filename</parameter>. The <parameter>image</parameter> - argument is the return from the <function>imagecreatetruecolor</function> - function. + Outputs a GD image to the given <parameter>filename</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The path to the saved file. If not set or &null;, the raw image stream + will be outputed directly. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The <parameter>filename</parameter> parameter is optional, and if left - off, the raw image stream will be output directly. + &return.success; </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; <note> <para> The GD format is commonly used to allow fast loading of parts of images. Note that the GD format is only usable in GD-compatible applications. </para> </note> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagegd2</function>. + <simplelist> + <member><function>imagegd2</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagegd2.xml?r1=1.14&r2=1.15&diff_format=u Index: phpdoc/en/reference/image/functions/imagegd2.xml diff -u phpdoc/en/reference/image/functions/imagegd2.xml:1.14 phpdoc/en/reference/image/functions/imagegd2.xml:1.15 --- phpdoc/en/reference/image/functions/imagegd2.xml:1.14 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagegd2.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.14 $ --> +<!-- $Revision: 1.15 $ --> <refentry id='function.imagegd2'> <refnamediv> <refname>imagegd2</refname> <refpurpose>Output GD2 image to browser or file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagegd2</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -15,36 +15,89 @@ <methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam> </methodsynopsis> <para> - <function>imagegd2</function> outputs a GD2 image to - <parameter>filename</parameter>. - The <parameter>image</parameter> parameter is the return from the - <function>imagecreatetruecolor</function> function. + Outputs a GD2 image to the given <parameter>filename</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The <parameter>filename</parameter> parameter is optional, and if left - off, the raw image stream will be output directly. + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The path to the saved file. If not set or &null;, the raw image stream + will be outputed directly. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>chunk_size</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>type</parameter></term> + <listitem> + <para> + Either <constant>IMG_GD2_RAW</constant> or + <constant>IMG_GD2_COMPRESSED</constant>. Default is + <constant>IMG_GD2_RAW</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The optional <parameter>type</parameter> parameter is either - <constant>IMG_GD2_RAW</constant> or <constant>IMG_GD2_COMPRESSED</constant>. - Default is <constant>IMG_GD2_RAW</constant>. + &return.success; </para> - <note> - <para> - The optional <parameter>chunk_size</parameter> and - <parameter>type</parameter> parameters became available - in PHP 4.3.2. - </para> - </note> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + &note.gd.2; <note> <para> The GD2 format is commonly used to allow fast loading of parts of images. Note that the GD2 format is only usable in GD2-compatible applications. </para> </note> - &note.gd.2; + </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.3.2</entry> + <entry> + <parameter>chunk_size</parameter> and <parameter>type</parameter> + were added. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagegd</function> + <simplelist> + <member><function>imagegd</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagegif.xml?r1=1.13&r2=1.14&diff_format=u Index: phpdoc/en/reference/image/functions/imagegif.xml diff -u phpdoc/en/reference/image/functions/imagegif.xml:1.13 phpdoc/en/reference/image/functions/imagegif.xml:1.14 --- phpdoc/en/reference/image/functions/imagegif.xml:1.13 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagegif.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.13 $ --> +<!-- $Revision: 1.14 $ --> <refentry id="function.imagegif"> <refnamediv> <refname>imagegif</refname> <refpurpose>Output image to browser or file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagegif</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -25,30 +25,50 @@ <function>imagecolortransparent</function>, in which case the image format will be <acronym>GIF89a</acronym>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The path to the saved file. If not set or &null;, the raw image stream + will be outputed directly. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The filename argument is optional, and if left off or filled - with a &null; value, the raw image stream will be output directly. - By sending an image/gif content-type using <function>header</function>, - you can create a PHP script that outputs <acronym>GIF</acronym> - images directly. - <note> - <para> - Since all <acronym>GIF</acronym> support was removed from the - <acronym>GD</acronym> library in version 1.6, this function is - not available if you are using that version of the GD library. - Support is expected to return in a version subsequent to the - rerelease of <acronym>GIF</acronym> support in the GD library in - mid 2004. For more information, see the - <ulink url="&url.gd;">GD Project</ulink> site. - </para> - <para> - The following code snippet allows you to write more - portable PHP applications by auto-detecting the - type of GD support which is available. Replace - the sequence <literal>header ("Content-type: image/gif"); - imagegif ($im);</literal> by the more flexible sequence: - <informalexample> - <programlisting role="php"> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <note> + <para> + Since all <acronym>GIF</acronym> support was removed from the + <acronym>GD</acronym> library in version 1.6, this function is + not available if you are using that version of the GD library. + Support is expected to return in a version subsequent to the + rerelease of <acronym>GIF</acronym> support in the GD library in + mid 2004. For more information, see the + <ulink url="&url.gd;">GD Project</ulink> site. + </para> + <para> + The following code snippet allows you to write more + portable PHP applications by auto-detecting the + type of GD support which is available. Replace + the sequence <literal>header ("Content-type: image/gif"); + imagegif ($im);</literal> by the more flexible sequence: + <informalexample> + <programlisting role="php"> <![CDATA[ <?php if (function_exists("imagegif")) { @@ -68,18 +88,18 @@ } ?> ]]> - </programlisting> - </informalexample> - </para> - </note> - <note> - <para> - As of version 3.0.18 and 4.0.2 you can use the function - <function>imagetypes</function> in place of - <function>function_exists</function> for checking - the presence of the various supported image formats: - <informalexample> - <programlisting role="php"> + </programlisting> + </informalexample> + </para> + </note> + <note> + <para> + As of version 3.0.18 and 4.0.2 you can use the function + <function>imagetypes</function> in place of + <function>function_exists</function> for checking + the presence of the various supported image formats: + <informalexample> + <programlisting role="php"> <![CDATA[ <?php if (imagetypes() & IMG_GIF) { @@ -90,14 +110,20 @@ } ?> ]]> - </programlisting> - </informalexample> - </para> - </note> - </para> + </programlisting> + </informalexample> + </para> + </note> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagepng</function>, <function>imagewbmp</function>, - <function>imagejpeg</function> and <function>imagetypes</function>. + <simplelist> + <member><function>imagepng</function></member> + <member><function>imagewbmp</function></member> + <member><function>imagejpeg</function></member> + <member><function>imagetypes</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imageinterlace.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/image/functions/imageinterlace.xml diff -u phpdoc/en/reference/image/functions/imageinterlace.xml:1.4 phpdoc/en/reference/image/functions/imageinterlace.xml:1.5 --- phpdoc/en/reference/image/functions/imageinterlace.xml:1.4 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imageinterlace.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.imageinterlace"> <refnamediv> <refname>imageinterlace</refname> <refpurpose>Enable or disable interlace</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imageinterlace</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -14,16 +14,33 @@ </methodsynopsis> <para> <function>imageinterlace</function> turns the interlace bit on or off. - If interlace is 1 the image will be interlaced, and if interlace - is 0 the interlace bit is turned off. </para> <para> If the interlace bit is set and the image is used as a JPEG image, the image is created as a progressive JPEG. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>interlace</parameter></term> + <listitem> + <para> + If non-zero, the image will be interlaced, else the interlace bit is + turned off. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - This function returns whether the interlace bit is set for the - image. + Returns 1 if the interlace bit is set for the image, 0 otherwise. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imageistruecolor.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imageistruecolor.xml diff -u phpdoc/en/reference/image/functions/imageistruecolor.xml:1.5 phpdoc/en/reference/image/functions/imageistruecolor.xml:1.6 --- phpdoc/en/reference/image/functions/imageistruecolor.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imageistruecolor.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imageistruecolor"> <refnamediv> <refname>imageistruecolor</refname> <refpurpose>Finds whether an image is a truecolor image</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imageistruecolor</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -15,9 +15,32 @@ <function>imageistruecolor</function> finds whether the image <parameter>image</parameter> is a truecolor image. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if the <parameter>image</parameter> is truecolor, &false; + otherwise. + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.gd.2; + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecreatetruecolor</function>. + <simplelist> + <member><function>imagecreatetruecolor</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagejpeg.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/image/functions/imagejpeg.xml diff -u phpdoc/en/reference/image/functions/imagejpeg.xml:1.8 phpdoc/en/reference/image/functions/imagejpeg.xml:1.9 --- phpdoc/en/reference/image/functions/imagejpeg.xml:1.8 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagejpeg.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.imagejpeg"> <refnamediv> <refname>imagejpeg</refname> <refpurpose>Output image to browser or file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagejpeg</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -14,38 +14,67 @@ <methodparam choice="opt"><type>int</type><parameter>quality</parameter></methodparam> </methodsynopsis> <para> - <function>imagejpeg</function> creates the - <acronym>JPEG</acronym> file in filename from the image - <parameter>image</parameter>. The <parameter>image</parameter> argument - is the return from the <function>imagecreatetruecolor</function> function. + <function>imagejpeg</function> creates a <acronym>JPEG</acronym> file from + the given <parameter>image</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The filename argument is optional, and if left off, the raw image - stream will be output directly. To skip the filename argument in - order to provide a quality argument just use a &null; value. - By sending an image/jpeg content-type using - <function>header</function>, you can create a PHP script that - outputs JPEG images directly. - </para> - - &note.config.jpeg; - - <para> - <parameter>quality</parameter> is optional, and ranges from - 0 (worst quality, smaller file) to 100 (best quality, biggest file). - The default is the default IJG quality value (about 75). + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The path to the saved file. If not set or &null;, the raw image stream + will be outputed directly. + </para> + <para> + To skip this argument in order to provide the + <parameter>quality</parameter> parameter, use &null;. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>quality</parameter></term> + <listitem> + <para> + <parameter>quality</parameter> is optional, and ranges from 0 (worst + quality, smaller file) to 100 (best quality, biggest file). The + default is the default IJG quality value (about 75). + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - If you want to output Progressive JPEGs, you need to set interlacing - on with <function>imageinterlace</function>. + &return.success; </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + &note.config.jpeg; + <note> + <para> + If you want to output Progressive JPEGs, you need to set interlacing + on with <function>imageinterlace</function>. + </para> + </note> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>imagepng</function>, - <function>imagegif</function>, - <function>imagewbmp</function>, - <function>imageinterlace</function> and - <function>imagetypes</function>. + <simplelist> + <member><function>imagepng</function></member> + <member><function>imagegif</function></member> + <member><function>imagewbmp</function></member> + <member><function>imageinterlace</function></member> + <member><function>imagetypes</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagelayereffect.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagelayereffect.xml diff -u phpdoc/en/reference/image/functions/imagelayereffect.xml:1.5 phpdoc/en/reference/image/functions/imagelayereffect.xml:1.6 --- phpdoc/en/reference/image/functions/imagelayereffect.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagelayereffect.xml Sun Jan 14 03:15:21 2007 @@ -1,20 +1,44 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagelayereffect"> <refnamediv> <refname>imagelayereffect</refname> <refpurpose>Set the alpha blending flag to use the bundled libgd layering effects</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <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> - &warn.undocumented.func; - &note.bundled.gd; - &note.gd.2; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>effect</parameter></term> + <listitem> + <para> + </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> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imageline.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/image/functions/imageline.xml diff -u phpdoc/en/reference/image/functions/imageline.xml:1.9 phpdoc/en/reference/image/functions/imageline.xml:1.10 --- phpdoc/en/reference/image/functions/imageline.xml:1.9 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imageline.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <refentry id="function.imageline"> <refnamediv> <refname>imageline</refname> <refpurpose>Draw a line</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imageline</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -17,14 +17,70 @@ <methodparam><type>int</type><parameter>color</parameter></methodparam> </methodsynopsis> <para> - <function>imageline</function> draws a line from - <parameter>x1</parameter>, <parameter>y1</parameter> to - <parameter>x2</parameter>, <parameter>y2</parameter> (top left is - 0, 0) in image <parameter>image</parameter> of color <parameter>color</parameter>. + <function>imageline</function> draws a line between the two given points. </para> - <example> - <title>Drawing a thick line</title> - <programlisting role="php"> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>x1</parameter></term> + <listitem> + <para> + x-coordinate for first point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y1</parameter></term> + <listitem> + <para> + y-coordinate for first point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x2</parameter></term> + <listitem> + <para> + x-coordinate for second point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y2</parameter></term> + <listitem> + <para> + y-coordinate for second point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + The line color. A color identifier created with + <function>imagecolorallocate</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Drawing a thick line</title> + <programlisting role="php"> <![CDATA[ <?php @@ -55,11 +111,17 @@ ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecreatetruecolor</function> and - <function>imagecolorallocate</function>. + <simplelist> + <member><function>imagecreatetruecolor</function></member> + <member><function>imagecolorallocate</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imageloadfont.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/image/functions/imageloadfont.xml diff -u phpdoc/en/reference/image/functions/imageloadfont.xml:1.6 phpdoc/en/reference/image/functions/imageloadfont.xml:1.7 --- phpdoc/en/reference/image/functions/imageloadfont.xml:1.6 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imageloadfont.xml Sun Jan 14 03:15:21 2007 @@ -1,73 +1,93 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imageloadfont"> <refnamediv> <refname>imageloadfont</refname> <refpurpose>Load a new font</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imageloadfont</methodname> <methodparam><type>string</type><parameter>file</parameter></methodparam> </methodsynopsis> <para> - <function>imageloadfont</function> loads a user-defined bitmap - font and returns an identifier for the font (that is always - greater than 5, so it will not conflict with the built-in fonts). - It returns &false; in case of error. + <function>imageloadfont</function> loads a user-defined bitmap and returns + its identifier. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The font file format is currently binary and architecture - dependent. This means you should generate the font files on the - same type of CPU as the machine you are running PHP on. + <variablelist> + <varlistentry> + <term><parameter>file</parameter></term> + <listitem> + <para> + The font file format is currently binary and architecture + dependent. This means you should generate the font files on the + same type of CPU as the machine you are running PHP on. + </para> + <para> + <table> + <title>Font file format</title> + <tgroup cols="3"> + <thead> + <row> + <entry>byte position</entry> + <entry>C data type</entry> + <entry>description</entry> + </row> + </thead> + <tbody> + <row> + <entry>byte 0-3</entry> + <entry>int</entry> + <entry>number of characters in the font</entry> + </row> + <row> + <entry>byte 4-7</entry> + <entry>int</entry> + <entry> + value of first character in the font (often 32 for space) + </entry> + </row> + <row> + <entry>byte 8-11</entry> + <entry>int</entry> + <entry>pixel width of each character</entry> + </row> + <row> + <entry>byte 12-15</entry> + <entry>int</entry> + <entry>pixel height of each character</entry> + </row> + <row> + <entry>byte 16-</entry> + <entry>char</entry> + <entry> + array with character data, one byte per pixel in each + character, for a total of (nchars*width*height) bytes. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <table> - <title>Font file format</title> - <tgroup cols="3"> - <thead> - <row> - <entry>byte position</entry> - <entry>C data type</entry> - <entry>description</entry> - </row> - </thead> - <tbody> - <row> - <entry>byte 0-3</entry> - <entry>int</entry> - <entry>number of characters in the font</entry> - </row> - <row> - <entry>byte 4-7</entry> - <entry>int</entry> - <entry> - value of first character in the font (often 32 for space) - </entry> - </row> - <row> - <entry>byte 8-11</entry> - <entry>int</entry> - <entry>pixel width of each character</entry> - </row> - <row> - <entry>byte 12-15</entry> - <entry>int</entry> - <entry>pixel height of each character</entry> - </row> - <row> - <entry>byte 16-</entry> - <entry>char</entry> - <entry> - array with character data, one byte per pixel in each - character, for a total of (nchars*width*height) bytes. - </entry> - </row> - </tbody> - </tgroup> - </table> + The font identifier which is always biigger than 5 to avoid conflicts with + built-in fonts or &false; on errors. </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Using imageloadfont</title> @@ -87,9 +107,14 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagefontwidth</function> and - <function>imagefontheight</function>. + <simplelist> + <member><function>imagefontwidth</function></member> + <member><function>imagefontheight</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagepalettecopy.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/image/functions/imagepalettecopy.xml diff -u phpdoc/en/reference/image/functions/imagepalettecopy.xml:1.4 phpdoc/en/reference/image/functions/imagepalettecopy.xml:1.5 --- phpdoc/en/reference/image/functions/imagepalettecopy.xml:1.4 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagepalettecopy.xml Sun Jan 14 03:15:21 2007 @@ -1,21 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.imagepalettecopy"> <refnamediv> <refname>imagepalettecopy</refname> <refpurpose>Copy the palette from one image to another</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>imagepalettecopy</methodname> <methodparam><type>resource</type><parameter>destination</parameter></methodparam> <methodparam><type>resource</type><parameter>source</parameter></methodparam> </methodsynopsis> <para> - <function>imagepalettecopy</function> copies the - palette from the <parameter>source</parameter> image - to the <parameter>destination</parameter> image. + <function>imagepalettecopy</function> copies the palette from the + <parameter>source</parameter> image to the + <parameter>destination</parameter> image. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>destination</parameter></term> + <listitem> + <para> + The destination image resource + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>source</parameter></term> + <listitem> + <para> + The source image resource + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagepng.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/image/functions/imagepng.xml diff -u phpdoc/en/reference/image/functions/imagepng.xml:1.7 phpdoc/en/reference/image/functions/imagepng.xml:1.8 --- phpdoc/en/reference/image/functions/imagepng.xml:1.7 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagepng.xml Sun Jan 14 03:15:21 2007 @@ -1,27 +1,48 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.imagepng"> <refnamediv> <refname>imagepng</refname> <refpurpose>Output a PNG image to either the browser or a file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagepng</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> <para> - <function>imagepng</function> creates the <acronym>PNG</acronym> - file in filename from the image <parameter>image</parameter>. The - <parameter>image</parameter> argument is the return from the - <function>imagecreate</function> or <literal>imagecreatefrom*</literal> - function. + Outputs or saves a <acronym>PNG</acronym> image from the given + <parameter>image</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The path to the saved file. If not set or &null;, the raw image stream + will be outputed directly. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> - The filename argument is optional, and if left off or filled - with a &null; value, the raw image stream will be output directly. <informalexample> <programlisting role="php"> <![CDATA[ @@ -33,9 +54,16 @@ </programlisting> </informalexample> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagegif</function>, <function>imagewbmp</function>, - <function>imagejpeg</function>, <function>imagetypes</function>. + <simplelist> + <member><function>imagegif</function></member> + <member><function>imagewbmp</function></member> + <member><function>imagejpeg</function></member> + <member><function>imagetypes</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagepolygon.xml?r1=1.11&r2=1.12&diff_format=u Index: phpdoc/en/reference/image/functions/imagepolygon.xml diff -u phpdoc/en/reference/image/functions/imagepolygon.xml:1.11 phpdoc/en/reference/image/functions/imagepolygon.xml:1.12 --- phpdoc/en/reference/image/functions/imagepolygon.xml:1.11 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagepolygon.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> +<!-- $Revision: 1.12 $ --> <refentry id="function.imagepolygon"> <refnamediv> <refname>imagepolygon</refname> - <refpurpose>Draw a polygon</refpurpose> + <refpurpose>Draws a polygon</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagepolygon</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -15,12 +15,52 @@ <methodparam><type>int</type><parameter>color</parameter></methodparam> </methodsynopsis> <para> - <function>imagepolygon</function> creates a polygon in image id. - <parameter>points</parameter> is a PHP array containing the - polygon's vertices, i.e. points[0] = x0, points[1] = y0, points[2] - = x1, points[3] = y1, etc. <parameter>num_points</parameter> is - the total number of points (vertices). + <function>imagepolygon</function> creates a polygon in the given + <parameter>image</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>points</parameter></term> + <listitem> + <para> + An array containing the polygon's vertices, i.e. points[0] = x0, + points[1] = y0, points[2] = x1, points[3] = y1, etc. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>num_points</parameter></term> + <listitem> + <para> + Total number of points (vertices) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + A color identifier created with + <function>imagecolorallocate</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imagepolygon</function> example</title> @@ -37,14 +77,13 @@ $col_poly = imagecolorallocate($image, 255, 255, 255); // draw the polygon -imagepolygon($image, - array ( - 0, 0, - 100, 200, - 300, 200 - ), - 3, - $col_poly); +imagepolygon($image, array ( + 0, 0, + 100, 200, + 300, 200 + ), + 3, + $col_poly); // output the picture header("Content-type: image/png"); @@ -55,9 +94,14 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecreate</function> and - <function>imagecreatetruecolor</function>. + <simplelist> + <member><function>imagecreate</function></member> + <member><function>imagecreatetruecolor</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagepsbbox.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/image/functions/imagepsbbox.xml diff -u phpdoc/en/reference/image/functions/imagepsbbox.xml:1.8 phpdoc/en/reference/image/functions/imagepsbbox.xml:1.9 --- phpdoc/en/reference/image/functions/imagepsbbox.xml:1.8 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagepsbbox.xml Sun Jan 14 03:15:21 2007 @@ -1,59 +1,89 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.imagepsbbox"> <refnamediv> <refname>imagepsbbox</refname> <refpurpose>Give the bounding box of a text rectangle using PostScript Type1 fonts</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imagepsbbox</methodname> <methodparam><type>string</type><parameter>text</parameter></methodparam> <methodparam><type>int</type><parameter>font</parameter></methodparam> <methodparam><type>int</type><parameter>size</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>space</parameter></methodparam> - <methodparam><type>int</type><parameter>tightness</parameter></methodparam> - <methodparam><type>float</type><parameter>angle</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>tightness</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>angle</parameter></methodparam> </methodsynopsis> <para> - <parameter>size</parameter> is expressed in pixels. + Gives the bounding box of a text rectangle using PostScript Type1 fonts. </para> <para> - <parameter>space</parameter> allows you to change the default - value of a space in a font. This amount is added to the normal - value and can also be negative. - </para> - <para> - <parameter>tightness</parameter> allows you to control the amount - of white space between characters. This amount is added to the - normal character width and can also be negative. - </para> - <para> - <parameter>angle</parameter> is in degrees. - </para> - <para> - Parameters <parameter>space</parameter> and - <parameter>tightness</parameter> are expressed in character space - units, where 1 unit is 1/1000th of an em-square. - </para> - <para> - Parameters <parameter>space</parameter>, - <parameter>tightness</parameter>, and <parameter>angle</parameter> - are optional. + The bounding box is calculated using information available from character + metrics, and unfortunately tends to differ slightly from the results + achieved by actually rasterizing the text. If the angle is 0 degrees, you + can expect the text to need 1 pixel more to every direction. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The bounding box is calculated using information available from - character metrics, and unfortunately tends to differ slightly - from the results achieved by actually rasterizing the text. If - the angle is 0 degrees, you can expect the text to need 1 pixel - more to every direction. + <variablelist> + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + &gd.font.description; + <varlistentry> + <term><parameter>size</parameter></term> + <listitem> + <para> + <parameter>size</parameter> is expressed in pixels. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>space</parameter></term> + <listitem> + <para> + Allows you to change the default value of a space in a font. This + amount is added to the normal value and can also be negative. + Expressed in character space units, where 1 unit is 1/1000th of an + em-square. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tightness</parameter></term> + <listitem> + <para> + <parameter>tightness</parameter> allows you to control the amount + of white space between characters. This amount is added to the + normal character width and can also be negative. + Expressed in character space units, where 1 unit is 1/1000th of an + em-square. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>angle</parameter></term> + <listitem> + <para> + <parameter>angle</parameter> is in degrees. + </para> + </listitem> + </varlistentry> + </variablelist> </para> - - &note.config.t1lib; - + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - This function returns an array containing the following elements: + Returns an array containing the following elements: <informaltable> <tgroup cols="2"> <tbody> @@ -77,8 +107,17 @@ </tgroup> </informaltable> </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + &note.config.t1lib; + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagepstext</function>. + <simplelist> + <member><function>imagepstext</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagepsencodefont.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/image/functions/imagepsencodefont.xml diff -u phpdoc/en/reference/image/functions/imagepsencodefont.xml:1.9 phpdoc/en/reference/image/functions/imagepsencodefont.xml:1.10 --- phpdoc/en/reference/image/functions/imagepsencodefont.xml:1.9 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagepsencodefont.xml Sun Jan 14 03:15:21 2007 @@ -1,25 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <refentry id="function.imagepsencodefont"> <refnamediv> <refname>imagepsencodefont</refname> <refpurpose>Change the character encoding vector of a font</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagepsencodefont</methodname> <methodparam><type>resource</type><parameter>font_index</parameter></methodparam> <methodparam><type>string</type><parameter>encodingfile</parameter></methodparam> </methodsynopsis> <para> - Loads a character encoding vector from a file and changes - the fonts encoding vector to it. As a PostScript fonts default - vector lacks most of the character positions above 127, you'll - definitely want to change this if you use an other language than - English. The exact format of this file is described in T1libs - documentation. T1lib comes with two ready-to-use files, - IsoLatin1.enc and IsoLatin2.enc. + Loads a character encoding vector from a file and changes the fonts + encoding vector to it. As a PostScript fonts default vector lacks most of + the character positions above 127, you'll definitely want to change this + if you use an other language than English. </para> <para> If you find yourself using this function all the time, a much @@ -28,9 +25,41 @@ to point to the right encoding file and all fonts you load will automatically have the right encoding. </para> - + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>font_index</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encodingfile</parameter></term> + <listitem> + <para> + The exact format of this file is described in T1libs documentation. + T1lib comes with two ready-to-use files, + <filename>IsoLatin1.enc</filename> and + <filename>IsoLatin2.enc</filename>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.config.t1lib; - </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagepsextendfont.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagepsextendfont.xml diff -u phpdoc/en/reference/image/functions/imagepsextendfont.xml:1.5 phpdoc/en/reference/image/functions/imagepsextendfont.xml:1.6 --- phpdoc/en/reference/image/functions/imagepsextendfont.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagepsextendfont.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagepsextendfont"> <refnamediv> <refname>imagepsextendfont</refname> <refpurpose>Extend or condense a font</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagepsextendfont</methodname> <methodparam><type>int</type><parameter>font_index</parameter></methodparam> @@ -17,9 +17,37 @@ the value of the <parameter>extend</parameter> parameter is less than one you will be condensing the font. </para> - + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>font_index</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>extend</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.config.t1lib; - </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagepsfreefont.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/image/functions/imagepsfreefont.xml diff -u phpdoc/en/reference/image/functions/imagepsfreefont.xml:1.8 phpdoc/en/reference/image/functions/imagepsfreefont.xml:1.9 --- phpdoc/en/reference/image/functions/imagepsfreefont.xml:1.8 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagepsfreefont.xml Sun Jan 14 03:15:21 2007 @@ -1,24 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.imagepsfreefont"> <refnamediv> <refname>imagepsfreefont</refname> <refpurpose>Free memory used by a PostScript Type 1 font</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagepsfreefont</methodname> <methodparam><type>resource</type><parameter>fontindex</parameter></methodparam> </methodsynopsis> <para> - <function>imagepsfreefont</function> frees memory used by a PostScript Type 1 font. + <function>imagepsfreefont</function> frees memory used by a PostScript + Type 1 font. </para> - + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fontindex</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.config.t1lib; - + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagepsloadfont</function>. + <simplelist> + <member><function>imagepsloadfont</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagepsloadfont.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/image/functions/imagepsloadfont.xml diff -u phpdoc/en/reference/image/functions/imagepsloadfont.xml:1.10 phpdoc/en/reference/image/functions/imagepsloadfont.xml:1.11 --- phpdoc/en/reference/image/functions/imagepsloadfont.xml:1.10 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagepsloadfont.xml Sun Jan 14 03:15:21 2007 @@ -1,22 +1,44 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <refentry id="function.imagepsloadfont"> <refnamediv> <refname>imagepsloadfont</refname> <refpurpose>Load a PostScript Type 1 font from file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>imagepsloadfont</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> <para> - In the case everything went right, a valid font index will be - returned and can be used for further purposes. Otherwise the - function returns &false; and prints a message describing what went - wrong, which you cannot read directly, while the output type is image. + Load a PostScript Type 1 font from the given + <parameter>filename</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + In the case everything went right, a valid font index will be returned and + can be used for further purposes. Otherwise the function returns &false;. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imagepsloadfont</function> example</title> @@ -38,11 +60,17 @@ </programlisting> </example> </para> - + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.config.t1lib; - + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagepsfreefont</function>. + <simplelist> + <member><function>imagepsfreefont</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagepsslantfont.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/image/functions/imagepsslantfont.xml diff -u phpdoc/en/reference/image/functions/imagepsslantfont.xml:1.6 phpdoc/en/reference/image/functions/imagepsslantfont.xml:1.7 --- phpdoc/en/reference/image/functions/imagepsslantfont.xml:1.6 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagepsslantfont.xml Sun Jan 14 03:15:21 2007 @@ -1,25 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imagepsslantfont"> <refnamediv> <refname>imagepsslantfont</refname> <refpurpose>Slant a font</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagepsslantfont</methodname> <methodparam><type>resource</type><parameter>font_index</parameter></methodparam> <methodparam><type>float</type><parameter>slant</parameter></methodparam> </methodsynopsis> <para> - Slant a font given by the <parameter>font_index</parameter> - parameter with a slant of the value of the - <parameter>slant</parameter> parameter. + Slant a given font given. </para> - + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>font_index</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>slant</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.config.t1lib; - </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagepstext.xml?r1=1.12&r2=1.13&diff_format=u Index: phpdoc/en/reference/image/functions/imagepstext.xml diff -u phpdoc/en/reference/image/functions/imagepstext.xml:1.12 phpdoc/en/reference/image/functions/imagepstext.xml:1.13 --- phpdoc/en/reference/image/functions/imagepstext.xml:1.12 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagepstext.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.12 $ --> +<!-- $Revision: 1.13 $ --> <refentry id="function.imagepstext"> <refnamediv> <refname>imagepstext</refname> - <refpurpose>To draw a text string over an image using PostScript Type1 fonts</refpurpose> + <refpurpose>Draws a text over an image using PostScript Type1 fonts</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imagepstext</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -18,91 +18,159 @@ <methodparam><type>int</type><parameter>x</parameter></methodparam> <methodparam><type>int</type><parameter>y</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>space</parameter></methodparam> - <methodparam><type>int</type><parameter>tightness</parameter></methodparam> - <methodparam><type>float</type><parameter>angle</parameter></methodparam> - <methodparam><type>int</type><parameter>antialias_steps</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>tightness</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>angle</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>antialias_steps</parameter></methodparam> </methodsynopsis> <para> - <parameter>foreground</parameter> is the color in which the text - will be painted. <parameter>Background</parameter> is the color - to which the text will try to fade in with antialiasing. No - pixels with the color <parameter>background</parameter> are - actually painted, so the background image does not need to be of - solid color. + Draws a text on an image using PostScript Type1 fonts. </para> <para> - The coordinates given by <parameter>x</parameter>, - <parameter>y</parameter> will define the origin (or reference - point) of the first character (roughly the lower-left corner of - the character). This is different from the - <function>imagestring</function>, where <parameter>x</parameter>, - <parameter>y</parameter> define the upper-right corner of the - first character. Refer to PostScript documentation about fonts and - their measuring system if you have trouble understanding how this - works. - </para> - <para> - <parameter>space</parameter> allows you to change the default - value of a space in a font. This amount is added to the normal - value and can also be negative. - </para> - <para> - <parameter>tightness</parameter> allows you to control the amount - of white space between characters. This amount is added to the - normal character width and can also be negative. - </para> - <para> - <parameter>angle</parameter> is in degrees. - </para> - <para> - <parameter>size</parameter> is expressed in pixels. - </para> - <para> - <parameter>antialias_steps</parameter> allows you to control the - number of colours used for antialiasing text. Allowed values are - 4 and 16. The higher value is recommended for text sizes lower - than 20, where the effect in text quality is quite visible. With - bigger sizes, use 4. It's less computationally intensive. - </para> - <para> - Parameters <parameter>space</parameter> and - <parameter>tightness</parameter> are expressed in character space - units, where 1 unit is 1/1000th of an em-square. + Refer to PostScript documentation about fonts and their measuring system + if you have trouble understanding how this works. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Parameters <parameter>space</parameter>, - <parameter>tightness</parameter>, <parameter>angle</parameter> - and <parameter>antialias_steps</parameter> are optional. + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + The text to be written. + </para> + </listitem> + </varlistentry> + &gd.font.description; + <varlistentry> + <term><parameter>size</parameter></term> + <listitem> + <para> + <parameter>size</parameter> is expressed in pixels. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>foreground</parameter></term> + <listitem> + <para> + The color in which the text will be painted. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>background</parameter></term> + <listitem> + <para> + The color to which the text will try to fade in with antialiasing. + No pixels with the color <parameter>background</parameter> are + actually painted, so the background image does not need to be of solid + color. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + x-coordinate for the lower-left corner of the first character + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + y-coordinate for the lower-left corner of the first character + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>space</parameter></term> + <listitem> + <para> + Allows you to change the default value of a space in a font. This + amount is added to the normal value and can also be negative. + Expressed in character space units, where 1 unit is 1/1000th of an + em-square. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tightness</parameter></term> + <listitem> + <para> + <parameter>tightness</parameter> allows you to control the amount + of white space between characters. This amount is added to the + normal character width and can also be negative. + Expressed in character space units, where 1 unit is 1/1000th of an + em-square. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>angle</parameter></term> + <listitem> + <para> + <parameter>angle</parameter> is in degrees. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>antialias_steps</parameter></term> + <listitem> + <para> + Allows you to control the number of colours used for antialiasing + text. Allowed values are 4 and 16. The higher value is recommended + for text sizes lower than 20, where the effect in text quality is + quite visible. With bigger sizes, use 4. It's less computationally + intensive. + </para> + </listitem> + </varlistentry> + </variablelist> </para> - - &note.config.t1lib; - + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> This function returns an array containing the following elements: <informaltable> - <tgroup cols="2"> - <tbody> - <row> - <entry>0</entry> - <entry>lower left x-coordinate</entry> - </row> - <row> - <entry>1</entry> - <entry>lower left y-coordinate</entry> - </row> - <row> - <entry>2</entry> - <entry>upper right x-coordinate</entry> - </row> - <row> - <entry>3</entry> - <entry>upper right y-coordinate</entry> - </row> - </tbody> - </tgroup> - </informaltable></para> + <tgroup cols="2"> + <tbody> + <row> + <entry>0</entry> + <entry>lower left x-coordinate</entry> + </row> + <row> + <entry>1</entry> + <entry>lower left y-coordinate</entry> + </row> + <row> + <entry>2</entry> + <entry>upper right x-coordinate</entry> + </row> + <row> + <entry>3</entry> + <entry>upper right y-coordinate</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + &note.config.t1lib; + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagepsbbox</function>. + <simplelist> + <member><function>imagepsbbox</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagerectangle.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagerectangle.xml diff -u phpdoc/en/reference/image/functions/imagerectangle.xml:1.5 phpdoc/en/reference/image/functions/imagerectangle.xml:1.6 --- phpdoc/en/reference/image/functions/imagerectangle.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagerectangle.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagerectangle"> <refnamediv> <refname>imagerectangle</refname> <refpurpose>Draw a rectangle</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagerectangle</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -14,13 +14,67 @@ <methodparam><type>int</type><parameter>y1</parameter></methodparam> <methodparam><type>int</type><parameter>x2</parameter></methodparam> <methodparam><type>int</type><parameter>y2</parameter></methodparam> - <methodparam><type>int</type><parameter>col</parameter></methodparam> + <methodparam><type>int</type><parameter>color</parameter></methodparam> </methodsynopsis> <para> - <function>imagerectangle</function> creates a rectangle of color - col in image <parameter>image</parameter> starting at upper left - coordinate x1, y1 and ending at bottom right coordinate x2, y2. - 0, 0 is the top left corner of the image. + <function>imagerectangle</function> creates a rectangle starting at + the specified coordinates. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>x1</parameter></term> + <listitem> + <para> + Upper left x coordinate + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y1</parameter></term> + <listitem> + <para> + Upper left y coordinate + 0, 0 is the top left corner of the image. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x2</parameter></term> + <listitem> + <para> + Bottom right x coordinate + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y2</parameter></term> + <listitem> + <para> + Bottom right y coordinate + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + A color identifier created with + <function>imagecolorallocate</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagerotate.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/image/functions/imagerotate.xml diff -u phpdoc/en/reference/image/functions/imagerotate.xml:1.7 phpdoc/en/reference/image/functions/imagerotate.xml:1.8 --- phpdoc/en/reference/image/functions/imagerotate.xml:1.7 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagerotate.xml Sun Jan 14 03:15:21 2007 @@ -1,23 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.imagerotate"> <refnamediv> <refname>imagerotate</refname> <refpurpose>Rotate an image with a given angle</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>imagerotate</methodname> - <methodparam><type>resource</type><parameter>src_im</parameter></methodparam> + <methodparam><type>resource</type><parameter>source_image</parameter></methodparam> <methodparam><type>float</type><parameter>angle</parameter></methodparam> <methodparam><type>int</type><parameter>bgd_color</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>ignore_transparent</parameter></methodparam> </methodsynopsis> <para> - Rotates the <parameter>src_im</parameter> image using a given - <parameter>angle</parameter> in degrees. <parameter>bgd_color</parameter> - specifies the color of the uncovered zone after the rotation. + Rotates the <parameter>source_image</parameter> image using the given + <parameter>angle</parameter> in degrees. </para> <para> The center of rotation is the center of the image, and the rotated @@ -25,10 +24,77 @@ destination image - the edges are not clipped. </para> <para> - If <parameter>ignore_transparent</parameter> is set and non-zero, - transparent colors are ignored (otherwise kept). This parameter was added - in PHP 5.1. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>source_image</parameter></term> + <listitem> + <para> + The source image link + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>angle</parameter></term> + <listitem> + <para> + Rotation angle, in degrees. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>bgd_color</parameter></term> + <listitem> + <para> + Specifies the color of the uncovered zone after the rotation + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>ignore_transparent</parameter></term> + <listitem> + <para> + If set and non-zero, transparent colors are ignored (otherwise kept). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + </para> + </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>5.1.0</entry> + <entry> + <parameter>ignore_transparent</parameter> was added. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Rotate an image 180 degrees</title> @@ -56,6 +122,9 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.bundled.gd; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagesavealpha.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/image/functions/imagesavealpha.xml diff -u phpdoc/en/reference/image/functions/imagesavealpha.xml:1.10 phpdoc/en/reference/image/functions/imagesavealpha.xml:1.11 --- phpdoc/en/reference/image/functions/imagesavealpha.xml:1.10 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagesavealpha.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <refentry id="function.imagesavealpha"> <refnamediv> <refname>imagesavealpha</refname> <refpurpose>Set the flag to save full alpha channel information (as opposed to single-color transparency) when saving PNG images</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagesavealpha</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -26,9 +26,38 @@ your browser, try to load your script with an alpha channel compliant browser, e.g. latest Mozilla. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>saveflag</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.gd.2; + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagealphablending</function>. + <simplelist> + <member><function>imagealphablending</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagesetbrush.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagesetbrush.xml diff -u phpdoc/en/reference/image/functions/imagesetbrush.xml:1.5 phpdoc/en/reference/image/functions/imagesetbrush.xml:1.6 --- phpdoc/en/reference/image/functions/imagesetbrush.xml:1.5 Sat Jan 13 17:11:45 2007 +++ phpdoc/en/reference/image/functions/imagesetbrush.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagesetbrush"> <refnamediv> <refname>imagesetbrush</refname> <refpurpose>Set the brush image for line drawing</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagesetbrush</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -26,7 +26,27 @@ colors until you have set a new brush image! </para> </note> - <note><para>This function was added in PHP 4.0.6</para></note> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>brush</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagesetpixel.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/image/functions/imagesetpixel.xml diff -u phpdoc/en/reference/image/functions/imagesetpixel.xml:1.7 phpdoc/en/reference/image/functions/imagesetpixel.xml:1.8 --- phpdoc/en/reference/image/functions/imagesetpixel.xml:1.7 Sat Jan 13 17:11:46 2007 +++ phpdoc/en/reference/image/functions/imagesetpixel.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.imagesetpixel"> <refnamediv> <refname>imagesetpixel</refname> <refpurpose>Set a single pixel</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagesetpixel</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -15,14 +15,56 @@ <methodparam><type>int</type><parameter>color</parameter></methodparam> </methodsynopsis> <para> - <function>imagesetpixel</function> draws a pixel at - <parameter>x</parameter>, <parameter>y</parameter> (top left is - 0, 0) in image <parameter>image</parameter> of color - <parameter>color</parameter>. + <function>imagesetpixel</function> draws a pixel at the specified + coordinate. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + x-coordinate + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + y-coordinate + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + A color identifier created with + <function>imagecolorallocate</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecreatetruecolor</function> and - <function>imagecolorallocate</function>. + <simplelist> + <member><function>imagecreatetruecolor</function></member> + <member><function>imagecolorallocate</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagesetstyle.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/image/functions/imagesetstyle.xml diff -u phpdoc/en/reference/image/functions/imagesetstyle.xml:1.9 phpdoc/en/reference/image/functions/imagesetstyle.xml:1.10 --- phpdoc/en/reference/image/functions/imagesetstyle.xml:1.9 Sat Jan 13 17:11:46 2007 +++ phpdoc/en/reference/image/functions/imagesetstyle.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <refentry id="function.imagesetstyle"> <refnamediv> <refname>imagesetstyle</refname> <refpurpose>Set the style for line drawing</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagesetstyle</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -17,10 +17,34 @@ line drawing functions (such as <function>imageline</function> and <function>imagepolygon</function>) when drawing with the special color <literal>IMG_COLOR_STYLED</literal> or lines of images with color - <literal>IMG_COLOR_STYLEDBRUSHED</literal>. &return.success; + <literal>IMG_COLOR_STYLEDBRUSHED</literal>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>style</parameter></term> + <listitem> + <para> + An array of pixel colors. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> - The <parameter>style</parameter> parameter is an array of pixels. Following example script draws a dashed line from upper left to lower right corner of the canvas: <example> @@ -55,10 +79,15 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagesetbrush</function>, <function>imageline</function>. + <simplelist> + <member><function>imagesetbrush</function></member> + <member><function>imageline</function></member> + </simplelist> </para> - <note><para>This function was added in PHP 4.0.6</para></note> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagesetthickness.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/image/functions/imagesetthickness.xml diff -u phpdoc/en/reference/image/functions/imagesetthickness.xml:1.6 phpdoc/en/reference/image/functions/imagesetthickness.xml:1.7 --- phpdoc/en/reference/image/functions/imagesetthickness.xml:1.6 Sat Jan 13 17:11:46 2007 +++ phpdoc/en/reference/image/functions/imagesetthickness.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imagesetthickness"> <refnamediv> <refname>imagesetthickness</refname> <refpurpose>Set the thickness for line drawing</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagesetthickness</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -15,8 +15,32 @@ <para> <function>imagesetthickness</function> sets the thickness of the lines drawn when drawing rectangles, polygons, ellipses etc. etc. to - <parameter>thickness</parameter> pixels. &return.success; + <parameter>thickness</parameter> pixels. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>thickness</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.gd.2; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagesettile.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/image/functions/imagesettile.xml diff -u phpdoc/en/reference/image/functions/imagesettile.xml:1.6 phpdoc/en/reference/image/functions/imagesettile.xml:1.7 --- phpdoc/en/reference/image/functions/imagesettile.xml:1.6 Sat Jan 13 17:11:46 2007 +++ phpdoc/en/reference/image/functions/imagesettile.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imagesettile"> <refnamediv> <refname>imagesettile</refname> <refpurpose>Set the tile image for filling</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagesettile</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -32,6 +32,28 @@ </para> </note> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>tile</parameter></term> + <listitem> + <para> + The image resource to be used as a tile + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagestring.xml?r1=1.12&r2=1.13&diff_format=u Index: phpdoc/en/reference/image/functions/imagestring.xml diff -u phpdoc/en/reference/image/functions/imagestring.xml:1.12 phpdoc/en/reference/image/functions/imagestring.xml:1.13 --- phpdoc/en/reference/image/functions/imagestring.xml:1.12 Sat Jan 13 17:11:46 2007 +++ phpdoc/en/reference/image/functions/imagestring.xml Sun Jan 14 03:15:21 2007 @@ -1,29 +1,75 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.12 $ --> +<!-- $Revision: 1.13 $ --> <refentry id="function.imagestring"> <refnamediv> <refname>imagestring</refname> <refpurpose>Draw a string horizontally</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagestring</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> <methodparam><type>int</type><parameter>font</parameter></methodparam> <methodparam><type>int</type><parameter>x</parameter></methodparam> <methodparam><type>int</type><parameter>y</parameter></methodparam> - <methodparam><type>string</type><parameter>s</parameter></methodparam> - <methodparam><type>int</type><parameter>col</parameter></methodparam> + <methodparam><type>string</type><parameter>sring</parameter></methodparam> + <methodparam><type>int</type><parameter>color</parameter></methodparam> </methodsynopsis> <para> - <function>imagestring</function> draws the string - <parameter>s</parameter> in the image identified by - <parameter>image</parameter> with the upper-left corner at coordinates - <parameter>x</parameter>, <parameter>y</parameter> (top left is - 0, 0) in color <parameter>col</parameter>. If font is 1, 2, 3, 4 - or 5, a built-in font is used. + Draws a <parameter>string</parameter> at the given coordinates. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + &gd.font.description; + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + x-coordinate of the upper left corner + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + y-coordinate of the upper left corner + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>sring</parameter></term> + <listitem> + <para> + The string to be written + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + A color identifier created with + <function>imagecolorallocate</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imagestring</function> example</title> @@ -48,9 +94,14 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imageloadfont</function>, and - <function>imagettftext</function>. + <simplelist> + <member><function>imageloadfont</function></member> + <member><function>imagettftext</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagestringup.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagestringup.xml diff -u phpdoc/en/reference/image/functions/imagestringup.xml:1.5 phpdoc/en/reference/image/functions/imagestringup.xml:1.6 --- phpdoc/en/reference/image/functions/imagestringup.xml:1.5 Sat Jan 13 17:11:46 2007 +++ phpdoc/en/reference/image/functions/imagestringup.xml Sun Jan 14 03:15:21 2007 @@ -1,31 +1,80 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagestringup"> <refnamediv> <refname>imagestringup</refname> <refpurpose>Draw a string vertically</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagestringup</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> <methodparam><type>int</type><parameter>font</parameter></methodparam> <methodparam><type>int</type><parameter>x</parameter></methodparam> <methodparam><type>int</type><parameter>y</parameter></methodparam> - <methodparam><type>string</type><parameter>s</parameter></methodparam> - <methodparam><type>int</type><parameter>col</parameter></methodparam> + <methodparam><type>string</type><parameter>string</parameter></methodparam> + <methodparam><type>int</type><parameter>color</parameter></methodparam> </methodsynopsis> <para> - <function>imagestringup</function> draws the string - <parameter>s</parameter> vertically in the image identified by - <parameter>image</parameter> at coordinates - <parameter>x</parameter>, <parameter>y</parameter> (top left is - 0, 0) in color <parameter>col</parameter>. If font is 1, 2, 3, 4 - or 5, a built-in font is used. + Draws a <parameter>string</parameter> vertically at the given + coordinates. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + &gd.font.description; + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + x-coordinate of the upper left corner + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + y-coordinate of the upper left corner + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>sring</parameter></term> + <listitem> + <para> + The string to be written + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + A color identifier created with + <function>imagecolorallocate</function> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imageloadfont</function>. + <simplelist> + <member><function>imageloadfont</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagesx.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/image/functions/imagesx.xml diff -u phpdoc/en/reference/image/functions/imagesx.xml:1.6 phpdoc/en/reference/image/functions/imagesx.xml:1.7 --- phpdoc/en/reference/image/functions/imagesx.xml:1.6 Sat Jan 13 17:11:46 2007 +++ phpdoc/en/reference/image/functions/imagesx.xml Sun Jan 14 03:15:21 2007 @@ -1,23 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imagesx"> <refnamediv> <refname>imagesx</refname> <refpurpose>Get image width</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imagesx</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> </methodsynopsis> <para> - <function>imagesx</function> returns the width of the image - identified by <parameter>image</parameter>. + Returns the width of the given <parameter>image</parameter> resource. </para> - <example> - <title>Using <function>imagesx</function></title> - <programlisting role="php"> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Return the width of the <parameter>image</parameter> or &false; on + errors. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Using <function>imagesx</function></title> + <programlisting role="php"> <![CDATA[ <?php @@ -28,12 +46,18 @@ ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecreatetruecolor</function>, - <function>getimagesize</function> and - <function>imagesy</function>. + <simplelist> + <member><function>imagecreatetruecolor</function></member> + <member><function>getimagesize</function></member> + <member><function>imagesy</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagesy.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/image/functions/imagesy.xml diff -u phpdoc/en/reference/image/functions/imagesy.xml:1.6 phpdoc/en/reference/image/functions/imagesy.xml:1.7 --- phpdoc/en/reference/image/functions/imagesy.xml:1.6 Sat Jan 13 17:11:46 2007 +++ phpdoc/en/reference/image/functions/imagesy.xml Sun Jan 14 03:15:21 2007 @@ -1,23 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imagesy"> <refnamediv> <refname>imagesy</refname> <refpurpose>Get image height</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imagesy</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> </methodsynopsis> <para> - <function>imagesy</function> returns the height of the image - identified by <parameter>image</parameter>. + Returns the height of the given <parameter>image</parameter> resource. </para> - <example> - <title>Using <function>imagesy</function></title> - <programlisting role="php"> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Return the height of the <parameter>image</parameter> or &false; on + errors. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Using <function>imagesy</function></title> + <programlisting role="php"> <![CDATA[ <?php @@ -28,12 +46,18 @@ ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagecreatetruecolor</function>, - <function>getimagesize</function> and - <function>imagesx</function>. + <simplelist> + <member><function>imagecreatetruecolor</function></member> + <member><function>getimagesize</function></member> + <member><function>imagesx</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagetruecolortopalette.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/image/functions/imagetruecolortopalette.xml diff -u phpdoc/en/reference/image/functions/imagetruecolortopalette.xml:1.6 phpdoc/en/reference/image/functions/imagetruecolortopalette.xml:1.7 --- phpdoc/en/reference/image/functions/imagetruecolortopalette.xml:1.6 Sat Jan 13 17:11:46 2007 +++ phpdoc/en/reference/image/functions/imagetruecolortopalette.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.imagetruecolortopalette"> <refnamediv> <refname>imagetruecolortopalette</refname> <refpurpose>Convert a true color image to a palette image</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagetruecolortopalette</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -23,15 +23,41 @@ usually best to simply produce a truecolor output image instead, which guarantees the highest output quality. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>dither</parameter> indicates if the image should be dithered - - if it is &true; then dithering will be used which will result in a more - speckled image but with better color approximation. + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>dither</parameter></term> + <listitem> + <para> + Indicates if the image should be dithered - if it is &true; then + dithering will be used which will result in a more speckled image but + with better color approximation. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>ncolors</parameter></term> + <listitem> + <para> + Sets the maximum number of colors that should be retained in the palette. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <parameter>ncolors</parameter> sets the maximum number of colors that - should be retained in the palette. + &return.success; </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.gd.2; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagettfbbox.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/image/functions/imagettfbbox.xml diff -u phpdoc/en/reference/image/functions/imagettfbbox.xml:1.8 phpdoc/en/reference/image/functions/imagettfbbox.xml:1.9 --- phpdoc/en/reference/image/functions/imagettfbbox.xml:1.8 Sat Jan 13 17:11:46 2007 +++ phpdoc/en/reference/image/functions/imagettfbbox.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.imagettfbbox"> <refnamediv> <refname>imagettfbbox</refname> <refpurpose>Give the bounding box of a text using TrueType fonts</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imagettfbbox</methodname> <methodparam><type>float</type><parameter>size</parameter></methodparam> @@ -17,99 +17,116 @@ <para> This function calculates and returns the bounding box in pixels for a TrueType text. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> <variablelist> - <varlistentry> - <term> - <parameter>size</parameter> - </term> - <listitem> - <simpara>The font size in pixels.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>angle</parameter> - </term> - <listitem> - <simpara> - Angle in degrees in which <parameter>text</parameter> will be - measured. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>fontfile</parameter> - </term> - <listitem> - <simpara> - The name of the TrueType font file (can be a URL). Depending on - which version of the GD library that PHP is using, it may attempt to - search for files that do not begin with a leading '/' by appending - '.ttf' to the filename and searching along a library-defined font path. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <parameter>text</parameter> - </term> - <listitem> - <simpara>The string to be measured.</simpara> - </listitem> - </varlistentry> + <varlistentry> + <term><parameter>size</parameter></term> + <listitem> + <para> + The font size in pixels + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>angle</parameter></term> + <listitem> + <para> + Angle in degrees in which <parameter>text</parameter> will be measured + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>fontfile</parameter></term> + <listitem> + <para> + The name of the TrueType font file (can be a URL). Depending on + which version of the GD library that PHP is using, it may attempt to + search for files that do not begin with a leading '/' by appending + '.ttf' to the filename and searching along a library-defined font path + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + The string to be measured + </para> + </listitem> + </varlistentry> </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> <function>imagettfbbox</function> returns an array with 8 elements representing four points making the bounding box of the text: <informaltable> - <tgroup cols="2"> - <tbody> - <row> - <entry>0</entry> - <entry>lower left corner, X position</entry> - </row> - <row> - <entry>1</entry> - <entry>lower left corner, Y position</entry> - </row> - <row> - <entry>2</entry> - <entry>lower right corner, X position</entry> - </row> - <row> - <entry>3</entry> - <entry>lower right corner, Y position</entry> - </row> - <row> - <entry>4</entry> - <entry>upper right corner, X position</entry> - </row> - <row> - <entry>5</entry> - <entry>upper right corner, Y position</entry> - </row> - <row> - <entry>6</entry> - <entry>upper left corner, X position</entry> - </row> - <row> - <entry>7</entry> - <entry>upper left corner, Y position</entry> - </row> - </tbody> - </tgroup> + <tgroup cols="2"> + <tbody> + <row> + <entry>0</entry> + <entry>lower left corner, X position</entry> + </row> + <row> + <entry>1</entry> + <entry>lower left corner, Y position</entry> + </row> + <row> + <entry>2</entry> + <entry>lower right corner, X position</entry> + </row> + <row> + <entry>3</entry> + <entry>lower right corner, Y position</entry> + </row> + <row> + <entry>4</entry> + <entry>upper right corner, X position</entry> + </row> + <row> + <entry>5</entry> + <entry>upper right corner, Y position</entry> + </row> + <row> + <entry>6</entry> + <entry>upper left corner, X position</entry> + </row> + <row> + <entry>7</entry> + <entry>upper left corner, Y position</entry> + </row> + </tbody> + </tgroup> </informaltable> - The points are relative to the <emphasis>text</emphasis> - regardless of the angle, so "upper left" means in the top - left-hand corner seeing the text horizontally. </para> <para> - This function requires both the GD library and the FreeType - library. + The points are relative to the <emphasis>text</emphasis> regardless of the + <parameter>angle</parameter>, so "upper left" means in the top left-hand + corner seeing the text horizontally. </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <note> + <para> + This function requires both the GD library and the <ulink + url="&url.freetype;">FreeType</ulink> library. + </para> + </note> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>imagettftext</function>. + <simplelist> + <member><function>imagettftext</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagettftext.xml?r1=1.20&r2=1.21&diff_format=u Index: phpdoc/en/reference/image/functions/imagettftext.xml diff -u phpdoc/en/reference/image/functions/imagettftext.xml:1.20 phpdoc/en/reference/image/functions/imagettftext.xml:1.21 --- phpdoc/en/reference/image/functions/imagettftext.xml:1.20 Sat Jan 13 17:11:46 2007 +++ phpdoc/en/reference/image/functions/imagettftext.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- $Revision: 1.20 $ --> +<!-- $Revision: 1.21 $ --> <refentry id="function.imagettftext"> <refnamediv> <refname>imagettftext</refname> <refpurpose>Write text to the image using TrueType fonts</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>imagettftext</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -19,38 +19,38 @@ <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> <para> + Writes the given <parameter>text</parameter> into the image using TrueType + fonts. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> <variablelist> - <varlistentry> - <term><parameter>image</parameter></term> - <listitem> - <simpara> - The image resource. See <function>imagecreatetruecolor</function>. - </simpara> - </listitem> - </varlistentry> + &gd.image.description; <varlistentry> <term><parameter>size</parameter></term> <listitem> - <simpara> + <para> The font size. Depending on your version of GD, this should be - specified as the pixel size (GD1) or point size (GD2). - </simpara> + specified as the pixel size (GD1) or point size (GD2) + </para> </listitem> </varlistentry> <varlistentry> <term><parameter>angle</parameter></term> <listitem> - <simpara> + <para> The angle in degrees, with 0 degrees being left-to-right reading text. - Higher values represent a counter-clockwise rotation. For example, - a value of 90 would result in bottom-to-top reading text. - </simpara> + Higher values represent a counter-clockwise rotation. For example, a + value of 90 would result in bottom-to-top reading text. + </para> </listitem> </varlistentry> <varlistentry> <term><parameter>x</parameter></term> <listitem> - <simpara> + <para> The coordinates given by <parameter>x</parameter> and <parameter>y</parameter> will define the basepoint of the first character (roughly the lower-left corner of the character). This @@ -58,48 +58,47 @@ <parameter>x</parameter> and <parameter>y</parameter> define the upper-left corner of the first character. For example, "top left" is 0, 0. - </simpara> + </para> </listitem> </varlistentry> <varlistentry> <term><parameter>y</parameter></term> <listitem> - <simpara> - The y-ordinate. This sets the position of the fonts baseline, not - the very bottom of the character. - </simpara> + <para> + The y-ordinate. This sets the position of the fonts baseline, not the + very bottom of the character. + </para> </listitem> </varlistentry> <varlistentry> <term><parameter>color</parameter></term> <listitem> - <simpara> - The color index. Using the negative of a color index has - the effect of turning off antialiasing. - See <function>imagecolorallocate</function>. - </simpara> + <para> + The color index. Using the negative of a color index has the effect of + turning off antialiasing. See <function>imagecolorallocate</function> + </para> </listitem> </varlistentry> <varlistentry> <term><parameter>fontfile</parameter></term> <listitem> - <simpara> + <para> The path to the TrueType font you wish to use. - </simpara> - <simpara> + </para> + <para> Depending on which version of the GD library PHP is using, <emphasis>when <parameter>fontfile</parameter> does not begin with a leading <literal>/</literal> then <literal>.ttf</literal> will be appended</emphasis> to the filename and the library will attempt to search for that filename along a library-defined font path. - </simpara> - <simpara> + </para> + <para> When using versions of the GD library lower than 2.0.18, a <literal>space</literal> character, rather than a semicolon, was used as the 'path separator' for different font files. Unintentional use of this feature will result in the warning message: <literal>Warning: Could not find/open font</literal>. For these affected versions, the only solution is moving the font to a path which does not contain spaces. - </simpara> + </para> <para> In many cases where a font resides in the same directory as the script using it the following trick will alleviate any include problems. @@ -108,7 +107,8 @@ <?php // Set the enviroment variable for GD putenv('GDFONTPATH=' . realpath('.')); - + The y-ordinate. This sets the position of the fonts baseline, not + the very bottom of the character. // Name the font to be used (note the lack of the .ttf extension) $font = 'SomeFont'; ?> @@ -120,35 +120,42 @@ <varlistentry> <term><parameter>text</parameter></term> <listitem> - <simpara> + <para> The text string. - </simpara> - <simpara> + </para> + <para> May include decimal numeric character references (of the form: &amp;#8364;) to access characters in a font beyond position 127. The hexadecimal format (like &amp;#xA9;) is supported as of PHP 5.2.0. Strings in UTF-8 encoding can be passed directly. - </simpara> - <simpara> - Named entities, such as &amp;copy;, are not supported. Consider using <function>html_entity_decode</function> - to decode these named entities into UTF-8 strings (html_entity_decode() supports this as of PHP 5.0.0). - </simpara> - <simpara> + </para> + <para> + Named entities, such as &amp;copy;, are not supported. Consider using + <function>html_entity_decode</function> + to decode these named entities into UTF-8 strings (html_entity_decode() + supports this as of PHP 5.0.0). + </para> + <para> If a character is used in the string which is not supported by the font, a hollow rectangle will replace the character. - </simpara> + </para> </listitem> </varlistentry> </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>imagettftext</function> returns an array with 8 - elements representing four points making the bounding box of the - text. The order of the points is lower left, lower right, upper - right, upper left. The points are relative to the text - regardless of the angle, so "upper left" means in the top - left-hand corner when you see the text horizontally. + Returns an array with 8 elements representing four points making the + bounding box of the text. The order of the points is lower left, lower + right, upper right, upper left. The points are relative to the text + regardless of the angle, so "upper left" means in the top left-hand + corner when you see the text horizontally. </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>imagettftext</function> example</title> @@ -190,12 +197,22 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function requires both the GD library and the <ulink + url="&url.freetype;">FreeType</ulink> library. + </para> + </note> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - This function requires both the GD library and the <ulink - url="&url.freetype;">FreeType</ulink> library. - </para> - <para> - See also <function>imagettfbbox</function>. + <simplelist> + <member><function>imagettfbbox</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagetypes.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/image/functions/imagetypes.xml diff -u phpdoc/en/reference/image/functions/imagetypes.xml:1.5 phpdoc/en/reference/image/functions/imagetypes.xml:1.6 --- phpdoc/en/reference/image/functions/imagetypes.xml:1.5 Sat Jan 13 17:11:46 2007 +++ phpdoc/en/reference/image/functions/imagetypes.xml Sun Jan 14 03:15:21 2007 @@ -1,24 +1,35 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.imagetypes"> <refnamediv> <refname>imagetypes</refname> <refpurpose>Return the image types supported by this PHP build</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>imagetypes</methodname> <void/> </methodsynopsis> <para> - This function returns a bit-field corresponding to the image - formats supported by the version of GD linked into PHP. The - following bits are returned, <constant>IMG_GIF</constant> | <constant>IMG_JPG</constant> - | <constant>IMG_PNG</constant> | <constant>IMG_WBMP</constant> | <constant>IMG_XPM</constant>. - To check for PNG support, for example, do this: + Returns the image types supported by the current PHP installation. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a bit-field corresponding to the image formats supported by the + version of GD linked into PHP. The following bits are returned, + <constant>IMG_GIF</constant> | <constant>IMG_JPG</constant> | + <constant>IMG_PNG</constant> | <constant>IMG_WBMP</constant> | + <constant>IMG_XPM</constant>. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> <example> - <title><function>imagetypes</function> example</title> + <title>Checking for PNG support</title> <programlisting role="php"> <![CDATA[ <?php http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagewbmp.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/image/functions/imagewbmp.xml diff -u phpdoc/en/reference/image/functions/imagewbmp.xml:1.7 phpdoc/en/reference/image/functions/imagewbmp.xml:1.8 --- phpdoc/en/reference/image/functions/imagewbmp.xml:1.7 Sat Jan 13 17:11:46 2007 +++ phpdoc/en/reference/image/functions/imagewbmp.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.imagewbmp"> <refnamediv> <refname>imagewbmp</refname> <refpurpose>Output image to browser or file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagewbmp</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> @@ -14,34 +14,62 @@ <methodparam choice="opt"><type>int</type><parameter>foreground</parameter></methodparam> </methodsynopsis> <para> - <function>imagewbmp</function> creates the - <acronym>WBMP</acronym> file in filename from the image - <parameter>image</parameter>. The <parameter>image</parameter> argument - is the return from the <function>imagecreatetruecolor</function> function. + <function>imagewbmp</function> outputs or save a <acronym>WBMP</acronym> + version of the given <parameter>image</parameter>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The filename argument is optional, and if left off or filled with a - &null; value, the raw image stream will be output directly. - By sending an <acronym>image/vnd.wap.wbmp</acronym> content-type - using <function>header</function>, you can create - a PHP script that outputs WBMP images directly. - <note> - <para> - WBMP support is only available if PHP was compiled - against GD-1.8 or later. - </para> - </note> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The path to the saved file. If not set or &null;, the raw image stream + will be outputed directly. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>foreground</parameter></term> + <listitem> + <para> + You can set the foreground color with this parameter by setting an + identifier obtained from <function>imagecolorallocate</function>. + The default foreground color is black. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - Using the optional <parameter>foreground</parameter> - parameter, you can set the foreground color. Use an - identifier obtained from <function>imagecolorallocate</function>. - The default foreground color is black. + &return.success; </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + WBMP support is only available if PHP was compiled against GD-1.8 or + later. + </para> + </note> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>image2wbmp</function>, <function>imagepng</function>, - <function>imagegif</function>, <function>imagejpeg</function>, - <function>imagetypes</function>. + <simplelist> + <member><function>image2wbmp</function></member> + <member><function>imagepng</function></member> + <member><function>imagegif</function></member> + <member><function>imagejpeg</function></member> + <member><function>imagetypes</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagexbm.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/image/functions/imagexbm.xml diff -u phpdoc/en/reference/image/functions/imagexbm.xml:1.4 phpdoc/en/reference/image/functions/imagexbm.xml:1.5 --- phpdoc/en/reference/image/functions/imagexbm.xml:1.4 Sat Jan 13 17:11:46 2007 +++ phpdoc/en/reference/image/functions/imagexbm.xml Sun Jan 14 03:15:21 2007 @@ -1,21 +1,59 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.imagexbm"> <refnamediv> <refname>imagexbm</refname> <refpurpose>Output XBM image to browser or file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>imagexbm</methodname> <methodparam><type>resource</type><parameter>image</parameter></methodparam> <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>foreground</parameter></methodparam> </methodsynopsis> - - &warn.undocumented.func; - &note.bundled.gd; + <para> + Outputs or save an <acronym>XBM</acronym> version of the given + <parameter>image</parameter>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &gd.image.description; + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The path to the saved file. If not set or &null;, the raw image stream + will be outputed directly. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>foreground</parameter></term> + <listitem> + <para> + You can set the foreground color with this parameter by setting an + identifier obtained from <function>imagecolorallocate</function>. + The default foreground color is black. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + &note.bundled.gd; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/iptcembed.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/image/functions/iptcembed.xml diff -u phpdoc/en/reference/image/functions/iptcembed.xml:1.4 phpdoc/en/reference/image/functions/iptcembed.xml:1.5 --- phpdoc/en/reference/image/functions/iptcembed.xml:1.4 Sat Jan 13 17:11:46 2007 +++ phpdoc/en/reference/image/functions/iptcembed.xml Sun Jan 14 03:15:21 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id='function.iptcembed'> <refnamediv> <refname>iptcembed</refname> <refpurpose>Embed binary IPTC data into a JPEG image</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>iptcembed</methodname> <methodparam><type>string</type><parameter>iptcdata</parameter></methodparam> @@ -17,6 +17,34 @@ &warn.undocumented.func; </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>iptcdata</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>jpeg_file_name</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>spool</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/iptcparse.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/image/functions/iptcparse.xml diff -u phpdoc/en/reference/image/functions/iptcparse.xml:1.2 phpdoc/en/reference/image/functions/iptcparse.xml:1.3 --- phpdoc/en/reference/image/functions/iptcparse.xml:1.2 Sat Jan 13 17:11:46 2007 +++ phpdoc/en/reference/image/functions/iptcparse.xml Sun Jan 14 03:15:21 2007 @@ -1,22 +1,49 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.iptcparse"> <refnamediv> <refname>iptcparse</refname> - <refpurpose>Parse a binary IPTC <ulink url="&url.iptc;">&url.iptc;</ulink> block into single tags.</refpurpose> + <refpurpose>Parse a binary IPTC block into single tags.</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>iptcparse</methodname> <methodparam><type>string</type><parameter>iptcblock</parameter></methodparam> </methodsynopsis> - <simpara> - This function parses a binary IPTC block into its single tags. It - returns an array using the tagmarker as an index and the value as - the value. It returns &false; on error or if no IPTC data was - found. See <function>getimagesize</function> for a sample. - </simpara> + <para> + Parses an <ulink url="&url.iptc;">IPTC</ulink> block into its single tags. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>iptcblock</parameter></term> + <listitem> + <para> + A binary IPTC block + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array using the tagmarker as an index and the value as the + value. It returns &false; on error or if no IPTC data was found. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>getimagesize</function> for an example</member> + </simplelist> + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/jpeg2wbmp.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/image/functions/jpeg2wbmp.xml diff -u phpdoc/en/reference/image/functions/jpeg2wbmp.xml:1.4 phpdoc/en/reference/image/functions/jpeg2wbmp.xml:1.5 --- phpdoc/en/reference/image/functions/jpeg2wbmp.xml:1.4 Sat Jan 13 17:11:46 2007 +++ phpdoc/en/reference/image/functions/jpeg2wbmp.xml Sun Jan 14 03:15:21 2007 @@ -1,33 +1,87 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.jpeg2wbmp"> <refnamediv> <refname>jpeg2wbmp</refname> <refpurpose>Convert JPEG image file to WBMP image file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>jpeg2wbmp</methodname> + <type>bool</type><methodname>jpeg2wbmp</methodname> <methodparam><type>string</type><parameter>jpegname</parameter></methodparam> <methodparam><type>string</type><parameter>wbmpname</parameter></methodparam> - <methodparam><type>int</type><parameter>d_height</parameter></methodparam> - <methodparam><type>int</type><parameter>d_width</parameter></methodparam> + <methodparam><type>int</type><parameter>dest_height</parameter></methodparam> + <methodparam><type>int</type><parameter>dest_width</parameter></methodparam> <methodparam><type>int</type><parameter>threshold</parameter></methodparam> </methodsynopsis> <para> - Converts the <parameter>jpegname</parameter> JPEG file - to WBMP format, and saves it as <parameter>wbmpname</parameter>. - With the <parameter>d_height</parameter> and - <parameter>d_width</parameter> you specify the height - and width of the destination image. + Converts a JPEG file into a WBMP file. </para> - - &note.config.jpeg; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>jpegname</parameter></term> + <listitem> + <para> + Path to JPEG file + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>wbmpname</parameter></term> + <listitem> + <para> + Path to destination WBMP file + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dest_height</parameter></term> + <listitem> + <para> + Destination image height + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dest_width</parameter></term> + <listitem> + <para> + Destination image width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>threshold</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.config.wbmp; - + &note.config.jpeg; + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>png2wbmp</function>. + <simplelist> + <member><function>png2wbmp</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/png2wbmp.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/image/functions/png2wbmp.xml diff -u phpdoc/en/reference/image/functions/png2wbmp.xml:1.4 phpdoc/en/reference/image/functions/png2wbmp.xml:1.5 --- phpdoc/en/reference/image/functions/png2wbmp.xml:1.4 Sat Jan 13 17:11:46 2007 +++ phpdoc/en/reference/image/functions/png2wbmp.xml Sun Jan 14 03:15:21 2007 @@ -1,30 +1,86 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.png2wbmp"> <refnamediv> <refname>png2wbmp</refname> <refpurpose>Convert PNG image file to WBMP image file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>png2wbmp</methodname> + <type>bool</type><methodname>png2wbmp</methodname> <methodparam><type>string</type><parameter>pngname</parameter></methodparam> <methodparam><type>string</type><parameter>wbmpname</parameter></methodparam> - <methodparam><type>int</type><parameter>d_height</parameter></methodparam> - <methodparam><type>int</type><parameter>d_width</parameter></methodparam> + <methodparam><type>int</type><parameter>dest_height</parameter></methodparam> + <methodparam><type>int</type><parameter>dest_width</parameter></methodparam> <methodparam><type>int</type><parameter>threshold</parameter></methodparam> </methodsynopsis> <para> - Converts the <parameter>pngname</parameter> PNG file - to WBMP format, and saves it as <parameter>wbmpname</parameter>. - With the <parameter>d_height</parameter> and - <parameter>d_width</parameter> you specify the height - and width of the destination image. + Converts a PNG file into a WBMP file. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>pngname</parameter></term> + <listitem> + <para> + Path to PNG file + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>wbmpname</parameter></term> + <listitem> + <para> + Path to destination WBMP file + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dest_height</parameter></term> + <listitem> + <para> + Destination image height + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dest_width</parameter></term> + <listitem> + <para> + Destination image width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>threshold</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; &note.config.wbmp; + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>jpeg2wbmp</function>. + <simplelist> + <member><function>jpeg2wbmp</function></member> + </simplelist> </para> </refsect1> </refentry>