imagefttext.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 235f3d10c6151423fb0e03f090d335e336aa31fc Maintainer: seros Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id='function.imagefttext' xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imagefttext</refname>
  <refpurpose>Escribir texto en la imagen usando fuentes mediante FreeType 2</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>imagefttext</methodname>
   <methodparam><type>resource</type><parameter>image</parameter></methodparam>
   <methodparam><type>float</type><parameter>size</parameter></methodparam>
   <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>color</parameter></methodparam>
   <methodparam><type>string</type><parameter>fontfile</parameter></methodparam>
   <methodparam><type>string</type><parameter>text</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>extrainfo</parameter></methodparam>
  </methodsynopsis>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &gd.image.description;
    <varlistentry>
     <term><parameter>size</parameter></term>
     <listitem>
      <para>
       El tamaño de la fuente que va a ser usada, en puntos.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>angle</parameter></term>
     <listitem>
      <para> 
       El ángulo en grados, siendo 0 grados la lectura del texto de izquierda a derecha.
       Valores mayores representan una rotación en sentido contrario al de las agujas del reloj.
       Por ejemplo, un valor de 90 resultaria en la lectura de texto de abajo a arriba.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>x</parameter></term>
     <listitem>
      <para>
       Las coordenadas dadas por <parameter>x</parameter> e
       <parameter>y</parameter> definirán el punto de referencia del primer
       carácter (aproximadamente la esquina inferior izquierda del carácter). Esto
       es diferente de <function>imagestring</function>, donde
       <parameter>x</parameter> e <parameter>y</parameter> definen la
       esquina superior izquierda del primer carácter. Por ejemplo, "superior izquierda"
       es 0, 0.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>y</parameter></term>
     <listitem>
      <para>
       La coordenada y. Esto establece la posición de la línea base de las fuentes, no la del
       pie del carácter.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>color</parameter></term>
     <listitem>
      <para>
       El índice del color deseado para el texto, véase
       <function>imagecolorexact</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>fontfile</parameter></term>
     <listitem>
      <para>
       La ruta de la fuente TrueType que se desea usar.
      </para>
      <para>
       Dependiendo de la versión de GD que esté usando PHP, <emphasis>cuando
       <parameter>fontfile</parameter> no comienza con un
       <literal>/</literal> inicial, <literal>.ttf</literal> será añadido</emphasis>
       al nombre de archivo, y la biblioteca intentará buscar ese
       nombre de archivo en una ruta de biblioteca definida de fuentes.
      </para>
      <para>
       Cuando se usan versiones de la biblioteca GD anteriores a 2.0.18, un carácter
       <literal>espacio</literal>, en vez de un punto y coma, es usado como el 'separador de ruta'
       para diferentes archivos de fuente. El uso involuntario de esta característica resultará en
       en el mensaje de advertencia: <literal>Warning: Could not find/open font</literal>.
       La única solución para estas versiones afectadas es mover la fuente a una ruta que no
       contenga espacios.
      </para>
      <para>
       En muchos casos donde una fuente reside en el mismo derectorio que el script,
       el siguiente truco paliará cualquier problema de inclusión.
       <programlisting role="php">
<![CDATA[
<?php
// Establecer la variable de entorno para GD
putenv('GDFONTPATH=' . realpath('.'));

// Nombrar la fuente que va ser usada (observe la ausencia de la extensión .ttf)
$fuente = 'UnaFuente';
?>
]]>
       </programlisting>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>text</parameter></term>
     <listitem>
      <para>
       Texto que va a ser insertado en la imagen. 
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>extrainfo</parameter></term>
     <listitem>
      <para>
       <table>
       <title>Posibles índeces de matriz para <parameter>extrainfo</parameter></title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Clave</entry>
           <entry>Tipo</entry>
           <entry>Significado</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><literal>linespacing</literal></entry>
           <entry><type>float</type></entry>
           <entry>Define el espacio entre líneas</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Esta función devuelve una matriz que define los cuatro puntos de la caja, comenzado por el
   inferior izquierdo y moviéndose en el sentido de las agujas del reloj:
   <informaltable>
    <tgroup cols="2">
     <tbody>
      <row>
       <entry>0</entry>
       <entry>esquina inferior izquierda, posición X</entry>
      </row>
      <row>
       <entry>1</entry>
       <entry>esquina inferior izquierda, posición Y</entry>
      </row>
      <row>
       <entry>2</entry>
       <entry>esquina inferior derecha, posición X</entry>
      </row>
      <row>
       <entry>3</entry>
       <entry>esquina inferior derecha, posición Y</entry>
      </row>
      <row>
       <entry>4</entry>
       <entry>esquina superior derecha, posición X</entry>
      </row>
      <row>
       <entry>5</entry>
       <entry>esquina superior derecha, posición Y</entry>
      </row>
      <row>
       <entry>6</entry>
       <entry>esquina superior izquierda, posición X</entry>
      </row>
      <row>
       <entry>7</entry>
       <entry>esquina superior izquierda posición Y</entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>imagefttext</function></title>
    <programlisting role="php">
<![CDATA[
<?php
// Crear una imagen de 300x100
$im = imagecreatetruecolor(300, 100);
$rojo = imagecolorallocate($im, 0xFF, 0x00, 0x00);
$negro = imagecolorallocate($im, 0x00, 0x00, 0x00);

// Hacer el fondo rojo
imagefilledrectangle($im, 0, 0, 299, 99, $rojo);

// Ruta a nuestro archivo de fuente ttf
$archivo_fuente = './arial.ttf';

// Dibuja el texto 'PHP Manual' usando un tamaño de fuente de 13
imagefttext($im, 13, 0, 105, 55, $negro, $archivo_fuente, 'PHP Manual');

// Imprimir la imagen al navegador
header('Content-Type: image/png');

imagepng($im);
imagedestroy($im);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;
  &note.freetype;
 </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:"~/.phpdoc/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
-->