git subrepo clone --branch=sono6good https://github.com/essej/JUCE.git deps/juce
subrepo: subdir: "deps/juce" merged: "b13f9084e" upstream: origin: "https://github.com/essej/JUCE.git" branch: "sono6good" commit: "b13f9084e" git-subrepo: version: "0.4.3" origin: "https://github.com/ingydotnet/git-subrepo.git" commit: "2f68596"
This commit is contained in:
112
deps/juce/modules/juce_graphics/images/juce_ImageConvolutionKernel.h
vendored
Normal file
112
deps/juce/modules/juce_graphics/images/juce_ImageConvolutionKernel.h
vendored
Normal file
@ -0,0 +1,112 @@
|
||||
/*
|
||||
==============================================================================
|
||||
|
||||
This file is part of the JUCE library.
|
||||
Copyright (c) 2020 - Raw Material Software Limited
|
||||
|
||||
JUCE is an open source library subject to commercial or open-source
|
||||
licensing.
|
||||
|
||||
By using JUCE, you agree to the terms of both the JUCE 6 End-User License
|
||||
Agreement and JUCE Privacy Policy (both effective as of the 16th June 2020).
|
||||
|
||||
End User License Agreement: www.juce.com/juce-6-licence
|
||||
Privacy Policy: www.juce.com/juce-privacy-policy
|
||||
|
||||
Or: You may also use this code under the terms of the GPL v3 (see
|
||||
www.gnu.org/licenses).
|
||||
|
||||
JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
|
||||
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR 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
|
Reference in New Issue
Block a user