imagesetbrush

(PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8)

imagesetbrush — 線の描画用にブラシイメージを設定する

説明

imagesetbrush(GdImage $image, GdImage $brush): true

imagesetbrush() は、特別な色 IMG_COLOR_BRUSHED または IMG_COLOR_STYLEDBRUSHED で描画される際に (imageline() や imagepolygon() のような) 全ての線描画関数で使用されるブラシイメージを設定します。

警告

ブラシの使用が終った際には特別な処理は不要ですが、ブラシイメージを破棄する(もしくは、PHPに破棄させる)場合には、新たにブラシイメージを設定するまでは、色 IMG_COLOR_BRUSHED または IMG_COLOR_STYLEDBRUSHED を使用するべきではありません。

パラメータ

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

戻り値

常に true を返します。

変更履歴

バージョン	説明
8.0.0	`image` と `brush` は、 GdImage クラスのインスタンスを期待するようになりました。これより前のバージョンでは resource を期待していました。

例

例1 imagesetbrush() の例

<?php
// 小さい php ロゴを読み込みます
$php = imagecreatefrompng('./php.png');

// 100x100 のメイン画像を作成します
$im = imagecreatetruecolor(100, 100);

// 背景を白で塗りつぶします
$white = imagecolorallocate($im, 255, 255, 255);
imagefilledrectangle($im, 0, 0, 299, 99, $white);

// ブラシを設定します
imagesetbrush($im, $php);

// いくつかのブラシを重ねます
imageline($im, 50, 50, 50, 60, IMG_COLOR_BRUSHED);

// 画像をブラウザに出力します
header('Content-type: image/png');

imagepng($im);
?>

上の例の出力は、たとえば以下のようになります。