示例

描述

Adds a filter to an object, or globally if set to the Game object.

参数

obj
The object to apply the filter on. You may also use the object, which applies the filter globally

filter
The filter to use. For example, you can create a new glow filter by calling new_glow_filter()

返回值

Filter id. Use this filter id to remove filters

示例

描述

Remove the filter from a specific object.

参数

obj
The object to remove the filter from.

filter id
The filter id, returned from add_filter()

返回值

None

示例

描述

This filter allows you to change the overall color/brightness/saturation of the GameObject's sprite.

参数

filterSettings
A dictionary that holds the filter's configuration.
Default: 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

返回值

Filter

示例

描述

This filter allows you to add bloom to the GameObject's sprite. Bloom is an effect to make the sprite look more like it would if taken by a real world camera.

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter

示例

描述

Makes the object's sprite appear as if it was ascii art.

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter

示例

描述

Adds a bevel effect to the object.

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter

示例

描述

Makes the object's sprite appear as if it was stretched out from one point.

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter

示例

描述

Adjust a sprite's overall colors by mapping another sprite to it.

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter

示例

描述

Replace one color with another color

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter

示例

描述

The convolution filter applies a matrix convolution effect by combining pixels in the GameObject's sprite.

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter

示例

描述

The cross hatch filter overlays the sprite with a white and black cross hatch pattern.

参数

None
None

返回值

Filter

示例

描述

The CRT Filter makes the sprite look as if it is being projected through a CRT Television.

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter

示例

描述

Puts the sprite through a black and white pointillism filter.

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter

示例

描述

Adds a drop shadow to the GameObject's sprite.

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter

示例

描述

Embossing is a computer graphics technique. Each pixel of the GameObject's sprite is exchanged with a shadow or highlight.

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter

示例

描述

Embossing is a computer graphics technique. Each pixel of the GameObject's sprite is exchanged with a shadow or highlight.

参数

filterSettings
A dictionary that holds the filter's configuration.

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]

返回值

Filter

示例

描述

This filter allows you to create a glowing effect around a certain object outlining it's sprite.

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter

示例

描述

Generates godrays on the GameObject's sprite. They can be animated.

参数

filterSettings
A dictionary that holds the filter's configuration.

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]

返回值

Filter

示例

描述

Blurs the GameObject's sprite.

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter

示例

描述

Adds a motion blur filter to the object.

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter

示例

描述

Multicolor replace

参数

filterSettings
A dictionary that holds the filter's configuration.

filterSettings["replacements"]

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

filterSettings["epsilon"]

Default:0.05

filterSettings["maxColors"]

Default:2

返回值

Filter

示例

描述

Adds old film effect to an object.

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter

示例

描述

Outlines an object.

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter

示例

描述

Allows you to pixelate the GameObject's sprite.

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter

示例

描述

Adds a radial blur to the object.

参数

filterSettings
A dictionary that holds the filter's configuration.
Default:

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

返回值

Filter

示例

描述

Allows you to create reflections of sprites. Can be animated.

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter

示例

描述

Splits the RGB from an object, adding an offset to each RGB Value

参数

filterSettings
A dictionary that holds the filter's configuration.

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

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

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

返回值

Filter

示例

描述

Create an animated shockwave effect that goes out from one point.

参数

filterInfo
A dictionary that holds the filter's data.

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

返回值

Filter

示例

描述

Adds a lightmap to the object using a sprite.

参数

filterSettings
A dictionary that holds the filter's configuration.
Default:

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

返回值

Filter

示例

描述

Add a tilt shift filter effect

参数

filterSettings
A dictionary that holds the filter's configuration.

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

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

返回值

Filter

示例

描述

Adds a twist filter to the object.

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter

示例

描述

Adds a zoom blur filter to the sprite.

参数

filterSettings
A dictionary that holds the filter's configuration.

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

返回值

Filter