Player API Documentation

  1. Home
  2. Player API Documentation
Class: DisplacementMapFilter

DisplacementMapFilter

DisplacementMapFilter クラスは、指定された BitmapData オブジェクト（置き換えマップイメージと言います）
のピクセル値を使用して、オブジェクトの置き換え（変位）を実行します。

The DisplacementMapFilter class uses the pixel values from the specified
BitmapData object (called the displacement map image) to perform a displacement of an object.

new next2d.filters.DisplacementMapFilter (map_bitmap, map_point, component_x, component_y, scale_x, scale_y, mode, color, alpha)

DisplacementMapFilter.js:12
NameTypeDefaultDescription
map_bitmapBitmapDatanulloptional
map_pointPointnulloptional
component_xnumber0optional
component_ynumber0optional
scale_xnumber0.0optional
scale_ynumber0.0optional
modestringDisplacementMapFilterMode.WRAPoptional
colornumber0optional
alphanumber0.0optional

Extends

  • BitmapFilter

Members

next2d.filters.DisplacementMapFilter.namespace staticconstant

指定されたクラスの空間名を返します。
Returns the space name of the specified class.

Default Value:
  • next2d.filters.DisplacementMapFilter

alpha number

アルファ透明度の値です。
The alpha transparency value for the color.

Default Value:
  • 0

color number

範囲外置き換えの場合に使用する色を指定します。
Specifies what color to use for out-of-bounds displacements.

Default Value:
  • 0

componentX number

x の結果を変位させる場合にどのカラーチャンネルをマップイメージで使用するかを指定します。
Describes which color channel to use in the map image to displace the x result.

Default Value:
  • 0

componentY number

y の結果を変位させる場合にどのカラーチャンネルをマップイメージで使用するかを指定します。
Describes which color channel to use in the map image to displace the y result.

Default Value:
  • 0

mapBitmap BitmapData

置き換えマップデータが含まれる BitmapData オブジェクトです。
A BitmapData object containing the displacement map data.

Default Value:
  • null

mapPoint Point

マップイメージの左上隅を基準としたターゲット表示オブジェクトの
左上隅のオフセットが含まれる値です。
A value that contains the offset of the upper-left corner
of the target display object from the upper-left corner of the map image.

Default Value:
  • null

mode string

フィルターのモードです。
The mode for the filter.

Default Value:
  • DisplacementMapFilterMode.WRAP

namespace constant

指定されたオブジェクトの空間名を返します。
Returns the space name of the specified object.

Default Value:
  • next2d.filters.DisplacementMapFilter

scaleX number

マップ計算の x 置き換え結果を拡大 / 縮小する場合に使用する乗数です。
The multiplier to use to scale the x displacement result from the map calculation.

Default Value:
  • 0

scaleY number

マップ計算の y 置き換え結果を拡大 / 縮小する場合に使用する乗数です。
The multiplier to use to scale the y displacement result from the map calculation.

Default Value:
  • 0

Methods

next2d.filters.DisplacementMapFilter.toString ()string static

DisplacementMapFilter.js:119

指定されたクラスのストリングを返します。
Returns the string representation of the specified class.

Default Value:
  • [class DisplacementMapFilter]
Returns:
TypeDescription
string

clone ()DisplacementMapFilter

DisplacementMapFilter.js:419

オブジェクトのコピーを返します。
Returns a copy of this filter object.

Returns:
TypeDescription
DisplacementMapFilter

toString ()string

DisplacementMapFilter.js:147

指定されたオブジェクトのストリングを返します。
Returns the string representation of the specified object.

Default Value:
  • [object DisplacementMapFilter]
Returns:
TypeDescription
string