cvs: phpdoc /en/reference/image/functions imagefttext.xml

From: Date: Wed, 28 Nov 2007 20:55:15 +0000
Subject: cvs: phpdoc /en/reference/image/functions imagefttext.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-479@lists.php.net to get a copy of this message
preinheimer Wed Nov 28 20:55:15 2007 UTC Modified files: /phpdoc/en/reference/image/functions imagefttext.xml Log: Added a basic framework, want to add an example later Lots of stuff stolen from imagettftext http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/image/functions/imagefttext.xml?r1=1.12&r2=1.13&diff_format=u Index: phpdoc/en/reference/image/functions/imagefttext.xml diff -u phpdoc/en/reference/image/functions/imagefttext.xml:1.12 phpdoc/en/reference/image/functions/imagefttext.xml:1.13 --- phpdoc/en/reference/image/functions/imagefttext.xml:1.12 Sat Oct 13 20:13:59 2007 +++ phpdoc/en/reference/image/functions/imagefttext.xml Wed Nov 28 20:55:15 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.12 $ --> +<!-- $Revision: 1.13 $ --> <refentry xml:id='function.imagefttext' xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>imagefttext</refname> @@ -14,12 +14,11 @@ <methodparam><type>float</type><parameter>angle</parameter></methodparam> <methodparam><type>int</type><parameter>x</parameter></methodparam> <methodparam><type>int</type><parameter>y</parameter></methodparam> - <methodparam><type>int</type><parameter>col</parameter></methodparam> + <methodparam><type>int</type><parameter>color</parameter></methodparam> <methodparam><type>string</type><parameter>font_file</parameter></methodparam> <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; @@ -29,14 +28,16 @@ <varlistentry> <term><parameter>size</parameter></term> <listitem> - <para> + <para>The font size to use in points </para> </listitem> </varlistentry> <varlistentry> <term><parameter>angle</parameter></term> <listitem> - <para> + <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. </para> </listitem> </varlistentry> @@ -44,6 +45,13 @@ <term><parameter>x</parameter></term> <listitem> <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 + is different from the <function>imagestring</function>, where + <parameter>x</parameter> and <parameter>y</parameter> define the + upper-left corner of the first character. For example, "top left" + is 0, 0. </para> </listitem> </varlistentry> @@ -51,13 +59,16 @@ <term><parameter>y</parameter></term> <listitem> <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>col</parameter></term> + <term><parameter>color</parameter></term> <listitem> <para> + The index of the desired color for the text, see <function>iamgecolorexact</function> </para> </listitem> </varlistentry> @@ -65,6 +76,7 @@ <term><parameter>font_file</parameter></term> <listitem> <para> + The full path to the font being used. </para> </listitem> </varlistentry> @@ -72,6 +84,7 @@ <term><parameter>text</parameter></term> <listitem> <para> + Text to be inserted into image. </para> </listitem> </varlistentry> @@ -88,7 +101,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - This function returns an array containing the following elements: + This function returns an array defining the four points of the box, starting in the lower left and moving counter-clockwise: <informaltable> <tgroup cols="2"> <tbody>

« previous php.doc.cvs (#479) next »