php-doc-en/reference/image/functions/imagepsbbox.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imagepsbbox" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imagepsbbox</refname>
  <refpurpose>Give the bounding box of a text rectangle using PostScript Type1 fonts</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>imagepsbbox</methodname>
   <methodparam><type>string</type><parameter>text</parameter></methodparam>
   <methodparam><type>resource</type><parameter>font</parameter></methodparam>
   <methodparam><type>int</type><parameter>size</parameter></methodparam>
  </methodsynopsis>
  <methodsynopsis>
   <type>array</type><methodname>imagepsbbox</methodname>
   <methodparam><type>string</type><parameter>text</parameter></methodparam>
   <methodparam><type>resource</type><parameter>font</parameter></methodparam>
   <methodparam><type>int</type><parameter>size</parameter></methodparam>
   <methodparam><type>int</type><parameter>space</parameter></methodparam>
   <methodparam><type>int</type><parameter>tightness</parameter></methodparam>
   <methodparam><type>float</type><parameter>angle</parameter></methodparam>
  </methodsynopsis>
  <para>
   Gives the bounding box of a text rectangle using PostScript Type1 fonts.
  </para>
  <para>
   The bounding box is calculated using information available from character
   metrics, and unfortunately tends to differ slightly from the results 
   achieved by actually rasterizing the text. If the angle is 0 degrees, you
   can expect the text to need 1 pixel more to every direction.
  </para>
  &warn.removed.function-7-0-0;
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <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>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>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an array containing the following elements:
   <informaltable>
    <tgroup cols="2">
     <tbody>
      <row>
       <entry>0</entry>
       <entry>left x-coordinate</entry>
      </row>
      <row>
       <entry>1</entry>
       <entry>upper y-coordinate</entry>
      </row>
      <row>
       <entry>2</entry>
       <entry>right x-coordinate</entry>
      </row>
      <row>
       <entry>3</entry>
       <entry>lower y-coordinate</entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>imagepsbbox</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');

// Make a bounding box for the font
$bbox = imagepsbbox('Sample text is simple', $font, 12);

// Define our X and Y cordinates
$x = ($bbox[2] / 2) - 10;
$y = ($bbox[3] / 2) - 10;

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

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

imagepng($im);
imagedestroy($im);
?>
]]>
   </programlisting>
  </example>
 </refsect1>
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>7.0.0</entry>
       <entry>
        T1Lib support was removed from PHP, thrus removing this function.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;
  &note.config.t1lib;
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>imagepstext</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:"~/.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
-->