imagexbm

imagexbm(GdImage $image, string $filename, [int $foreground_color]): bool
```php

Muestra o guarda una versión XBM de la imagen `image`.

> [!NOTE]
> `imagexbm` no aplica relleno, por lo que el ancho de la imagen debe ser un múltiplo de 8. Esta restricción ya no se aplica a partir de PHP 7.0.9, respectivamente.

## Parámetros

`image`  
Un objeto `GdImage`, retornado por una de las funciones de creación de imágenes, como `imagecreatetruecolor`.

`filename`  
Ruta de acceso donde se guardará el fichero, en forma de `string`. Si no está definido, el flujo de imágenes RAW se mostrará directamente en la salida estándar.

El nombre de fichero `filename` (sin la extensión .xbm) también se utiliza para los identificadores C del XBM, en cuyo caso los caracteres no alfanuméricos de la configuración local actual son reemplazados por subrayados. Si `filename` tiene el valor null, `image` se utiliza para generar los identificadores C.

`foreground_color`  
Puede definirse el primer plano con este parámetro definiendo un identificador obtenido desde la función `imagecolorallocate`. Por omisión, el color del primer plano es negro. Todas las demás colores se tratan como fondo.

## Valores devueltos

Esta función retorna `true` en caso de éxito o `false` si ocurre un error.

> [!CAUTION]
> Sin embargo, si libgd no logra producir la imagen, esta función devuelve `true`.

## Historial de cambios

| Versión | Descripción |
|----|----|
| 8.0.0 | `image` ahora espera una instancia de `GdImage` ; anteriormente, se esperaba un recurso `gd` de tipo `resource` válido. |
| 8.0.0 | `foreground_color` ahora es nullable. |
| 8.0.0 | El cuarto parámetro, que no se utilizaba, ha sido eliminado. |

## Ejemplos

Guardar un fichero XBM

Guardar un fichero XBM con un color de primer plano diferente