imagexbm

(PHP 5, PHP 7)

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

Описание

imagexbm ( resource $image [, string $filename = NULL [, int $foreground ]] ) : bool

Вывод или сохранение в формате XBM изображения image.

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

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

image

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

filename

Путь, по которому сохранять файл. Если не установлено, или равно NULL, будет произведен прямой вывод необработанного потока изображения.

filename (без расширения .xbm) также используется как идентификатор C XBM, при этом символы, не являющиеся в текущей локали цифрами или буквами, заменяются на подчеркивание. Если filename задан как NULL, image будет использован для создания идентификатора C.

foreground

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

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

Возвращает TRUE в случае успешного завершения или FALSE в случае возникновения ошибки.

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

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

Примеры

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

Примечания