doc-fr/reference/image/functions/imagepstext.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.24 $ -->
<!-- EN-Revision: 1.17 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="function.imagepstext" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imagepstext</refname>
  <refpurpose>Dessine un texte sur une image avec une police PostScript Type1</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><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>tightness</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>float</type><parameter>angle</parameter><initializer>0.0</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>antialias_steps</parameter><initializer>4</initializer></methodparam>
  </methodsynopsis>
  <para>
   Dessine un texte sur une image avec une police PostScript Type1.
  </para>
  <para>
   Reportez-vous à la documentation PostScript pour avoir des détails à
   propos des polices et de leurs tailles.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &gd.image.description;
    <varlistentry>
     <term><parameter>text</parameter></term>
     <listitem>
      <para>
       Le texte à écrire.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>font_index</parameter></term>
     <listitem>
      <para>
       Une ressource de police, retournée par la fonction
       <function>imagepsloadfont</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>size</parameter></term>
     <listitem>
      <para>
       <parameter>size</parameter> est exprimé en pixels.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>foreground</parameter></term>
     <listitem>
      <para>
       La couleur avec laquelle le texte va être dessiné.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>background</parameter></term>
     <listitem>
      <para>
       La couleur d'antialiasing. Aucun pixel avec la couleur
       <parameter>background</parameter> n'est dessiné, ce
       qui fait que l'arrière-plan n'a pas besoin d'être dans une couleur fixe.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>x</parameter></term>
     <listitem>
      <para>
       X : coordonnée du coin en bas, à gauche du premier caractère.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>y</parameter></term>
     <listitem>
      <para>
       Y : coordonnée du coin en bas, à gauche du premier caractère.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>space</parameter></term>
     <listitem>
      <para>
       Permet de changer la taille par défaut du caractère d'espacement.
       Cette valeur peut être négative. Exprimé en unité d'espaces caractère,
       ce qui vaut 1/1000ème d'un em-carré (un em : unité de mesure
       représentée par un carré dont la dimension horizontale est la même
       que le corps du caractère).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>tightness</parameter></term>
     <listitem>
      <para>
       Permet de contrôler la quantité d'espace entre deux caractères.
       Cette valeur peut être négative. Exprimé en unité d'espaces caractère,
       ce qui vaut 1/1000ème d'un em-carré.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>angle</parameter></term>
     <listitem>
      <para>
       <parameter>angle</parameter> est en degrés.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>antialias_steps</parameter></term>
     <listitem>
      <para>
       Permet de contrôler le nombre de couleurs du texte antialiasé.
       Les valeurs autorisées sont 4 et 16. 16 est recommandée pour
       les polices de moins de 20 pixels, car l'effet est alors visible. Avec les
       tailles plus grandes, utilisez de préférence 4, qui est moins gourmande en
       ressources.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Cette fonction retourne un tableau contenant les éléments suivants :
   <informaltable>
    <tgroup cols="2">
     <tbody>
      <row>
       <entry>0</entry>
       <entry>Abscisse inférieure gauche</entry>
      </row>
      <row>
       <entry>1</entry>
       <entry>Ordonnée inférieure gauche</entry>
      </row>
      <row>
       <entry>2</entry>
       <entry>Abscisse supérieure droite</entry>
      </row>
      <row>
       <entry>3</entry>
       <entry>Ordonnée supérieure droite</entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Exemple avec <function>imagepstext</function></title>
   <programlisting role="php">
<![CDATA[
<?php
// Création d'une nouvelle image
$im = imagecreatetruecolor(200, 200);

// Alloue les couleurs
$black = imagecolorallocate($im, 0, 0, 0);
$white = imagecolorallocate($im, 255, 255, 255);

// Charge la police PostScript
$font = imagepsloadfont('font.pfm');

// Dessine un texte dans l'image
imagepstext($im, 'Un texte simple', $font, 12, $black, $white, 50, 50);

// Affichage et libération de la mémoire
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
-->