From c640a496d63036ead177dd006ef56b9b12d962bb Mon Sep 17 00:00:00 2001 From: Gunnar Sletta Date: Thu, 7 Nov 2013 12:05:08 +0100 Subject: Document recursion limitations of the graphical effects. Task-number: QTBUG-31902 Change-Id: Id9d81ffddda3ee666840f602bb8c85ff00545547 Reviewed-by: Jerome Pasion --- src/effects/Blend.qml | 6 ++++++ src/effects/BrightnessContrast.qml | 3 +++ src/effects/ColorOverlay.qml | 3 +++ src/effects/Colorize.qml | 3 +++ src/effects/ConicalGradient.qml | 3 +++ src/effects/Desaturate.qml | 3 +++ src/effects/DirectionalBlur.qml | 3 +++ src/effects/Displace.qml | 3 +++ src/effects/DropShadow.qml | 3 +++ src/effects/FastBlur.qml | 3 +++ src/effects/GammaAdjust.qml | 3 +++ src/effects/GaussianBlur.qml | 3 +++ src/effects/Glow.qml | 3 +++ src/effects/HueSaturation.qml | 3 +++ src/effects/InnerShadow.qml | 3 +++ src/effects/LevelAdjust.qml | 3 +++ src/effects/LinearGradient.qml | 2 ++ src/effects/MaskedBlur.qml | 3 +++ src/effects/OpacityMask.qml | 6 ++++++ src/effects/RadialBlur.qml | 3 +++ src/effects/RadialGradient.qml | 3 +++ src/effects/RecursiveBlur.qml | 3 +++ src/effects/ThresholdMask.qml | 6 ++++++ src/effects/ZoomBlur.qml | 3 +++ 24 files changed, 80 insertions(+) diff --git a/src/effects/Blend.qml b/src/effects/Blend.qml index 9d0e134..59d8646 100644 --- a/src/effects/Blend.qml +++ b/src/effects/Blend.qml @@ -75,12 +75,18 @@ Item { /*! This property defines the source item that is going to be the base when \l{Blend::foregroundSource}{foregroundSource} is blended over it. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source /*! This property defines the item that is going to be blended over the \l{Blend::source}{source}. + + \note It is not supported to let the effect include itself, for + instance by setting foregroundSource to the effect's parent. */ property variant foregroundSource diff --git a/src/effects/BrightnessContrast.qml b/src/effects/BrightnessContrast.qml index 0cdf3ee..db53acb 100644 --- a/src/effects/BrightnessContrast.qml +++ b/src/effects/BrightnessContrast.qml @@ -75,6 +75,9 @@ Item { /*! This property defines the source item that provides the source pixels for the effect. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source diff --git a/src/effects/ColorOverlay.qml b/src/effects/ColorOverlay.qml index 5fe5471..fedc050 100644 --- a/src/effects/ColorOverlay.qml +++ b/src/effects/ColorOverlay.qml @@ -73,6 +73,9 @@ Item { /*! This property defines the source item that provides the source pixels for the effect. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source diff --git a/src/effects/Colorize.qml b/src/effects/Colorize.qml index 7001965..62e1312 100644 --- a/src/effects/Colorize.qml +++ b/src/effects/Colorize.qml @@ -79,6 +79,9 @@ Item { /*! This property defines the source item that provides the source pixels for the effect. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source diff --git a/src/effects/ConicalGradient.qml b/src/effects/ConicalGradient.qml index 20296fa..c2492f4 100644 --- a/src/effects/ConicalGradient.qml +++ b/src/effects/ConicalGradient.qml @@ -181,6 +181,9 @@ Item { \li \l verticalOffset: 0 \endtable + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source diff --git a/src/effects/Desaturate.qml b/src/effects/Desaturate.qml index 43c302d..a05cb59 100644 --- a/src/effects/Desaturate.qml +++ b/src/effects/Desaturate.qml @@ -73,6 +73,9 @@ Item { /*! This property defines the source item that provides the source pixels to the effect. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source diff --git a/src/effects/DirectionalBlur.qml b/src/effects/DirectionalBlur.qml index 0cc2765..248e0c5 100644 --- a/src/effects/DirectionalBlur.qml +++ b/src/effects/DirectionalBlur.qml @@ -77,6 +77,9 @@ Item { /*! This property defines the source item that is going to be blurred. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source diff --git a/src/effects/Displace.qml b/src/effects/Displace.qml index dfb0a81..142ae10 100644 --- a/src/effects/Displace.qml +++ b/src/effects/Displace.qml @@ -74,6 +74,9 @@ Item { This property defines the source item for the pixels that are going to be displaced according to the data from \l{Displace::displacementSource}{displacementSource}. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source diff --git a/src/effects/DropShadow.qml b/src/effects/DropShadow.qml index 52cb409..b73e244 100644 --- a/src/effects/DropShadow.qml +++ b/src/effects/DropShadow.qml @@ -81,6 +81,9 @@ Item { /*! This property defines the source item that is going to be used as the source for the generated shadow. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source diff --git a/src/effects/FastBlur.qml b/src/effects/FastBlur.qml index 659958c..ca38ad2 100644 --- a/src/effects/FastBlur.qml +++ b/src/effects/FastBlur.qml @@ -77,6 +77,9 @@ Item { /*! This property defines the source item that is going to be blurred. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source diff --git a/src/effects/GammaAdjust.qml b/src/effects/GammaAdjust.qml index 3714437..7a597dd 100644 --- a/src/effects/GammaAdjust.qml +++ b/src/effects/GammaAdjust.qml @@ -75,6 +75,9 @@ Item { /*! This property defines the source item for which the luminance is going to be adjusted. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source diff --git a/src/effects/GaussianBlur.qml b/src/effects/GaussianBlur.qml index c90e8b9..4000179 100644 --- a/src/effects/GaussianBlur.qml +++ b/src/effects/GaussianBlur.qml @@ -74,6 +74,9 @@ Item { /*! This property defines the source item that is going to be blurred. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source diff --git a/src/effects/Glow.qml b/src/effects/Glow.qml index 024915b..c5a82c6 100644 --- a/src/effects/Glow.qml +++ b/src/effects/Glow.qml @@ -77,6 +77,9 @@ Item { /*! This property defines the source item that is going to be used as source for the generated glow. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source diff --git a/src/effects/HueSaturation.qml b/src/effects/HueSaturation.qml index f390ea8..fb1d895 100644 --- a/src/effects/HueSaturation.qml +++ b/src/effects/HueSaturation.qml @@ -75,6 +75,9 @@ Item { /*! This property defines the source item that provides the source pixels for the effect. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source: 0 diff --git a/src/effects/InnerShadow.qml b/src/effects/InnerShadow.qml index 6e42791..5eebc6f 100644 --- a/src/effects/InnerShadow.qml +++ b/src/effects/InnerShadow.qml @@ -78,6 +78,9 @@ Item { /*! This property defines the source item that is going to be used as the source for the generated shadow. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source diff --git a/src/effects/LevelAdjust.qml b/src/effects/LevelAdjust.qml index 3861f30..5d739fb 100644 --- a/src/effects/LevelAdjust.qml +++ b/src/effects/LevelAdjust.qml @@ -73,6 +73,9 @@ Item { /*! This property defines the source item that provides the source pixels for the effect. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source diff --git a/src/effects/LinearGradient.qml b/src/effects/LinearGradient.qml index 38d85d9..b5845ea 100644 --- a/src/effects/LinearGradient.qml +++ b/src/effects/LinearGradient.qml @@ -169,6 +169,8 @@ Item { \li \l end: Qt.point(300, 300) \endtable + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source diff --git a/src/effects/MaskedBlur.qml b/src/effects/MaskedBlur.qml index 44000cf..4744d9f 100644 --- a/src/effects/MaskedBlur.qml +++ b/src/effects/MaskedBlur.qml @@ -80,6 +80,9 @@ Item { /*! This property defines the source item that is going to be blurred. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source diff --git a/src/effects/OpacityMask.qml b/src/effects/OpacityMask.qml index b2e88de..3a6e25a 100644 --- a/src/effects/OpacityMask.qml +++ b/src/effects/OpacityMask.qml @@ -71,6 +71,9 @@ Item { /*! This property defines the source item that is going to be masked. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source @@ -105,6 +108,9 @@ Item { properties are animated. By default, the property is set to \c false. + + \note It is not supported to let the effect include itself, for + instance by setting maskSource to the effect's parent. */ property bool cached: false diff --git a/src/effects/RadialBlur.qml b/src/effects/RadialBlur.qml index 588608d..26315aa 100644 --- a/src/effects/RadialBlur.qml +++ b/src/effects/RadialBlur.qml @@ -76,6 +76,9 @@ Item { /*! This property defines the source item that is going to be blurred. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source diff --git a/src/effects/RadialGradient.qml b/src/effects/RadialGradient.qml index 175fede..66c2cd6 100644 --- a/src/effects/RadialGradient.qml +++ b/src/effects/RadialGradient.qml @@ -240,6 +240,9 @@ Item { \li \l angle: 0 \li \l angle: 0 \endtable + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source diff --git a/src/effects/RecursiveBlur.qml b/src/effects/RecursiveBlur.qml index 1d08f81..fa59281 100644 --- a/src/effects/RecursiveBlur.qml +++ b/src/effects/RecursiveBlur.qml @@ -76,6 +76,9 @@ Item { /*! This property defines the source item that is going to be blurred. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source diff --git a/src/effects/ThresholdMask.qml b/src/effects/ThresholdMask.qml index 35fade7..e789a49 100644 --- a/src/effects/ThresholdMask.qml +++ b/src/effects/ThresholdMask.qml @@ -74,6 +74,9 @@ Item { /*! This property defines the source item that is going to be masked. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source @@ -93,6 +96,9 @@ Item { \li \image ThresholdMask_mask.png \li \image ThresholdMask_bug.png \endtable + + \note It is not supported to let the effect include itself, for + instance by setting maskSource to the effect's parent. */ property variant maskSource diff --git a/src/effects/ZoomBlur.qml b/src/effects/ZoomBlur.qml index b028a43..74a5940 100644 --- a/src/effects/ZoomBlur.qml +++ b/src/effects/ZoomBlur.qml @@ -75,6 +75,9 @@ Item { /*! This property defines the source item that is going to be blurred. + + \note It is not supported to let the effect include itself, for + instance by setting source to the effect's parent. */ property variant source -- cgit v1.2.3