sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-12-15 00:07:25 -05:00
Code Issues Packages Projects Releases Wiki Activity

Spelling

Browse Source
This commit is contained in:
Nyall Dawson 2021-09-23 10:38:26 +10:00
parent f4987b2268
commit 7027d72b3d
4 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
python/core/auto_generated/effects/qgsimageoperation.sip.in
View File

@ -52,7 +52,7 @@ Convert a QImage to a grayscale image. Alpha channel is preserved.
:param image: QImage to convert
:param mode: mode to use during grayscale conversion
:param feedback: optional feedback object for responsive cancelation (since QGIS 3.22)
:param feedback: optional feedback object for responsive cancellation (since QGIS 3.22)
%End
static void adjustBrightnessContrast( QImage &image, int brightness, double contrast, QgsFeedback *feedback = 0 );
@ -66,7 +66,7 @@ Alter the brightness or contrast of a QImage.
:param contrast: contrast value. Must be a positive or zero value. A value of 1.0 indicates no change
to the contrast, a value of 0 represents an image with 0 contrast, and a value > 1.0 will increase the
contrast of the image.
:param feedback: optional feedback object for responsive cancelation (since QGIS 3.22)
:param feedback: optional feedback object for responsive cancellation (since QGIS 3.22)
%End
static void adjustHueSaturation( QImage &image, double saturation, const QColor &colorizeColor = QColor(),
@ -79,7 +79,7 @@ Alter the hue or saturation of a QImage.
:param colorizeColor: color to use for colorizing image. Set to an invalid QColor to disable
colorization.
:param colorizeStrength: double between 0 and 1, where 0 = no colorization and 1.0 = full colorization
:param feedback: optional feedback object for responsive cancelation (since QGIS 3.22)
:param feedback: optional feedback object for responsive cancellation (since QGIS 3.22)
%End
static void multiplyOpacity( QImage &image, double factor, QgsFeedback *feedback = 0 );
@ -88,7 +88,7 @@ Multiplies opacity of image pixel values by a factor.
:param image: QImage to alter
:param factor: factor to multiple pixel's opacity by
:param feedback: optional feedback object for responsive cancelation (since QGIS 3.22)
:param feedback: optional feedback object for responsive cancellation (since QGIS 3.22)
%End
static void overlayColor( QImage &image, const QColor &color );
@ -120,7 +120,7 @@ using a color ramp.
:param image: QImage to alter
:param properties: DistanceTransformProperties object with parameters
for the distance transform operation
:param feedback: optional feedback object for responsive cancelation (since QGIS 3.22)
:param feedback: optional feedback object for responsive cancellation (since QGIS 3.22)
%End
static void stackBlur( QImage &image, int radius, bool alphaOnly = false, QgsFeedback *feedback = 0 );
@ -131,7 +131,7 @@ speed and blur quality.
:param image: QImage to blur
:param radius: blur radius in pixels, maximum value of 16
:param alphaOnly: set to ``True`` to blur only the alpha component of the image
:param feedback: optional feedback object for responsive cancelation (since QGIS 3.22)
:param feedback: optional feedback object for responsive cancellation (since QGIS 3.22)
.. note::
@ -146,7 +146,7 @@ quality blur.
:param image: QImage to blur
:param radius: blur radius in pixels
:param feedback: optional feedback object for responsive cancelation (since QGIS 3.22)
:param feedback: optional feedback object for responsive cancellation (since QGIS 3.22)
:return: blurred image

4
python/core/auto_generated/qgsrendercontext.sip.in
View File

@ -296,7 +296,7 @@ rendering should be canceled immediately.
.. note::
Since QGIS 3.22 the :py:func:`~QgsRenderContext.feedback` member exists as an alternative means of cancelation support.
Since QGIS 3.22 the :py:func:`~QgsRenderContext.feedback` member exists as an alternative means of cancellation support.
.. seealso:: :py:func:`setRenderingStopped`
@ -467,7 +467,7 @@ rendering should be canceled immediately.
.. note::
Since QGIS 3.22 the :py:func:`~QgsRenderContext.feedback` member exists as an alternative means of cancelation support.
Since QGIS 3.22 the :py:func:`~QgsRenderContext.feedback` member exists as an alternative means of cancellation support.
.. seealso:: :py:func:`renderingStopped`

14
src/core/effects/qgsimageoperation.h
View File

@ -73,7 +73,7 @@ class CORE_EXPORT QgsImageOperation
* Convert a QImage to a grayscale image. Alpha channel is preserved.
* \param image QImage to convert
* \param mode mode to use during grayscale conversion
* \param feedback optional feedback object for responsive cancelation (since QGIS 3.22)
* \param feedback optional feedback object for responsive cancellation (since QGIS 3.22)
*/
static void convertToGrayscale( QImage &image, GrayscaleMode mode = GrayscaleLuminosity, QgsFeedback *feedback = nullptr );
@ -86,7 +86,7 @@ class CORE_EXPORT QgsImageOperation
* \param contrast contrast value. Must be a positive or zero value. A value of 1.0 indicates no change
* to the contrast, a value of 0 represents an image with 0 contrast, and a value > 1.0 will increase the
* contrast of the image.
* \param feedback optional feedback object for responsive cancelation (since QGIS 3.22)
* \param feedback optional feedback object for responsive cancellation (since QGIS 3.22)
*/
static void adjustBrightnessContrast( QImage &image, int brightness, double contrast, QgsFeedback *feedback = nullptr );
@ -97,7 +97,7 @@ class CORE_EXPORT QgsImageOperation
* \param colorizeColor color to use for colorizing image. Set to an invalid QColor to disable
* colorization.
* \param colorizeStrength double between 0 and 1, where 0 = no colorization and 1.0 = full colorization
* \param feedback optional feedback object for responsive cancelation (since QGIS 3.22)
* \param feedback optional feedback object for responsive cancellation (since QGIS 3.22)
*/
static void adjustHueSaturation( QImage &image, double saturation, const QColor &colorizeColor = QColor(),
double colorizeStrength = 1.0, QgsFeedback *feedback = nullptr );
@ -106,7 +106,7 @@ class CORE_EXPORT QgsImageOperation
* Multiplies opacity of image pixel values by a factor.
* \param image QImage to alter
* \param factor factor to multiple pixel's opacity by
* \param feedback optional feedback object for responsive cancelation (since QGIS 3.22)
* \param feedback optional feedback object for responsive cancellation (since QGIS 3.22)
*/
static void multiplyOpacity( QImage &image, double factor, QgsFeedback *feedback = nullptr );
@ -153,7 +153,7 @@ class CORE_EXPORT QgsImageOperation
* \param image QImage to alter
* \param properties DistanceTransformProperties object with parameters
* for the distance transform operation
* \param feedback optional feedback object for responsive cancelation (since QGIS 3.22)
* \param feedback optional feedback object for responsive cancellation (since QGIS 3.22)
*/
static void distanceTransform( QImage &image, const QgsImageOperation::DistanceTransformProperties &properties, QgsFeedback *feedback = nullptr );
@ -163,7 +163,7 @@ class CORE_EXPORT QgsImageOperation
* \param image QImage to blur
* \param radius blur radius in pixels, maximum value of 16
* \param alphaOnly set to TRUE to blur only the alpha component of the image
* \param feedback optional feedback object for responsive cancelation (since QGIS 3.22)
* \param feedback optional feedback object for responsive cancellation (since QGIS 3.22)
* \note for fastest operation, ensure the source image is ARGB32_Premultiplied if
* alphaOnly is set to FALSE, or ARGB32 if alphaOnly is TRUE
*/
@ -174,7 +174,7 @@ class CORE_EXPORT QgsImageOperation
* quality blur.
* \param image QImage to blur
* \param radius blur radius in pixels
* \param feedback optional feedback object for responsive cancelation (since QGIS 3.22)
* \param feedback optional feedback object for responsive cancellation (since QGIS 3.22)
* \returns blurred image
* \note for fastest operation, ensure the source image is ARGB32_Premultiplied
*/

6
src/core/qgsrendercontext.h
View File

@ -344,7 +344,7 @@ class CORE_EXPORT QgsRenderContext : public QgsTemporalRangeObject
* Returns TRUE if the rendering operation has been stopped and any ongoing
* rendering should be canceled immediately.
*
* \note Since QGIS 3.22 the feedback() member exists as an alternative means of cancelation support.
* \note Since QGIS 3.22 the feedback() member exists as an alternative means of cancellation support.
*
* \see setRenderingStopped()
* \see feedback()
@ -508,7 +508,7 @@ class CORE_EXPORT QgsRenderContext : public QgsTemporalRangeObject
* Sets whether the rendering operation has been \a stopped and any ongoing
* rendering should be canceled immediately.
*
* \note Since QGIS 3.22 the feedback() member exists as an alternative means of cancelation support.
* \note Since QGIS 3.22 the feedback() member exists as an alternative means of cancellation support.
*
* \see renderingStopped()
* \see feedback()
@ -1005,7 +1005,7 @@ class CORE_EXPORT QgsRenderContext : public QgsTemporalRangeObject
//! True if the rendering has been canceled
bool mRenderingStopped = false;
//! Optional feedback object, as an alternative for mRenderingStopped for cancelation support
//! Optional feedback object, as an alternative for mRenderingStopped for cancellation support
QgsFeedback *mFeedback = nullptr;
//! Factor to scale line widths and point marker sizes