imagexbm

(PHP 5, PHP 7)

imagexbm — XBM 画像をブラウザあるいはファイルに出力する

説明

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

imagewbmp() は、指定した image を XBM にして出力あるいは保存します。

注意: imagexbm() はパディングを一切行わないので、 画像の幅は 8 の倍数でなければいけません。 PHP 5.6.24 および PHP 7.0.9 以降では、この制約がなくなりました。

パラメータ

image

imagecreatetruecolor() のような画像作成関数が返す画像リソース。

filename

画像の保存先のパス。省略したり NULL を設定したりした場合は、画像ストリームを直接出力します。

filename (拡張子 .xbm を除いた部分) は、XBM の C 識別子としても用いられます。 そのため、現在のロケールで扱える英数字以外の文字は、アンダースコアに置き換えられます。 filename を NULL にすると、 image を使って C 識別子を作ります。

foreground

このパラメータで、 前景の色を指定できます。imagecolorallocate() で 取得した ID を使用してください。デフォルトの前景色は黒です。 その他の色はすべて、背景色として扱われます。

返り値

成功した場合に TRUE を、失敗した場合に FALSE を返します。

警告

しかしながら、libgd がイメージの出力に失敗した場合、この関数は TRUE を返します。

例

例1 XBM ファイルの保存

<?php
// 空の画像を作成してテキストを追加します
$im = imagecreatetruecolor(120, 20);
$text_color = imagecolorallocate($im, 233, 14, 91);
imagestring($im, 1, 5, 5,  'A Simple Text String', $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,  'A Simple Text String', $text_color);

// 別の前景色を設定します
$foreground_color = imagecolorallocate($im, 255, 0, 0);

// 画像を保存します
imagexbm($im, NULL, $foreground_color);

// メモリを開放します
imagedestroy($im);
?>

注意