Descripción

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

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

Nota: 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.

Precaución

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 resource `gd` 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

Ejemplo #1 Guardar un fichero XBM

<?php
// Creación de una imagen vacía y adición de texto
$im = imagecreatetruecolor(120, 20);
$text_color = imagecolorallocate($im, 233, 14, 91);
imagestring($im, 1, 5, 5,  'Un texto simple', $text_color);

// Guardar la imagen
imagexbm($im, 'simpletext.xbm');

?>

Ejemplo #2 Guardar un fichero XBM con un color de primer plano diferente

<?php
// Creación de una imagen vacía y adición de texto
$im = imagecreatetruecolor(120, 20);
$text_color = imagecolorallocate($im, 233, 14, 91);
imagestring($im, 1, 5, 5,  'Un texto simple', $text_color);

// Definir el color de primer plano
$foreground_color = imagecolorallocate($im, 255, 0, 0);

// Guardar la imagen
imagexbm($im, NULL, $foreground_color);

?>