Added a basic framework, want to add an example later

Lots of stuff stolen from imagettftext


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@247258 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Paul Reinheimer 2007-11-28 20:55:15 +00:00
parent c6a8b76289
commit cc36996de9

View file

@ -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>