imagebmp

ビットマップ画像をブラウザかファイルに出力する

説明

bool imagebmp(GdImage $image, resourcestringnull $file = null, bool $compressed = true)

与えられた image のビットマップ版を保存するか出力します。

ビット深度は指定できず、image に応じて次のように決まります:

  • truecolor 画像は、完全に不透明でないピクセルが 1 つでもあれば、 アルファチャネルを含めて 1 ピクセルあたり 32 ビット、 そうでなければ 24 ビットで保存されます。
  • パレット画像は、パレットの色数が 2 色以下なら 1 ピクセルあたり 1 ビット、 16 色以下なら 4 ビット、それ以外は 8 ビットで保存されます。 パレットの色数は、imagecolorstotal が返す値です。

注意: 上記は、PHP 8.6.0 以降にバンドルされている GD ライブラリでの動作です。 それより古いバージョンの GD ライブラリは、PHP 8.6.0 より前にバンドルされていたものも含め、 truecolor 画像をアルファチャネルなしの 1 ピクセルあたり 24 ビットで、 パレット画像を 8 ビットで保存します。

パラメータ

image
imagecreatetruecolorのような画像作成関数が返す GdImage オブジェクト。
file

ファイル保存先のパスあるいはオープン中のリソース (この関数が値を戻した後で自動的にクローズされます)。省略したり null を設定したりした場合は、画像ストリームを直接出力します。

注意:

引数 compressed が指定されない場合、 null は不正な値になります。

compressed

ビットマップをランレングス法(RLE)を使って圧縮するかどうか。

圧縮できるのは、1 ピクセルあたり 4 ビットか 8 ビットで保存される場合だけです。 それ以外のビット深度では、この引数は無視されます。

戻り値

成功した場合に true を、失敗した場合に false を返します。

警告

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

変更履歴

バージョン 説明
8.6.0 バンドルされている GD ライブラリは、完全に不透明でない truecolor 画像を 1 ピクセルあたり 32 ビットで、パレット画像を色数に応じて 1、4、8 ビットで保存するようになりました。 これより前のバージョンでは、truecolor 画像は常に 24 ビットで、 パレット画像は 8 ビットで保存されていました。
8.0.0 image は、 GdImage クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、有効な gd resource が期待されていました。
8.0.0 compressed の型は、 bool になりました。 これより前のバージョンでは、数値型でした。

例

例1 ビットマップファイルを保存する

<?php
// 空の画像を生成し、いくつかテキストを加えます。
$im = imagecreatetruecolor(120, 20);
$text_color = imagecolorallocate($im, 233, 14, 91);

imagestring($im, 1, 5, 5,  'BMP with PHP', $text_color);

// 画像を保存します。
imagebmp($im, 'php.bmp');

?>

例2 1 ビットの BMP を保存する

PHP 8.6.0 以降にバンドルされている GD ライブラリでは、2 色のパレットに変換した画像が 1 ピクセルあたり 1 ビットで保存されます。サーマルプリンタなどのデバイスが求める形式です。

<?php
$im = imagecreatetruecolor(120, 40);
imagefill($im, 0, 0, imagecolorallocate($im, 255, 255, 255));
imagestring($im, 5, 10, 12, 'Total: 9.99', imagecolorallocate($im, 0, 0, 0));

// ディザリングを使い、画像を 2 色に減らします
imagetruecolortopalette($im, true, 2);

imagebmp($im, 'receipt.bmp');
?>