Layer.compareImage (イメージ比較)

  1. 文法
  2. 詳細
  3. 引数
  4. 例外
  5. 戻り値

1. 文法

メンバ型
関数
メンバ所有者
global.Layer インスタンス
呼び出し
instance.compareImage( layer, ref, userMask )

2. 詳細

レイヤのイメージバッファを比較します。比較対象はイメージのサイズと、イメージバッファ上の全ピクセルです。

3. 引数

layer (Layer)
比較対象のレイヤを指定します。
ref (Integer) [default: tpprAlpha]
ピクセルの比較方法を指定します。
tpprAlpha
カラーコードと不透明度で比較
tpprOpaque
カラーコードのみ比較
tpprMask
不透明度(マスク値)のみ比較
tpprUser
userMaskでマスクした成分のみ比較
userMask (Integer) [default: 0xFFFFFFFF]
比較ピクセルのビットマスクを、0xAARRGGBBの形式で指定します。refでtpprUserを指定したときのみ有効です。

4. 例外

5. 戻り値

イメージサイズとイメージバッファが同じ場合は、0を返します。イメージサイズが異なる場合や、イメージが1ピクセル以上異なる場合は、0以外の値を返します。