imageloadfont.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.imageloadfont">
 <refnamediv>
  <refname>imageloadfont</refname>
  <refpurpose>Load a new font</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>imageloadfont</methodname>
   <methodparam><type>string</type><parameter>file</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>imageloadfont</function> loads a user-defined bitmap and returns
   its identifier.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>file</parameter></term>
     <listitem>
      <para>
       The font file format is currently binary and architecture
       dependent.  This means you should generate the font files on the
       same type of CPU as the machine you are running PHP on.
      </para>
      <para>
       <table>
        <title>Font file format</title>
        <tgroup cols="3">
         <thead>
         <row>
          <entry>byte position</entry>
          <entry>C data type</entry>
          <entry>description</entry>
         </row>
         </thead>
         <tbody>
          <row>
           <entry>byte 0-3</entry>
           <entry>int</entry>
           <entry>number of characters in the font</entry>
          </row>
          <row>
           <entry>byte 4-7</entry>
           <entry>int</entry>
           <entry>
            value of first character in the font (often 32 for space)
           </entry>
          </row>
          <row>
           <entry>byte 8-11</entry>
           <entry>int</entry>
           <entry>pixel width of each character</entry>
          </row>
          <row>
           <entry>byte 12-15</entry>
           <entry>int</entry>
           <entry>pixel height of each character</entry>
          </row>
          <row>
           <entry>byte 16-</entry>
           <entry>char</entry>
           <entry>
            array with character data, one byte per pixel in each
            character, for a total of (nchars*width*height) bytes.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The font identifier which is always bigger than 5 to avoid conflicts with
   built-in fonts or &false; on errors.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>imageloadfont</function> usage example</title>
    <programlisting role="php">
<![CDATA[
<?php
// Create a new image instance
$im = imagecreatetruecolor(50, 20);
$black = imagecolorallocate($im, 0, 0, 0);
$white = imagecolorallocate($im, 255, 255, 255);

// Make the background white
imagefilledrectangle($im, 0, 0, 49, 19, $white);

// Load the gd font and write 'Hello'
$font = imageloadfont('./04b.gdf');
imagestring($im, $font, 0, 0, 'Hello', $black);

// Output to browser
header('Content-type: image/png');

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