PHPerKaigi 2025

imagexbm

(PHP 5, PHP 7, PHP 8)

imagexbm Выводит XBM-изображение в браузер или в файл

Описание

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

Функция выводит или сохраняет XBM-версию изображения image.

Замечание: Функция imagexbm() не применяет отступов, поэтому ширина изображения должна быть кратна 8. Начиная с PHP 7.0.9 функция больше не применяет это ограничение.

Список параметров

image

Объект GdImage, который возвращает одна из функций, создающих изображения, например, imagecreatetruecolor().

filename

Путь в виде значения с типом string, по которому требуется сохранить файл. Со значением null функция выведет поток необработанного изображения напрямую.

По названию файла в аргументе filename без расширения .xbm функция также строит C-идентификаторы XBM-файла, при этом небуквенно-цифровые символы текущей локали заменяются подчеркиваниями. При передаче в аргументе filename значения null функция построит C-идентификаторы на основе значения image.

foreground_color

Параметр устанавливает цвет верхнего слоя путём установки идентификатора, который вернула функция imagecolorallocate(). Верхний слой получает чёрный цвет по умолчанию. Остальные цвета интерпретируются как цвет фона.

Возвращаемые значения

Функция возвращает true, если выполнилась успешно, или false, если возникла ошибка.

Предостережение

Однако, если libgd не может вывести изображения, эта функция вернёт true.

Список изменений

Версия Описание
8.0.0 Параметр image теперь ожидает экземпляр класса GdImage; раньше параметр ждал корректный gd-ресурс (resource).
8.0.0 Параметр foreground_color теперь принимает значение null.
8.0.0 Удалили четвёртый параметр, который функция не учитывала.

Примеры

Пример #1 Пример сохранения XBM-файла

<?php

// Создание пустого изображения и добавление текста
$im = imagecreatetruecolor(120, 20);
$text_color = imagecolorallocate($im, 233, 14, 91);
imagestring($im, 1, 5, 5, 'Простая текстовая строка', $text_color);

// Сохранение изображения
imagexbm($im, 'simpletext.xbm');

?>

Пример #2 Пример сохранение XBM-файла с другим цветом верхнего слоя

<?php

// Создание пустого изображения и добавление текста
$im = imagecreatetruecolor(120, 20);
$text_color = imagecolorallocate($im, 233, 14, 91);
imagestring($im, 1, 5, 5, 'Простая текстовая строка', $text_color);

// Изменение цвета
$foreground_color = imagecolorallocate($im, 255, 0, 0);

// Сохранение изображения
imagexbm($im, NULL, $foreground_color);

?>

Добавить

Примечания пользователей

Пользователи ещё не добавляли примечания для страницы
To Top