Génère une image au format XBM

# imagexbm

(PHP 5, PHP 7, PHP 8)

imagexbm — Génère une image au format XBM

### Description

function imagexbm(GdImage `$image`, ?string `$filename`, ?int `$foreground_color` = `null`): bool

Affiche ou sauvegarde une version XBM de l'image `image`.

> Note: imagexbm() 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.

### Liste de paramètres

`image`
  Un objet GdImage, retournée par une des fonctions de création d'images, comme imagecreatetruecolor().
`filename`

  Chemin d'accès où le fichier sera enregistré, sous la forme d'une chaîne de caractères. S'il n'est pas défini, le flux d'images RAW sera directement affiché sur la sortie standard.

  Le nom de fichier `filename` (sans l'extension .xbm) est également utilisé pour les identificateurs C du XBM, auquel cas les caractères non alphanumériques des paramètres régionaux actuels sont remplacés par des tirets bas. Si `filename` a la valeur `null`, `image` est utilisé pour générer les identificateurs C.

`foreground_color`

  Il est possible de définir la couleur du premier plan avec ce paramètre, en utilisant un identifiant obtenu depuis la fonction imagecolorallocate(). Par défaut, la couleur du premier plan est noire. Toutes les autres couleurs sont traitées comme arrière-plan.

### Valeurs de retour

Cette fonction retourne `true` en cas de succès ou `false` si une erreur survient.

Attention

Toutefois, si libgd ne parvient pas à produire l'image, cette fonction retourne `true`.

### Historique

Version | Description
--- | ---
8.0.0 | `image` attend une instance de GdImage désormais; auparavant, une resource `gd` était attendue.
8.0.0 | `foreground_color` est désormais nullable.
8.0.0 | Le quatrième paramètre, qui n'était pas utilisé, a été supprimé.

### Exemples

Exemple #1 Sauvegarde d'un fichier XBM

    <?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');

    ?>

Exemple #2 Sauvegarde d'un fichier XBM avec une couleur de premier plan différente

    <?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);

    ?>

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open