Function convolute

plugins/plugin-color/src/index.ts:751–775

* Applies a convolution kernel to the image or a region * @example * ```ts * import { Jimp } from "jimp"; * * const image = await Jimp.read("test/image.png"); * * // apply a convolution kernel to the whole image * image.convolution([ * [-1, -1, 0], * [-1, 1, 1],

(image: I, options: ConvoluteOptions)

   * ```
   */
  convolute<I extends JimpClass>(image: I, options: ConvoluteOptions) {
    const parsed = ConvoluteOptionsSchema.parse(options);
    const {
      kernel,
      x = 0,
      y = 0,
      w = image.bitmap.width - x,
      h = image.bitmap.height - y,
    } = "kernel" in parsed
      ? parsed
      : ({ kernel: parsed } as ConvoluteComplexOptions);

    const source = clone(image);

    scan(source, x, y, w, h, (xx, yx, idx) => {
      const value = applyKernel(source, kernel, xx, yx);

      image.bitmap.data[idx] = limit255(value[0]!);
      image.bitmap.data[idx + 1] = limit255(value[1]!);
      image.bitmap.data[idx + 2] = limit255(value[2]!);
      image.bitmap.data[idx + 3] = limit255(value[3]!);
    });

    return image;
  },

  /**
   * Apply multiple color modification rules