PHP 8.3.4 Released!

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, image будет использован для создания идентификатора C.

foreground_color

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

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

Возвращает 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');

// Освобождение памяти
imagedestroy($im);
?>

Пример #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);

// Освобождение памяти
imagedestroy($im);
?>

Примечания

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top