例

説明

オブジェクトにフィルターを追加します。Gameオブジェクトに設定すると全体に適用されます。

パラメータ

obj
フィルターを適用するオブジェクト。objectを指定すると、フィルターが全体に適用されます

filter
使用するフィルター。たとえば、new_glow_filter()を呼び出すと新しいグローフィルターを作成できます

戻り値

フィルターID。フィルターを削除するときにこのフィルターIDを使います

例

説明

特定のオブジェクトからフィルターを削除します。

パラメータ

obj
フィルターを削除するオブジェクト。

filter id
The filter id, returned from add_filter()

戻り値

None

例

説明

このフィルターを使うと、GameObjectのスプライト全体の色、明るさ、彩度を変更できます。

パラメータ

filterSettings
フィルターの設定を保持する辞書。
デフォルト: 2

filterSettings["gamma"]
How much to adjust the object's gamma.
Default: 2

filterSettings["saturation"]
How much to adjust the object's saturation.
Default: 2

filterSettings["contrast"]
How much to adjust the object's constrast.
Default: 1

filterSettings["brightness"]
How much to adjust the object's brightness.
Default: 1

filterSettings["red"]
How much to adjust the object's red.
Default: 1

filterSettings["green"]
How much to adjust the object's green.
Default: 1

filterSettings["blue"]
How much to adjust the object's blue.
Default: 1

filterSettings["alpha"]
How much to adjust the object's alpha.
Default: 1

戻り値

フィルター

例

説明

このフィルターを使うと、GameObjectのスプライトにブルームを追加できます。ブルームは、スプライトを実際のカメラで撮影したように見せる効果です。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["threshold"]
The threshold of brightness at which bloom will start appearing.
Default: 0.5

filterSettings["bloomScale"]
The intensity of the effect.
Default: 1.0

filterSettings["brightness"]
How bright the bloom effect will be.
Default: 1.0

filterSettings["blur"]
The amount to blur the bloom.
Default: 8

filterSettings["quality"]
quality of the blur
Default: 4

filterSettings["kernels"]
the kernels of the blur
Default: null

filterSettings["pixelSize"]
The pixel size of the Blur
Default: 1

filterSettings["resolution"]
The resolution of the Blur.
Default: Resolution of canvas

戻り値

フィルター

例

説明

オブジェクトのスプライトをアスキーアートのように見せます。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["size"]
The font size of the ascii text.
Default: 8

戻り値

フィルター

例

説明

オブジェクトにベベル効果を追加します。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["rotation"]
The angle of the light in degrees.
Default: 45

filterSettings["thickness"]
The tickness of the bevel.
Default: 2

filterSettings["lightColor"]
Color of the light.
Default: 0xffffff

filterSettings["lightAlpha"]
Alpha of the light.
Default: 0.7

filterSettings["shadowColor"]
Color of the shadow.
Default: 0x000000

filterSettings["shadowAlpha"]
Alpha of the shadow.
Default: 0.7

戻り値

フィルター

例

説明

オブジェクトのスプライトを1点から引き伸ばしたように見せます。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["center"]
Coordinates to set the bulge or pinch
Default: [0.5,0.5]

filterSettings["radius"]
The radius of the stretch.
Default: 100

filterSettings["strength"]
The strength of the stretch.
Default: 1

戻り値

フィルター

例

説明

別のスプライトをマッピングして、スプライト全体の色を調整します。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["colorMap"]
The sprite to map the colors to.
Default: new_sprite('nosprite.png')

filterSettings["nearest"]
If it should use the nearest color to the original (True/False)
Default: False

filterSettings["mix"]
How much the colors mix.
Default: 1

戻り値

フィルター

例

説明

1つの色を別の色に置き換えます

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["originalColor"]
The RGB that will be changed.
Default: [1,0,0]

filterSettings["newColor"]
The color to change to in RGB
Default: [0,0,1]

filterSettings["epsilon"]
Tolerance or sensitivity.
Default: 0.8

戻り値

フィルター

例

説明

畳み込みフィルターは、GameObjectのスプライトのピクセルを組み合わせて行列畳み込み効果を適用します。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["matrix"]
A 9 point array that holds the values for the matrix calculations.
Default: [0.5,0.5,0.5,0.5,0,0,0,0,0]

filterSettings["width"]
The width of sprite you are using.
Default: 200

filterSettings["height"]
The height of the sprite you are using.
Default: 200

戻り値

フィルター

例

説明

クロスハッチフィルターは、スプライトに白黒のクロスハッチ模様を重ねます。

パラメータ

None
None

戻り値

フィルター

例

説明

CRTフィルターは、スプライトをブラウン管テレビに映したように見せます。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["curvature"]
How curved the CRT display appears.
Default: 1.0

filterSettings["lineWidth"]
The width of the CRT lines.
Default: 1.0

filterSettings["lineConstrast"]
The contrast of the lines on the rest of the sprite.
Default: 0.25

filterSettings["verticalLine"]
If it is a horizonal or vertical line (True/False)
Default: False

filterSettings["noise"]
The amount of noise to add to the filter.
Default: 0.3

filterSettings["noiseSize"]
The seed the noise filter should use.
Default: 1.0

filterSettings["seed"]
The seed for the CRT filter.
Default: 0

filterSettings["vignetting"]
How much vignetting to do, darkening the pixels closest to the sprite's corners.
Default: 0.3

filterSettings["vignettingAlpha"]
The alpha the vignetting should take on.
Default: 1.0

filterSettings["vignettingBlur"]
How blurry the vignetting should be.
Default: 0.3

filterSettings["time"]
Used to animate the filter, increase it over time to have the CRT animate.
Default: 0

戻り値

フィルター

例

説明

スプライトに白黒の点描フィルターをかけます。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["scale"]
The scale at which the dots should be drawn.
Default: 1

filterSettings["angle"]
The angle a which the dot pattern should be.
Default: 5

戻り値

フィルター

例

説明

GameObjectのスプライトにドロップシャドウを追加します。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["rotation"]
The angle a which the shadow should appear.
Default:45

filterSettings["distance"]
How far the shadow should go from the GameObject.
Default:5

filterSettings["color"]
The color of the shadow.
Default:0x000000

filterSettings["alpha"]
The alpha of the blur.
Default:0.5

filterSettings["shadowOnly"]
If it should only draw the shadow and not the sprite. (True/False)
Default:False

filterSettings["blur"]
How blurry the drop shadow should be.
Default:2

filterSettings["quality"]
The quality of the blur.
Default:3

filterSettings["kernels"]
The kernels of the blur
Default:null

filterSettings["pixelSize"]
the pixelSize of the blur
Default:1

filterSettings["resolution"]
The resolution of the blur
Default:Resolution of the Canvas

戻り値

フィルター

例

説明

エンボスはコンピューターグラフィックスの技法です。GameObjectのスプライトの各ピクセルが影またはハイライトに置き換えられます。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["strength"]
The strength of the filter.
Default: 5

戻り値

フィルター

例

説明

エンボスはコンピューターグラフィックスの技法です。GameObjectのスプライトの各ピクセルが影またはハイライトに置き換えられます。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["slices"]
The maximum number of slices.
Default: 5

filterSettings["offset"]
The maximum offset amount of slices.
Default: 100

filterSettings["direction"]
The angle in degree of the offset of slices.
Default: 0

filterSettings["fillMode"]
The fill mode of the space after the offset. Acceptable values: 1,2,3,4,5
Default: 0

filterSettings["seed"]
A seed value for randomizing glitch effect.
Default: 0

filterSettings["average"]
true will divide the bands roughly based on equal amounts where as setting to false will vary the band sizes dramatically (more random looking).
Default: False

filterSettings["minSize"]
Minimum size of individual slice. Segment of total sampleSize
Default: 8

filterSettings["sampleSize"]
The resolution of the displacement map texture.
Default: 512

filterSettings["red"]
Red offset
Default: [0,0]

filterSettings["green"]
Green offset
Default: [0,0]

filterSettings["blue"]
Blue offset
Default: [0,0]

戻り値

フィルター

例

説明

このフィルターを使うと、オブジェクトのスプライトの輪郭に沿って光る効果を作れます。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["distance"]
How far out it goes. This cannot be changed after filter creation.
Default:10

filterSettings["outerStrength"]
The strength of the glow at the farthest point.
Default:4

filterSettings["innerStrength"]
The strength of the glow at the closest point.
Default:0

filterSettings["color"]
The HEX color code of the glow.
Default:0xffffff

filterSettings["quality"]
The HEX color code of the glow.
Default:0.1

filterSettings["knockout"]
Hide the texture, and only show glow.
Default:False

戻り値

フィルター

例

説明

GameObjectのスプライトにゴッドレイ（光芒）を生成します。アニメーションさせることもできます。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["angle"]
The angle at which the godrays appear.
Default:30

filterSettings["gain"]
Changes the godray's sensitivity.
Default:0.5

filterSettings["lacunarity"]
The intensity of the gaps in the godrays.
Default:2.5

filterSettings["parallel"]
If all the godrays should be parallel.
Default:True

filterSettings["time"]
The time the filter is at. Increase it over time to animate the godrays.
Default:0

filterSettings["center"]
Where the rays originate. Parallel must be set to false.
Default:[0,0]

戻り値

フィルター

例

説明

GameObjectのスプライトをぼかします。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["blur"]
The intensity of the blur.
Default:4

filterSettings["quality"]
The blur's quality.
Default:3

filterSettings["clamp"]
Clamps the edges of the GameObject's sprite (True/False)
Default:False

戻り値

フィルター

例

説明

オブジェクトにモーションブラーフィルターを追加します。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["velocity"]
The strength of the blur x and y
Default:[0,0]

filterSettings["kernelSize"]
The kernelSize of the blur filter. Must be odd number >= 5
Default:5

filterSettings["offset"]
The offset of the blur filter.
Default:0

戻り値

フィルター

例

説明

複数の色を置き換えます

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["replacements"]

Default:[[ [1,0,0], [0,0,1] ],[ [0,1,0], [1,1,1] ]]

filterSettings["epsilon"]

Default:0.05

filterSettings["maxColors"]

Default:2

戻り値

フィルター

例

説明

オブジェクトに古いフィルムの効果を追加します。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["sepia"]
The amount of saturation of sepia effect, a value of 1 is more saturation and closer to 0 is less, and a value of 0 produces no sepia effect
Default:0.3

filterSettings["noise"]
Opacity/intensity of the noise effect between 0 and 1
Default:0.3

filterSettings["noiseSize"]
The size of the noise particles
Default:1.0

filterSettings["scratch"]
How often scratches appear
Default:0.5

filterSettings["scratchDensity"]
The density of the number of scratches
Default:0.3

filterSettings["scratchWidth"]
The width of the scratches
Default:1.0

filterSettings["vignetting"]
The radius of the vignette effect, smaller values produces a smaller vignette
Default:0.3

filterSettings["vignettingAlpha"]
Amount of opacity of vignette
Default:1.0

filterSettings["vignettingBlur"]
Blur intensity of the vignette
Default:0.3

戻り値

フィルター

例

説明

オブジェクトに輪郭線を付けます。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["thickness"]
The tickness of the outline.
Default:1

filterSettings["color"]
The color of the outline.
Default:0x000000

filterSettings["quality"]
The quality of the outline from 0 to 1, using a higher quality setting will result in slower performance and more accuracy.
Default:0.1

戻り値

フィルター

例

説明

GameObjectのスプライトをピクセル化できます。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["size"]
A two element array that holds the width/height of each pixel.
Default:[10,10]

戻り値

フィルター

例

説明

オブジェクトに放射状ブラーを追加します。

パラメータ

filterSettings
フィルターの設定を保持する辞書。
デフォルト:

filterSettings["angle"]
Sets the angle of the motion for blur effect.
Default:0

filterSettings["center"]
The center of the radial.
Default:[0,0]

filterSettings["kernelSize"]
The kernelSize of the blur filter. But be odd number >= 3
Default:5

filterSettings["radius"]
The maximum size of the blur radius, -1 is infinite
Default:-1

戻り値

フィルター

例

説明

スプライトの反射を作成できます。アニメーションさせることもできます。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["mirror"]
If the reflection should be mirrored.
Default:true

filterSettings["boundary"]
The vertical position where the reflection should occur.
Default:0.5

filterSettings["amplitude"]
The strength of the starting/ending positions of the waves.
Default:[0,20]

filterSettings["waveLength"]
The length of the starting/ending positions of the waves.
Default:[30,100]

filterSettings["alpha"]
The alpha values of the starting/ending positions of the waves.
Default:[1,1]

filterSettings["time"]
The time the filter is at. Increase over time to animate.
Default:0

戻り値

フィルター

例

説明

オブジェクトのRGBを分離し、各RGB値にオフセットを加えます

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["red"]
Red offset
Default: [-10,0]

filterSettings["green"]
Green offset
Default: [0, 10]

filterSettings["blue"]
Blue offset
Default: [0, 0]

戻り値

フィルター

例

説明

1点から広がるアニメーション付きの衝撃波効果を作成します。

パラメータ

filterInfo
フィルターのデータを保持する辞書。

filterInfo["center"]
Where to center the shockwave. Center is relative to the Sprite's top left corner.
Default:[0.5,0.5]

filterInfo["amplitude"]
The strength of the shockwave
Default:.30

filterInfo["wavelength"]
The wave length of the shockwave.
Default:160

filterInfo["speed"]
The speed at which the shockwave moves out if animated using time.
Default:500

filterInfo["brightness"]
The brightness of the shockwave.
Default:1.0

filterInfo["radius"]
The radius of the shockwave when starting.
Default:-1

filterInfo["time"]
The time at which the filter is at. Increase overtime to animate.
Default:0

戻り値

フィルター

例

説明

スプライトを使ってオブジェクトにライトマップを追加します。

パラメータ

filterSettings
フィルターの設定を保持する辞書。
デフォルト:

filterSettings["texture"]
The sprite to use as a lightmap
Default: new_sprite('nosprite.png')

filterSettings["color"]
An RGBA array of the ambient color
Default: [1, 0, 0, 1]

filterSettings["alpha"]
Default alpha set independent of color
Default: 1

戻り値

フィルター

例

説明

ティルトシフトフィルター効果を追加します

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["blur"]
How much to blur the effect.
Default:100

filterSettings["gradientBlur"]
The gradient of the blur's effects.
Default:600

戻り値

フィルター

例

説明

オブジェクトにねじれフィルターを追加します。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["radius"]
How wide to twist.
Default:200

filterSettings["angle"]
The angle of the twist
Default:4

filterSettings["padding"]
Padding for filter area.
Default:20

戻り値

フィルター

例

説明

スプライトにズームブラーフィルターを追加します。

パラメータ

filterSettings
フィルターの設定を保持する辞書。

filterSettings["strength"]
The strength of the zoom.
Default:0.1

filterSettings["center"]
Where to center to zoom. [0,0] is the top left corner of the sprite.
Default:[0.5,0.5]

filterSettings["innerRadius"]
The radius of the inner unzoomed area.
Default:0

filterSettings["radius"]
The outer radius of the filter. -1 for infinite.
Default:-1

戻り値

フィルター