Represents a filter kernel to use in convoluting an image. More...

#include "juce_ImageConvolutionKernel.h"

Public Member Functions
	ImageConvolutionKernel (int size)
	Creates an empty convolution kernel.

	~ImageConvolutionKernel ()
	Destructor.

void	clear ()
	Resets all values in the kernel to zero.

float	getKernelValue (int x, int y) const noexcept
	Returns one of the kernel values.

void	setKernelValue (int x, int y, float value) noexcept
	Sets the value of a specific cell in the kernel.

void	setOverallSum (float desiredTotalSum)
	Rescales all values in the kernel to make the total add up to a fixed value.

void	rescaleAllValues (float multiplier)
	Multiplies all values in the kernel by a value.

void	createGaussianBlur (float blurRadius)
	Initialises the kernel for a gaussian blur.

int	getKernelSize () const
	Returns the size of the kernel.

void	applyToImage (Image &destImage, const Image &sourceImage, const Rectangle< int > &destinationArea) const
	Applies the kernel to an image.

Detailed Description

Represents a filter kernel to use in convoluting an image.

See also: Image::applyConvolution

@tags{Graphics}

Definition at line 37 of file juce_ImageConvolutionKernel.h.

Constructor & Destructor Documentation

◆ ImageConvolutionKernel()

juce::ImageConvolutionKernel::ImageConvolutionKernel ( int size )

Creates an empty convolution kernel.

Parameters

size	the length of each dimension of the kernel, so e.g. if the size is 5, it will create a 5x5 kernel

Definition at line 29 of file juce_ImageConvolutionKernel.cpp.

◆ ~ImageConvolutionKernel()

juce::ImageConvolutionKernel::~ImageConvolutionKernel ( )

Destructor.

Definition at line 36 of file juce_ImageConvolutionKernel.cpp.

Member Function Documentation

◆ applyToImage()

void juce::ImageConvolutionKernel::applyToImage	(	Image &	destImage,
		const Image &	sourceImage,
		const Rectangle< int > &	destinationArea
	)		const

Applies the kernel to an image.

Parameters

destImage	the image that will receive the resultant convoluted pixels.
sourceImage	the source image to read from - this can be the same image as the destination, but if different, it must be exactly the same size and format.
destinationArea	the region of the image to apply the filter to

Definition at line 105 of file juce_ImageConvolutionKernel.cpp.

◆ clear()

void juce::ImageConvolutionKernel::clear ( )

Resets all values in the kernel to zero.

Definition at line 62 of file juce_ImageConvolutionKernel.cpp.

◆ createGaussianBlur()

void juce::ImageConvolutionKernel::createGaussianBlur ( float blurRadius )

Initialises the kernel for a gaussian blur.

Parameters

blurRadius this may be larger or smaller than the kernel's actual size but this will obviously be wasteful or clip at the edges. Ideally the kernel should be just larger than (blurRadius * 2).

Definition at line 85 of file juce_ImageConvolutionKernel.cpp.