PixelPAD 2D - Filtres

Filtres

Les filtres, parfois appelés shaders, nous permettent d'utiliser la carte graphique pour créer des effets visuels spéciaux. PixelPAD2D nous donne accès à une collection de filtres. Pour les utiliser, il suffit de les ajouter à un GameObject ou à l'objet Game lui-même.

add_filter(obj: GameObject, filter : Filter) -> filter id

Exemple
Description
Ajoute un filtre à un objet, ou globalement s'il est appliqué à l'objet Game.
Paramètres
obj
L'objet auquel appliquer le filtre. Tu peux aussi utiliser l'objet Game, ce qui applique le filtre globalement

filter
Le filtre à utiliser. Par exemple, tu peux créer un nouveau filtre de lueur en appelant new_glow_filter()

Valeur de retour
Identifiant du filtre. Utilise cet identifiant pour retirer des filtres

remove_filter(obj: GameObject, filterid : number) -> Filter

Exemple
Description
Retire le filtre d'un objet précis.
Paramètres
obj
L'objet dont retirer le filtre.

filter id
The filter id, returned from add_filter()

Valeur de retour
None

new_adjustment_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Ce filtre permet de modifier la couleur, la luminosité et la saturation globales du sprite du GameObject.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.
Par défaut : 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

Valeur de retour
Filtre

new_adv_bloom_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Ce filtre permet d'ajouter un effet bloom au sprite du GameObject. Le bloom donne au sprite l'apparence d'une image prise par une vraie caméra.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre

new_ascii_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Donne au sprite de l'objet l'apparence d'un dessin en ASCII.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre

new_bevel_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Ajoute un effet de biseau à l'objet.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre

new_bulge_pinch_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Donne au sprite de l'objet l'apparence d'être étiré à partir d'un point.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre

new_color_map_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Ajuste les couleurs globales d'un sprite en lui appliquant un autre sprite comme carte.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre

new_color_replace_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Remplace une couleur par une autre
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre

new_convolution_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Le filtre de convolution applique un effet de convolution matricielle en combinant les pixels du sprite du GameObject.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre

new_cross_hatch_filter() -> Filter

Exemple
Description
Le filtre de hachures croisées superpose au sprite un motif de hachures croisées noir et blanc.
Paramètres
None
None

Valeur de retour
Filtre

new_crt_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Le filtre CRT donne au sprite l'apparence d'être projeté sur un téléviseur à tube cathodique.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre

new_dot_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Applique au sprite un filtre de pointillisme noir et blanc.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre

new_drop_shadow_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Ajoute une ombre portée au sprite du GameObject.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre

new_emboss_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Le gaufrage est une technique d'infographie. Chaque pixel du sprite du GameObject est remplacé par une ombre ou un reflet.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre

new_glitch_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Le gaufrage est une technique d'infographie. Chaque pixel du sprite du GameObject est remplacé par une ombre ou un reflet.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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]

Valeur de retour
Filtre

new_glow_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Ce filtre permet de créer un effet de lueur autour d'un objet, en suivant le contour de son sprite.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre

new_godray_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Génère des rayons de lumière (godrays) sur le sprite du GameObject. Ils peuvent être animés.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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]

Valeur de retour
Filtre

new_kawase_blur_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Rend flou le sprite du GameObject.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre

new_motion_blur_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Ajoute un filtre de flou de mouvement à l'objet.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre

new_multicolor_replace_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Remplacement multicolore
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

filterSettings["replacements"]

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

filterSettings["epsilon"]

Default:0.05

filterSettings["maxColors"]

Default:2

Valeur de retour
Filtre

new_old_film_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Ajoute un effet de vieux film à un objet.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre

new_outline_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Ajoute un contour à un objet.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre

new_pixelate_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Permet de pixéliser le sprite du GameObject.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre

new_radial_blur_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Ajoute un flou radial à l'objet.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.
Par défaut :

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

Valeur de retour
Filtre

new_reflection_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Permet de créer des reflets de sprites. Peut être animé.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre

new_rgb_split_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Sépare les canaux RVB d'un objet en ajoutant un décalage à chaque valeur RVB
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

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

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

Valeur de retour
Filtre

new_shockwave_filter(filterInfo : dictionary) -> Filter

Exemple
Description
Crée un effet d'onde de choc animée qui part d'un point.
Paramètres
filterInfo
Un dictionnaire contenant les données du filtre.

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

Valeur de retour
Filtre

new_simple_lightmap_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Ajoute une carte de lumière à l'objet à partir d'un sprite.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.
Par défaut :

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

Valeur de retour
Filtre

new_tilt_shift_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Ajoute un effet de filtre tilt-shift
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

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

Valeur de retour
Filtre

new_twist_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Ajoute un filtre de torsion à l'objet.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre

new_zoom_blur_filter(filterSettings : dictionary) -> Filter

Exemple
Description
Ajoute un filtre de flou de zoom au sprite.
Paramètres
filterSettings
Un dictionnaire contenant la configuration du filtre.

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

Valeur de retour
Filtre