<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.16 $ -->
<refentry xml:id="function.imagepstext" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imagepstext</refname>
  <refpurpose>Draws a text over an image using PostScript Type1 fonts</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <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>resource</type><parameter>font_index</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>
   Draws a text on an image using PostScript Type1 fonts.
  </para>
  <para>
   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>
   <variablelist>
    &gd.image.description;
    <varlistentry>
     <term><parameter>text</parameter></term>
     <listitem>
      <para>
       The text to be written.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>font_index</parameter></term>
     <listitem>
      <para>
       A font resource, returned by <function>imagepsloadfont</function>.
      </para>
     </listitem>
    </varlistentry>
    <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>
 </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>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>imagepstext</function> usage</title>
   <programlisting role="php">
<![CDATA[
<?php
// Create image handle
$im = imagecreatetruecolor(200, 200);

// Allocate colors
$black = imagecolorallocate($im, 0, 0, 0);
$white = imagecolorallocate($im, 255, 255, 255);

// Load the PostScript Font
$font = imagepsloadfont('font.pfm');

// Write the font to the image
imagepstext($im, 'Sample text is simple', $font, 12, $black, $white, 50, 50);

// Output and free memory
header('Content-type: image/png');

imagepng($im);
imagedestroy($im);
?>
]]>
   </programlisting>
  </example>
 </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;
  &note.config.t1lib;
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>imagepsbbox</function></member>
   </simplelist>
  </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
-->