php-doc-en/reference/image/functions/imagepstext.xml
Damien Seguy 7f332c3b50 turning im to image
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@114903 c90b9560-bf6c-de11-be94-00142212c4b1
2003-02-06 02:20:19 +00:00

135 lines
4.9 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/image.xml, last change in rev 1.2 -->
<refentry id="function.imagepstext">
<refnamediv>
<refname>imagepstext</refname>
<refpurpose>To draw a text string over an image using PostScript Type1 fonts</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>imagepstext</methodname>
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
<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><type>int</type><parameter>foreground</parameter></methodparam>
<methodparam><type>int</type><parameter>background</parameter></methodparam>
<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 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.
</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 PostScipt 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.
</para>
<para>
Parameters <parameter>space</parameter>,
<parameter>tightness</parameter>, <parameter>angle</parameter>
and <parameter>antialias</parameter> are optional.
</para>
<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>
<para>
See also <function>imagepsbbox</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->