mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-09 23:34:20 +00:00
121 lines
4.6 KiB
C++
121 lines
4.6 KiB
C++
/*
|
|
==============================================================================
|
|
|
|
This file is part of the JUCE framework.
|
|
Copyright (c) Raw Material Software Limited
|
|
|
|
JUCE is an open source framework subject to commercial or open source
|
|
licensing.
|
|
|
|
By downloading, installing, or using the JUCE framework, or combining the
|
|
JUCE framework with any other source code, object code, content or any other
|
|
copyrightable work, you agree to the terms of the JUCE End User Licence
|
|
Agreement, and all incorporated terms including the JUCE Privacy Policy and
|
|
the JUCE Website Terms of Service, as applicable, which will bind you. If you
|
|
do not agree to the terms of these agreements, we will not license the JUCE
|
|
framework to you, and you must discontinue the installation or download
|
|
process and cease use of the JUCE framework.
|
|
|
|
JUCE End User Licence Agreement: https://juce.com/legal/juce-8-licence/
|
|
JUCE Privacy Policy: https://juce.com/juce-privacy-policy
|
|
JUCE Website Terms of Service: https://juce.com/juce-website-terms-of-service/
|
|
|
|
Or:
|
|
|
|
You may also use this code under the terms of the AGPLv3:
|
|
https://www.gnu.org/licenses/agpl-3.0.en.html
|
|
|
|
THE JUCE FRAMEWORK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL
|
|
WARRANTIES, WHETHER EXPRESSED OR IMPLIED, INCLUDING WARRANTY OF
|
|
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, ARE DISCLAIMED.
|
|
|
|
==============================================================================
|
|
*/
|
|
|
|
namespace juce
|
|
{
|
|
|
|
//==============================================================================
|
|
/**
|
|
Represents a filter kernel to use in convoluting an image.
|
|
|
|
@see Image::applyConvolution
|
|
|
|
@tags{Graphics}
|
|
*/
|
|
class JUCE_API ImageConvolutionKernel
|
|
{
|
|
public:
|
|
//==============================================================================
|
|
/** Creates an empty convolution kernel.
|
|
|
|
@param size the length of each dimension of the kernel, so e.g. if the size
|
|
is 5, it will create a 5x5 kernel
|
|
*/
|
|
ImageConvolutionKernel (int size);
|
|
|
|
/** Destructor. */
|
|
~ImageConvolutionKernel();
|
|
|
|
//==============================================================================
|
|
/** Resets all values in the kernel to zero. */
|
|
void clear();
|
|
|
|
/** Returns one of the kernel values. */
|
|
float getKernelValue (int x, int y) const noexcept;
|
|
|
|
/** Sets the value of a specific cell in the kernel.
|
|
|
|
The x and y parameters must be in the range 0 < x < getKernelSize().
|
|
|
|
@see setOverallSum
|
|
*/
|
|
void setKernelValue (int x, int y, float value) noexcept;
|
|
|
|
/** Rescales all values in the kernel to make the total add up to a fixed value.
|
|
|
|
This will multiply all values in the kernel by (desiredTotalSum / currentTotalSum).
|
|
*/
|
|
void setOverallSum (float desiredTotalSum);
|
|
|
|
/** Multiplies all values in the kernel by a value. */
|
|
void rescaleAllValues (float multiplier);
|
|
|
|
/** Initialises the kernel for a gaussian blur.
|
|
|
|
@param 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).
|
|
*/
|
|
void createGaussianBlur (float blurRadius);
|
|
|
|
//==============================================================================
|
|
/** Returns the size of the kernel.
|
|
|
|
E.g. if it's a 3x3 kernel, this returns 3.
|
|
*/
|
|
int getKernelSize() const { return size; }
|
|
|
|
//==============================================================================
|
|
/** Applies the kernel to an image.
|
|
|
|
@param destImage the image that will receive the resultant convoluted pixels.
|
|
@param 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.
|
|
@param destinationArea the region of the image to apply the filter to
|
|
*/
|
|
void applyToImage (Image& destImage,
|
|
const Image& sourceImage,
|
|
const Rectangle<int>& destinationArea) const;
|
|
|
|
private:
|
|
//==============================================================================
|
|
HeapBlock<float> values;
|
|
const int size;
|
|
|
|
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ImageConvolutionKernel)
|
|
};
|
|
|
|
} // namespace juce
|