Note: Our docs parser struggles to properly understand the constructor signature. This is the correct signature.
new DisplacementFilter(options?: DisplacementFilterOptions);
| Name | Type | Description |
|---|---|---|
options |
[Sprite | DisplacementFilterOptions] | [Sprite, unknown] |
The options for the filter. |
options.sprite |
The texture used for the displacement map. |
|
options.scale |
The scale of the displacement. |
Extends
Members
scale Point
scaleX, scaleY for displacements
Methods
Applies the filter.
| Name | Type | Description |
|---|---|---|
filterManager |
FilterSystem |
The manager. |
input |
Texture |
The input target. |
output |
Texture |
The output target. |
clearMode |
boolean |
clearMode. |
Inherited Properties
From class Filter
antialias FilterAntialias inherited
should the filter use antialiasing?
- Default Value:
- inherit
blendMode BLEND_MODES inherited overrides
Get the blend mode of the filter.
- Default Value:
- "normal"
blendRequired boolean inherited
Whether or not this filter requires the previous render texture for blending.
- Default Value:
- false
enabled boolean inherited
If enabled is true the filter is applied, if false it will not.
- Default Value:
- true
padding number inherited
The padding of the filter. Some filters require extra space to breath such as a blur. Increasing this will add extra width and height to the bounds of the object that the filter is applied to.
- Default Value:
- 0
resolution number | "inherit" inherited
The resolution of the filter. Setting this to be lower will lower the quality but increase the performance of the filter.
- Default Value:
- 1
From class Shader
compatibleRenderers number readonly inherited
A number that uses two bits on whether the shader is compatible with the WebGL renderer and/or the WebGPU renderer. 0b00 - not compatible with either 0b01 - compatible with WebGL 0b10 - compatible with WebGPU This is automatically set based on if a GlProgram or {@link GpuProgram} is provided.
An instance of the GL program used by the WebGL renderer
gpuProgram GpuProgram inherited
An instance of the GPU program used by the WebGPU renderer
resources Record<string, any> inherited
A record of the resources used by the shader.
Inherited Methods
From class Shader
Sometimes a resource group will be provided later (for example global uniforms) In such cases, this method can be used to let the shader know about the group.
| Name | Type | Description |
|---|---|---|
name |
string |
the name of the resource group |
groupIndex |
number |
the index of the group (should match the webGPU shader group location) |
bindIndex |
number |
the index of the bind point (should match the webGPU shader bind point) |
Use to destroy the shader when its not longer needed. It will destroy the resources and remove listeners.
| Name | Type | Default | Description |
|---|---|---|---|
destroyPrograms |
boolean | false |
if the programs should be destroyed as well. Make sure its not being used by other shaders! |