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

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 593ea510e853ff034e03f78a4be0daa41661c9d4 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="function.imagexbm" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imagexbm</refname>
  <refpurpose>Génère une image au format XBM</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>imagexbm</methodname>
   <methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>filename</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>foreground_color</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Affiche ou sauvegarde une version <acronym>XBM</acronym>
   de l'image <parameter>image</parameter>.
  </para>
  <note>
   <simpara>
    <function>imagexbm</function> n'applique pas de rembourrage, de sorte que 
    la largeur de l'image doit être un multiple de 8. Cette restriction ne 
    s'applique plus à partir de PHP 7.0.9, respectivement.
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &gd.image.description;
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Chemin d'accès où le fichier sera enregistré, sous la forme
       d'une &string;. S'il n'est pas défini, le flux d'images RAW sera
       directement affiché sur la sortie standart.
      </para>
      <para>
       Le nom de fichier <parameter>filename</parameter> (sans l'extension .xbm) 
       est également utilisé pour les identificateur C du<acronym>XBM</acronym>, 
       auquel cas les caractères non alphanumériques des paramètres régionaux 
       actuels sont remplacés par des soulignements. Si 
       <parameter>filename</parameter> a la valeur null, 
       <literal>image</literal> est utilisée pour générer les identificateurs C.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>foreground_color</parameter></term>
     <listitem>
      <para>
       Vous pouvez définir le premier plan avec ce paramètre en définissant
       un identifiant obtenu depuis la fonction <function>imagecolorallocate</function>.
       Par défaut, la couleur du premier plan est noir. Toutes les autres 
       couleurs sont traitées comme arrière-plan.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
  &gd.return.trueonerror;
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &gd.changelog.image-param;
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>foreground_color</parameter> est désormais nullable.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       Le quatrième paramètre, qui n'était pas utilisé, a été supprimé.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Sauvegarde d'un fichier XBM</title>
    <programlisting role="php">
<![CDATA[
<?php
// Création d'une image vide et ajout d'un texte
$im = imagecreatetruecolor(120, 20);
$text_color = imagecolorallocate($im, 233, 14, 91);
imagestring($im, 1, 5, 5,  'Un texte simple', $text_color);

// Sauvegarde de l'image
imagexbm($im, 'simpletext.xbm');

// Libération de la mémoire
imagedestroy($im);
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Sauvegarde d'un fichier XBM avec une couleur de premier-plan différente</title>
    <programlisting role="php">
<![CDATA[
<?php
// Création d'une image vide et ajout d'un texte
$im = imagecreatetruecolor(120, 20);
$text_color = imagecolorallocate($im, 233, 14, 91);
imagestring($im, 1, 5, 5,  'Un texte simple', $text_color);

// Définit la couleur de premier-plan
$foreground_color = imagecolorallocate($im, 255, 0, 0);

// Sauvegarde de l'image
imagexbm($im, NULL, $foreground_color);

// Libération de la mémoire
imagedestroy($im);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
 </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
-->