Class ImageFilter

ImageFilter for composable effects. Mirrors CanvasKit.ImageFilter API.

🧪 Not in the HTML Canvas standard.

Constructors

constructor

new ImageFilter(
    kind: "color-filter",
    colorFilter: ColorFilter,
    input?: ImageFilter | null,
): ImageFilter
Create an image filter of the given kind.

The kind names the effect and the remaining arguments are the ones that kind takes, matching the Make method of the same name. Where those return null for arguments Skia rejects, the constructor throws instead.

Most kinds end with an optional input filter, which is how they chain; omitting it reads from the layer being drawn.
```
ctx.imageFilter = new ImageFilter("blur", 4, 4)
```
Parameters
- kind: "color-filter"
- colorFilter: ColorFilter
- Optionalinput: ImageFilter | null
Returns ImageFilter

Throws
TypeError if the kind is unknown or the arguments describe no filter
- Defined in index.d.ts:2012
new ImageFilter(
    kind: "compose",
    outer: ImageFilter,
    inner: ImageFilter,
): ImageFilter
Apply inner, then outer. See ImageFilter.MakeCompose.
Parameters
- kind: "compose"
- outer: ImageFilter
- inner: ImageFilter
Returns ImageFilter
- Defined in index.d.ts:2018
new ImageFilter(
    kind: "blur",
    sigmaX: number,
    sigmaY: number,
    tileMode?: "repeat" | "clamp" | "mirror" | "decal",
    input?: ImageFilter | null,
): ImageFilter
Gaussian blur. See ImageFilter.MakeBlur.
Parameters
- kind: "blur"
- sigmaX: number
- sigmaY: number
- OptionaltileMode: "repeat" | "clamp" | "mirror" | "decal"
- Optionalinput: ImageFilter | null
Returns ImageFilter
- Defined in index.d.ts:2020
new ImageFilter(
    kind: "drop-shadow",
    dx: number,
    dy: number,
    sigmaX: number,
    sigmaY: number,
    color: string | [number, number, number, number],
    input?: ImageFilter | null,
): ImageFilter
Source plus its shadow. See ImageFilter.MakeDropShadow.
Parameters
- kind: "drop-shadow"
- dx: number
- dy: number
- sigmaX: number
- sigmaY: number
- color: string | [number, number, number, number]
- Optionalinput: ImageFilter | null
Returns ImageFilter
- Defined in index.d.ts:2028
new ImageFilter(
    kind: "drop-shadow-only",
    dx: number,
    dy: number,
    sigmaX: number,
    sigmaY: number,
    color: string | [number, number, number, number],
    input?: ImageFilter | null,
): ImageFilter
The shadow alone. See ImageFilter.MakeDropShadowOnly.
Parameters
- kind: "drop-shadow-only"
- dx: number
- dy: number
- sigmaX: number
- sigmaY: number
- color: string | [number, number, number, number]
- Optionalinput: ImageFilter | null
Returns ImageFilter
- Defined in index.d.ts:2038
new ImageFilter(
    kind: "offset",
    dx: number,
    dy: number,
    input?: ImageFilter | null,
): ImageFilter
Translate. See ImageFilter.MakeOffset.
Parameters
- kind: "offset"
- dx: number
- dy: number
- Optionalinput: ImageFilter | null
Returns ImageFilter
- Defined in index.d.ts:2048
new ImageFilter(
    kind: "dilate",
    radiusX: number,
    radiusY: number,
    input?: ImageFilter | null,
    crop?: [number, number, number, number] | null,
): ImageFilter
Morphological dilation. See ImageFilter.MakeDilate.
Parameters
- kind: "dilate"
- radiusX: number
- radiusY: number
- Optionalinput: ImageFilter | null
- Optionalcrop: [number, number, number, number] | null
  🧪 Bounds the kernel's domain as well as clipping the output.
Returns ImageFilter
- Defined in index.d.ts:2055
new ImageFilter(
    kind: "erode",
    radiusX: number,
    radiusY: number,
    input?: ImageFilter | null,
    crop?: [number, number, number, number] | null,
): ImageFilter
Morphological erosion. See ImageFilter.MakeErode.
Parameters
- kind: "erode"
- radiusX: number
- radiusY: number
- Optionalinput: ImageFilter | null
- Optionalcrop: [number, number, number, number] | null
  🧪 Bounds the kernel's domain as well as clipping the output.
Returns ImageFilter
- Defined in index.d.ts:2064
new ImageFilter(kind: "merge", filters: (ImageFilter | null)[]): ImageFilter
Draw several filters together. See ImageFilter.MakeMerge.
Parameters
- kind: "merge"
- filters: (ImageFilter | null)[]
Returns ImageFilter
- Defined in index.d.ts:2073
new ImageFilter(kind: "empty"): ImageFilter
Transparent black. See ImageFilter.MakeEmpty.
Parameters
- kind: "empty"
Returns ImageFilter
- Defined in index.d.ts:2075
new ImageFilter(
    kind: "tile",
    src: [number, number, number, number],
    dst: [number, number, number, number],
    input?: ImageFilter | null,
): ImageFilter
Repeat a source rect across a destination. See ImageFilter.MakeTile.
Parameters
- kind: "tile"
- src: [number, number, number, number]
- dst: [number, number, number, number]
- Optionalinput: ImageFilter | null
Returns ImageFilter
- Defined in index.d.ts:2077
new ImageFilter(
    kind: "blend",
    mode: BlendMode,
    background?: ImageFilter | null,
    foreground?: ImageFilter | null,
): ImageFilter
Blend two filters. See ImageFilter.MakeBlend.
Parameters
- kind: "blend"
- mode: BlendMode
- Optionalbackground: ImageFilter | null
- Optionalforeground: ImageFilter | null
Returns ImageFilter
- Defined in index.d.ts:2084
new ImageFilter(
    kind: "arithmetic",
    k1: number,
    k2: number,
    k3: number,
    k4: number,
    enforcePMColor?: boolean,
    background?: ImageFilter | null,
    foreground?: ImageFilter | null,
): ImageFilter
k1fgbg + k2fg + k3bg + k4. See ImageFilter.MakeArithmetic.
Parameters
- kind: "arithmetic"
- k1: number
- k2: number
- k3: number
- k4: number
- OptionalenforcePMColor: boolean
- Optionalbackground: ImageFilter | null
- Optionalforeground: ImageFilter | null
Returns ImageFilter
- Defined in index.d.ts:2091
new ImageFilter(
    kind: "displacement-map",
    xChannel: ColorChannel,
    yChannel: ColorChannel,
    scale: number,
    displacement?: ImageFilter | null,
    color?: ImageFilter | null,
): ImageFilter
Displace pixels by a map. See ImageFilter.MakeDisplacementMap.
Parameters
- kind: "displacement-map"
- xChannel: ColorChannel
- yChannel: ColorChannel
- scale: number
- Optionaldisplacement: ImageFilter | null
- Optionalcolor: ImageFilter | null
Returns ImageFilter
- Defined in index.d.ts:2102
new ImageFilter(
    kind: "matrix-convolution",
    kernelSize: [number, number],
    kernel: number[],
    gain: number,
    bias: number,
    kernelOffset: [number, number],
    tileMode?: TileMode,
    convolveAlpha?: boolean,
    input?: ImageFilter | null,
    crop?: [number, number, number, number] | null,
): ImageFilter
Convolution kernel. See ImageFilter.MakeMatrixConvolution.
Parameters
- kind: "matrix-convolution"
- kernelSize: [number, number]
- kernel: number[]
- gain: number
- bias: number
- kernelOffset: [number, number]
- OptionaltileMode: TileMode
- OptionalconvolveAlpha: boolean
- Optionalinput: ImageFilter | null
- Optionalcrop: [number, number, number, number] | null
  🧪 Bounds the kernel's domain as well as clipping the output.
Returns ImageFilter
- Defined in index.d.ts:2111
new ImageFilter(
    kind: "matrix-transform",
    matrix: number[],
    sampling?: SamplingMode,
    input?: ImageFilter | null,
): ImageFilter
Affine or 3x3 transform. See ImageFilter.MakeMatrixTransform.
Parameters
- kind: "matrix-transform"
- matrix: number[]
- Optionalsampling: SamplingMode
- Optionalinput: ImageFilter | null
Returns ImageFilter
- Defined in index.d.ts:2125
new ImageFilter(
    kind: "magnifier",
    lensBounds: [number, number, number, number],
    zoomAmount: number,
    inset: number,
    sampling?: SamplingMode,
    input?: ImageFilter | null,
): ImageFilter
Fisheye lens. See ImageFilter.MakeMagnifier.
Parameters
- kind: "magnifier"
- lensBounds: [number, number, number, number]
- zoomAmount: number
- inset: number
- Optionalsampling: SamplingMode
- Optionalinput: ImageFilter | null
Returns ImageFilter
- Defined in index.d.ts:2132
new ImageFilter(
    kind: "crop",
    rect: [number, number, number, number],
    tileMode?: TileMode,
    input?: ImageFilter | null,
): ImageFilter
Restrict to a rect. See ImageFilter.MakeCrop.
Parameters
- kind: "crop"
- rect: [number, number, number, number]
- OptionaltileMode: TileMode
- Optionalinput: ImageFilter | null
Returns ImageFilter
- Defined in index.d.ts:2141
new ImageFilter(
    kind: "distant-lit-diffuse",
    direction: Point3,
    lightColor: string,
    surfaceScale: number,
    kd: number,
    input?: ImageFilter | null,
): ImageFilter
Diffuse light from a direction. See ImageFilter.MakeDistantLitDiffuse.
Parameters
- kind: "distant-lit-diffuse"
- direction: Point3
- lightColor: string
- surfaceScale: number
- kd: number
- Optionalinput: ImageFilter | null
Returns ImageFilter
- Defined in index.d.ts:2148
new ImageFilter(
    kind: "point-lit-diffuse",
    location: Point3,
    lightColor: string,
    surfaceScale: number,
    kd: number,
    input?: ImageFilter | null,
): ImageFilter
Diffuse light from a point. See ImageFilter.MakePointLitDiffuse.
Parameters
- kind: "point-lit-diffuse"
- location: Point3
- lightColor: string
- surfaceScale: number
- kd: number
- Optionalinput: ImageFilter | null
Returns ImageFilter
- Defined in index.d.ts:2157
new ImageFilter(
    kind: "spot-lit-diffuse",
    location: Point3,
    target: Point3,
    falloffExponent: number,
    cutoffAngle: number,
    lightColor: string,
    surfaceScale: number,
    kd: number,
    input?: ImageFilter | null,
): ImageFilter
Diffuse light from a spot. See ImageFilter.MakeSpotLitDiffuse.
Parameters
- kind: "spot-lit-diffuse"
- location: Point3
- target: Point3
- falloffExponent: number
- cutoffAngle: number
- lightColor: string
- surfaceScale: number
- kd: number
- Optionalinput: ImageFilter | null
Returns ImageFilter
- Defined in index.d.ts:2166
new ImageFilter(
    kind: "distant-lit-specular",
    direction: Point3,
    lightColor: string,
    surfaceScale: number,
    ks: number,
    shininess: number,
    input?: ImageFilter | null,
): ImageFilter
Specular light from a direction. See ImageFilter.MakeDistantLitSpecular.
Parameters
- kind: "distant-lit-specular"
- direction: Point3
- lightColor: string
- surfaceScale: number
- ks: number
- shininess: number
- Optionalinput: ImageFilter | null
Returns ImageFilter
- Defined in index.d.ts:2178
new ImageFilter(
    kind: "point-lit-specular",
    location: Point3,
    lightColor: string,
    surfaceScale: number,
    ks: number,
    shininess: number,
    input?: ImageFilter | null,
): ImageFilter
Specular light from a point. See ImageFilter.MakePointLitSpecular.
Parameters
- kind: "point-lit-specular"
- location: Point3
- lightColor: string
- surfaceScale: number
- ks: number
- shininess: number
- Optionalinput: ImageFilter | null
Returns ImageFilter
- Defined in index.d.ts:2188
new ImageFilter(
    kind: "spot-lit-specular",
    location: Point3,
    target: Point3,
    falloffExponent: number,
    cutoffAngle: number,
    lightColor: string,
    surfaceScale: number,
    ks: number,
    shininess: number,
    input?: ImageFilter | null,
): ImageFilter
Specular light from a spot. See ImageFilter.MakeSpotLitSpecular.
Parameters
- kind: "spot-lit-specular"
- location: Point3
- target: Point3
- falloffExponent: number
- cutoffAngle: number
- lightColor: string
- surfaceScale: number
- ks: number
- shininess: number
- Optionalinput: ImageFilter | null
Returns ImageFilter
- Defined in index.d.ts:2198

Methods

delete

delete(): void
Mark filter as deleted. Use-after-delete throws Error.

Returns void
- Defined in index.d.ts:2600

`Static`MakeArithmetic

MakeArithmetic(
    k1: number,
    k2: number,
    k3: number,
    k4: number,
    enforcePMColor?: boolean,
    background?: ImageFilter | null,
    foreground?: ImageFilter | null,
): ImageFilter | null
Arithmetic blend: k1fgbg + k2fg + k3bg + k4.
Parameters
- k1: number
  coefficient for fg*bg
- k2: number
  coefficient for fg
- k3: number
  coefficient for bg
- k4: number
  constant offset
- OptionalenforcePMColor: boolean
  enforce premultiplied color (default true)
- Optionalbackground: ImageFilter | null
  background filter (or null for source)
- Optionalforeground: ImageFilter | null
  foreground filter (or null for source)
Returns ImageFilter | null
- Defined in index.d.ts:2379

`Static`MakeBlend

MakeBlend(
    mode: BlendMode,
    background?: ImageFilter | null,
    foreground?: ImageFilter | null,
): ImageFilter | null
Blend two image filters using a blend mode.
Parameters
- mode: BlendMode
  blend mode ("srcOver", "multiply", "screen", etc.)
- Optionalbackground: ImageFilter | null
  background filter (or null for source)
- Optionalforeground: ImageFilter | null
  foreground filter (or null for source)
Returns ImageFilter | null
- Defined in index.d.ts:2363

`Static`MakeBlur

MakeBlur(
    sigmaX: number,
    sigmaY: number,
    tileMode?: "repeat" | "clamp" | "mirror" | "decal",
    input?: ImageFilter | null,
): ImageFilter | null
Create blur ImageFilter.
Parameters
- sigmaX: number
  horizontal blur radius
- sigmaY: number
  vertical blur radius
- OptionaltileMode: "repeat" | "clamp" | "mirror" | "decal"
  edge behavior: "clamp" | "repeat" | "mirror" | "decal"
- Optionalinput: ImageFilter | null
  optional input filter for chaining
Returns ImageFilter | null
- Defined in index.d.ts:2240

`Static`MakeColorFilter

MakeColorFilter(
colorFilter: ColorFilter,
input?: ImageFilter | null,
): ImageFilter | null
Create ImageFilter from ColorFilter.
Parameters
- colorFilter: ColorFilter
  The color filter to wrap
- Optionalinput: ImageFilter | null
  Optional previous filter for chaining
Returns ImageFilter | null
ImageFilter or null on Skia internal failure

Throws
Error if colorFilter has been deleted
- Defined in index.d.ts:2218

`Static`MakeCompose

MakeCompose(outer: ImageFilter, inner: ImageFilter): ImageFilter | null
Compose two ImageFilters (outer applied after inner).
Parameters
- outer: ImageFilter
- inner: ImageFilter
Returns ImageFilter | null
ImageFilter or null on Skia internal failure

Throws
Error if either filter has been deleted
- Defined in index.d.ts:2228

`Static`MakeCrop

MakeCrop(
    rect: [number, number, number, number],
    tileMode?: TileMode,
    input?: ImageFilter | null,
): ImageFilter | null
Crop filter with optional tile mode.
Parameters
- rect: [number, number, number, number]
  [x, y, width, height] crop rectangle
- OptionaltileMode: TileMode
  tile mode for pixels outside rect (default "decal")
- Optionalinput: ImageFilter | null
  optional input filter for chaining
Returns ImageFilter | null
- Defined in index.d.ts:2473

`Static`MakeDilate

MakeDilate(
    radiusX: number,
    radiusY: number,
    input?: ImageFilter | null,
    crop?: [number, number, number, number] | null,
): ImageFilter | null
Create morphological dilation ImageFilter.
Parameters
- radiusX: number
  horizontal radius
- radiusY: number
  vertical radius
- Optionalinput: ImageFilter | null
  optional input filter for chaining
- Optionalcrop: [number, number, number, number] | null
  🧪 [x, y, width, height] bounding the kernel's domain as well as clipping the output, so the dilation stops spreading at the edge rather than spreading and then being cut. Not the same as composing a separate "crop" filter afterwards.
Returns ImageFilter | null

Throws
TypeError if crop is given and is not four finite numbers
- Defined in index.d.ts:2306

`Static`MakeDisplacementMap

MakeDisplacementMap(
    xChannel: ColorChannel,
    yChannel: ColorChannel,
    scale: number,
    displacement?: ImageFilter | null,
    color?: ImageFilter | null,
): ImageFilter | null
Displacement map filter.
Parameters
- xChannel: ColorChannel
  color channel for x displacement ("R", "G", "B", "A")
- yChannel: ColorChannel
  color channel for y displacement ("R", "G", "B", "A")
- scale: number
  displacement scale
- Optionaldisplacement: ImageFilter | null
  displacement map filter (or null for source)
- Optionalcolor: ImageFilter | null
  color source filter (or null for source)
Returns ImageFilter | null
- Defined in index.d.ts:2397

`Static`MakeDistantLitDiffuse

MakeDistantLitDiffuse(
    direction: Point3,
    lightColor: string,
    surfaceScale: number,
    kd: number,
    input?: ImageFilter | null,
): ImageFilter | null
Diffuse lighting from a distant light source.
Parameters
- direction: Point3
  [x, y, z] light direction
- lightColor: string
  CSS color of the light
- surfaceScale: number
  height scale factor
- kd: number
  diffuse reflectance coefficient
- Optionalinput: ImageFilter | null
  optional input filter (alpha as height map)
Returns ImageFilter | null
- Defined in index.d.ts:2489

`Static`MakeDistantLitSpecular

MakeDistantLitSpecular(
    direction: Point3,
    lightColor: string,
    surfaceScale: number,
    ks: number,
    shininess: number,
    input?: ImageFilter | null,
): ImageFilter | null
Specular lighting from a distant light source.
Parameters
- direction: Point3
  [x, y, z] light direction
- lightColor: string
  CSS color of the light
- surfaceScale: number
  height scale factor
- ks: number
  specular reflectance coefficient
- shininess: number
  specular exponent
- Optionalinput: ImageFilter | null
  optional input filter
Returns ImageFilter | null
- Defined in index.d.ts:2545

`Static`MakeDropShadow

MakeDropShadow(
    dx: number,
    dy: number,
    sigmaX: number,
    sigmaY: number,
    color: string | [number, number, number, number],
    input?: ImageFilter | null,
): ImageFilter | null
Create drop shadow ImageFilter.
Parameters
- dx: number
  shadow x offset
- dy: number
  shadow y offset
- sigmaX: number
  horizontal blur radius
- sigmaY: number
  vertical blur radius
- color: string | [number, number, number, number]
  CSS color string or [r,g,b,a] array (0-1 floats)
- Optionalinput: ImageFilter | null
  optional input filter for chaining
Returns ImageFilter | null
- Defined in index.d.ts:2256

`Static`MakeDropShadowOnly

MakeDropShadowOnly(
    dx: number,
    dy: number,
    sigmaX: number,
    sigmaY: number,
    color: string | [number, number, number, number],
    input?: ImageFilter | null,
): ImageFilter | null
Create drop shadow ImageFilter (shadow only, no source image).
Parameters
- dx: number
  shadow x offset
- dy: number
  shadow y offset
- sigmaX: number
  horizontal blur radius
- sigmaY: number
  vertical blur radius
- color: string | [number, number, number, number]
  CSS color string or [r,g,b,a] array (0-1 floats)
- Optionalinput: ImageFilter | null
  optional input filter for chaining
Returns ImageFilter | null
- Defined in index.d.ts:2274

`Static`MakeEmpty

MakeEmpty(): ImageFilter
A filter that produces no output.

Empty means an empty result, not an absent filter: anything drawn through it disappears. Assign null to ctx.imageFilter to draw unfiltered.

Returns ImageFilter
- Defined in index.d.ts:2341

`Static`MakeErode

MakeErode(
    radiusX: number,
    radiusY: number,
    input?: ImageFilter | null,
    crop?: [number, number, number, number] | null,
): ImageFilter | null
Create morphological erosion ImageFilter.
Parameters
- radiusX: number
  horizontal radius
- radiusY: number
  vertical radius
- Optionalinput: ImageFilter | null
  optional input filter for chaining
- Optionalcrop: [number, number, number, number] | null
  🧪 [x, y, width, height] bounding the kernel's domain as well as clipping the output. See ImageFilter.MakeDilate.
Returns ImageFilter | null

Throws
TypeError if crop is given and is not four finite numbers
- Defined in index.d.ts:2322

`Static`MakeMagnifier

MakeMagnifier(
    lensBounds: [number, number, number, number],
    zoomAmount: number,
    inset: number,
    sampling?: SamplingMode,
    input?: ImageFilter | null,
): ImageFilter | null
Magnifier (fisheye) effect.
Parameters
- lensBounds: [number, number, number, number]
  [x, y, width, height] of lens area
- zoomAmount: number
  magnification factor
- inset: number
  edge distortion width
- Optionalsampling: SamplingMode
  sampling mode (default "linear")
- Optionalinput: ImageFilter | null
  optional input filter for chaining
Returns ImageFilter | null
- Defined in index.d.ts:2459

`Static`MakeMatrixConvolution

MakeMatrixConvolution(
    kernelSize: [number, number],
    kernel: number[],
    gain: number,
    bias: number,
    kernelOffset: [number, number],
    tileMode?: TileMode,
    convolveAlpha?: boolean,
    input?: ImageFilter | null,
    crop?: [number, number, number, number] | null,
): ImageFilter | null
Matrix convolution filter (e.g., sharpen, edge detect).
Parameters
- kernelSize: [number, number]
  [width, height] of kernel
- kernel: number[]
  convolution kernel (width*height elements)
- gain: number
  scale factor applied to result
- bias: number
  bias added to result
- kernelOffset: [number, number]
  [x, y] offset for kernel center
- OptionaltileMode: TileMode
  tile mode for edge handling (default "decal")
- OptionalconvolveAlpha: boolean
  whether to convolve alpha channel (default true)
- Optionalinput: ImageFilter | null
  optional input filter for chaining
- Optionalcrop: [number, number, number, number] | null
  🧪 [x, y, width, height] bounding the kernel's domain as well as clipping the output. See ImageFilter.MakeDilate.
Returns ImageFilter | null
- Defined in index.d.ts:2418

`Static`MakeMatrixTransform

MakeMatrixTransform(
    matrix: number[],
    sampling?: SamplingMode,
    input?: ImageFilter | null,
): ImageFilter | null
Apply a matrix transformation to the image.

The two lengths are read in different orders, so they are not the same matrix written two ways. Six elements are [a, b, c, d, e, f] in canvas transform() order -- b and c are the skews, e and f the translation -- while nine are plain row-major. A uniform 2x scale is therefore [2, 0, 0, 2, 0, 0]; the row-major-looking [2, 0, 0, 0, 2, 0] sets the vertical scale to zero and Skia returns null.
Parameters
- matrix: number[]
  6 elements in transform() order, or 9 row-major
- Optionalsampling: SamplingMode
  one of the four SamplingMode names (default "linear")
- Optionalinput: ImageFilter | null
  optional input filter for chaining
Returns ImageFilter | null
- Defined in index.d.ts:2445

`Static`MakeMerge

MakeMerge(filters: (ImageFilter | null)[]): ImageFilter | null
Merge multiple ImageFilters into one.
Parameters
- filters: (ImageFilter | null)[]
  array of filters to merge (null entries allowed)
Returns ImageFilter | null
- Defined in index.d.ts:2333

`Static`MakeOffset

MakeOffset(
    dx: number,
    dy: number,
    input?: ImageFilter | null,
): ImageFilter | null
Create offset ImageFilter.
Parameters
- dx: number
  x offset
- dy: number
  y offset
- Optionalinput: ImageFilter | null
  optional input filter for chaining
Returns ImageFilter | null
- Defined in index.d.ts:2289

`Static`MakePointLitDiffuse

MakePointLitDiffuse(
    location: Point3,
    lightColor: string,
    surfaceScale: number,
    kd: number,
    input?: ImageFilter | null,
): ImageFilter | null
Diffuse lighting from a point light source.
Parameters
- location: Point3
  [x, y, z] light position
- lightColor: string
  CSS color of the light
- surfaceScale: number
  height scale factor
- kd: number
  diffuse reflectance coefficient
- Optionalinput: ImageFilter | null
  optional input filter
Returns ImageFilter | null
- Defined in index.d.ts:2505

`Static`MakePointLitSpecular

MakePointLitSpecular(
    location: Point3,
    lightColor: string,
    surfaceScale: number,
    ks: number,
    shininess: number,
    input?: ImageFilter | null,
): ImageFilter | null
Specular lighting from a point light source.
Parameters
- location: Point3
  [x, y, z] light position
- lightColor: string
  CSS color of the light
- surfaceScale: number
  height scale factor
- ks: number
  specular reflectance coefficient
- shininess: number
  specular exponent
- Optionalinput: ImageFilter | null
  optional input filter
Returns ImageFilter | null
- Defined in index.d.ts:2563

`Static`MakeSpotLitDiffuse

MakeSpotLitDiffuse(
    location: Point3,
    target: Point3,
    falloffExponent: number,
    cutoffAngle: number,
    lightColor: string,
    surfaceScale: number,
    kd: number,
    input?: ImageFilter | null,
): ImageFilter | null
Diffuse lighting from a spot light source.
Parameters
- location: Point3
  [x, y, z] light position
- target: Point3
  [x, y, z] spot target
- falloffExponent: number
  how sharply the light fades toward the edge of the cone
- cutoffAngle: number
  the cone's half-angle, in degrees
- lightColor: string
  CSS color of the light
- surfaceScale: number
  height scale factor
- kd: number
  diffuse reflectance coefficient
- Optionalinput: ImageFilter | null
  optional input filter
Returns ImageFilter | null
- Defined in index.d.ts:2525

`Static`MakeSpotLitSpecular

MakeSpotLitSpecular(
    location: Point3,
    target: Point3,
    falloffExponent: number,
    cutoffAngle: number,
    lightColor: string,
    surfaceScale: number,
    ks: number,
    shininess: number,
    input?: ImageFilter | null,
): ImageFilter | null
Specular lighting from a spot light source.
Parameters
- location: Point3
  [x, y, z] light position
- target: Point3
  [x, y, z] spot target
- falloffExponent: number
  how sharply the light fades toward the edge of the cone
- cutoffAngle: number
  the cone's half-angle, in degrees
- lightColor: string
  CSS color of the light
- surfaceScale: number
  height scale factor
- ks: number
  specular reflectance coefficient
- shininess: number
  specular exponent
- Optionalinput: ImageFilter | null
  optional input filter
Returns ImageFilter | null
- Defined in index.d.ts:2585

`Static`MakeTile

MakeTile(
    src: [number, number, number, number],
    dst: [number, number, number, number],
    input?: ImageFilter | null,
): ImageFilter | null
Create tile ImageFilter.
Parameters
- src: [number, number, number, number]
  source rect [x, y, width, height]
- dst: [number, number, number, number]
  destination rect [x, y, width, height]
- Optionalinput: ImageFilter | null
  optional input filter for chaining
Returns ImageFilter | null
- Defined in index.d.ts:2349

Class ImageFilter

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ImageFilter

Throws

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Parameters

Returns ImageFilter

Methods

delete

Returns void

StaticMakeArithmetic

Parameters

Returns ImageFilter | null

StaticMakeBlend

Parameters

Returns ImageFilter | null

StaticMakeBlur

Parameters

Returns ImageFilter | null

StaticMakeColorFilter

Parameters

Returns ImageFilter | null

Throws

StaticMakeCompose

Parameters

Returns ImageFilter | null

Throws

StaticMakeCrop

Parameters

Returns ImageFilter | null

StaticMakeDilate

Parameters

`Static`MakeArithmetic

`Static`MakeBlend

`Static`MakeBlur

`Static`MakeColorFilter

`Static`MakeCompose

`Static`MakeCrop

`Static`MakeDilate

`Static`MakeDisplacementMap

`Static`MakeDistantLitDiffuse

`Static`MakeDistantLitSpecular

`Static`MakeDropShadow

`Static`MakeDropShadowOnly

`Static`MakeEmpty

`Static`MakeErode

`Static`MakeMagnifier

`Static`MakeMatrixConvolution

`Static`MakeMatrixTransform

`Static`MakeMerge

`Static`MakeOffset

`Static`MakePointLitDiffuse

`Static`MakePointLitSpecular

`Static`MakeSpotLitDiffuse

`Static`MakeSpotLitSpecular

`Static`MakeTile