Skip to content

Kernel Filter

Kernel Filter
Filters
Kernel
Identity
Gain
1
Bias
Tile Mode
Clamp
On Alpha
false
Previous
null

Category Filters
Is Pair Node: No


Creates a kernel filter that can be applied to an image. The filter applies a convolution operation using the specified kernel, which is a matrix that defines how the filter will affect the pixels in the image. The kernel size must be odd (e.g., 3x3, 5x5). The filter can also apply a gain and bias to the resulting pixel values, and it can be configured to apply to the alpha channel as well.

The Kernel input is a matrix that defines how the filter will affect the pixels in the image. The kernel size must be odd (e.g., 3x3, 5x5). The kernel is applied to each pixel in the image by performing a convolution operation, which involves multiplying the kernel values with the corresponding pixel values in the neighborhood of each pixel.

Use built-in UI to change the kernel and it’s size.

The Tile Mode input determines how the edges of the image are handled when the kernel is applied. The available modes are:

  • Clamp: The edges of the image are clamped, meaning that the pixels will be replicated at the edges.
  • Repeat: The image is repeated, meaning that the pixels will wrap around the edges.
  • Mirror: The image is mirrored, meaning that the pixels will be reflected at the edges.
  • Decal: Render the image pixels only within its original bounds.


Type: Kernel
Default: Identity

The kernel to apply to the image. This is a matrix that defines how the filter will affect the pixels in the image. The kernel size must be odd (e.g., 3x3, 5x5).

Type: Double
Default: 1

A scale factor applied to each pixel after convolution. This can be used to normalize the kernel, if it does not sum to 1.

Type: Double
Default: 0

A bias factor added to each pixel after convolution.

Type: Tile Mode (Enum)
Default: Clamp

The tile mode to use when the kernel is applied to the image. This determines how the edges of the image are handled when the kernel is applied.

Type: Boolean
Default: false

Whether to apply the kernel to the alpha channel of the image. If true, the kernel will be applied to the alpha channel as well as the RGB channels.

Type: Filter
Default: null

Previous filter in the chain. It will be applied before the kernel filter.


Type: Filter
Default: null

Kernel filter that can be applied to the image.