Document that the effects need OpenGL

Change-Id: Ie42ce93850475c036b2bb4e1fa9068c597317c48
Reviewed-by: Andy Nichols <andy.nichols@qt.io>

26 files changed, 58 insertions, 0 deletions

diff --git a/src/effects/Blend.qml b/src/effects/Blend.qml
index 34ed86e..5147567 100644
--- a/src/effects/Blend.qml
+++ b/src/effects/Blend.qml
@@ -62,6 +62,8 @@ import QtGraphicalEffects.private 1.0
         \li \image Blend_bug_and_butterfly.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/BrightnessContrast.qml b/src/effects/BrightnessContrast.qml
index f948235..8b2b04a 100644
--- a/src/effects/BrightnessContrast.qml
+++ b/src/effects/BrightnessContrast.qml
@@ -63,6 +63,8 @@ import QtGraphicalEffects.private 1.0
         \li \image BrightnessContrast_bug.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/ColorOverlay.qml b/src/effects/ColorOverlay.qml
index 550ecc9..d22146c 100644
--- a/src/effects/ColorOverlay.qml
+++ b/src/effects/ColorOverlay.qml
@@ -61,6 +61,8 @@ import QtGraphicalEffects.private 1.0
         \li \image ColorOverlay_butterfly.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/Colorize.qml b/src/effects/Colorize.qml
index ae018f7..d06f7f0 100644
--- a/src/effects/Colorize.qml
+++ b/src/effects/Colorize.qml
@@ -68,6 +68,8 @@ import QtGraphicalEffects.private 1.0
         \li \image Colorize_bug.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+    s
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/ConicalGradient.qml b/src/effects/ConicalGradient.qml
index d64ecf6..7aacebd 100644
--- a/src/effects/ConicalGradient.qml
+++ b/src/effects/ConicalGradient.qml
@@ -60,6 +60,8 @@ import QtGraphicalEffects.private 1.0
         \li \image ConicalGradient.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/Desaturate.qml b/src/effects/Desaturate.qml
index 0f9163c..391b2d3 100644
--- a/src/effects/Desaturate.qml
+++ b/src/effects/Desaturate.qml
@@ -61,6 +61,8 @@ import QtGraphicalEffects.private 1.0
         \li \image Desaturate_bug.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/DirectionalBlur.qml b/src/effects/DirectionalBlur.qml
index 9da6ae7..9b2d88a 100644
--- a/src/effects/DirectionalBlur.qml
+++ b/src/effects/DirectionalBlur.qml
@@ -66,6 +66,8 @@ import QtGraphicalEffects.private 1.0
         \li \image DirectionalBlur_bug.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/Displace.qml b/src/effects/Displace.qml
index a3b57c5..e16dae4 100644
--- a/src/effects/Displace.qml
+++ b/src/effects/Displace.qml
@@ -61,6 +61,8 @@ import QtGraphicalEffects.private 1.0
         \li \image Displace_bug.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/DropShadow.qml b/src/effects/DropShadow.qml
index e66be6c..941d03c 100644
--- a/src/effects/DropShadow.qml
+++ b/src/effects/DropShadow.qml
@@ -74,6 +74,8 @@ import QtGraphicalEffects.private 1.0
     When the source is static, the \l cached property can be set to allocate
     another buffer to avoid performing the blur every time it is drawn.
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/FastBlur.qml b/src/effects/FastBlur.qml
index a1eaec0..ecb4259 100644
--- a/src/effects/FastBlur.qml
+++ b/src/effects/FastBlur.qml
@@ -66,6 +66,8 @@ import QtGraphicalEffects.private 1.0
         \li \image FastBlur_bug.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+    s
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/GammaAdjust.qml b/src/effects/GammaAdjust.qml
index 59f1dd8..1e45a4e 100644
--- a/src/effects/GammaAdjust.qml
+++ b/src/effects/GammaAdjust.qml
@@ -63,6 +63,8 @@ import QtGraphicalEffects.private 1.0
         \li \image GammaAdjust_bug.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/GaussianBlur.qml b/src/effects/GaussianBlur.qml
index 70943a0..6dc1e1c 100644
--- a/src/effects/GaussianBlur.qml
+++ b/src/effects/GaussianBlur.qml
@@ -65,6 +65,8 @@ import QtGraphicalEffects.private 1.0
         \li \image GaussianBlur_bug.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/Glow.qml b/src/effects/Glow.qml
index 0400921..2bae805 100644
--- a/src/effects/Glow.qml
+++ b/src/effects/Glow.qml
@@ -70,6 +70,8 @@ import QtGraphicalEffects.private 1.0
     even a moderate number of samples will only run at 60 fps on highend
     graphics hardware.
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/HueSaturation.qml b/src/effects/HueSaturation.qml
index 6b5cd5b..3e98576 100644
--- a/src/effects/HueSaturation.qml
+++ b/src/effects/HueSaturation.qml
@@ -63,6 +63,8 @@ import QtGraphicalEffects.private 1.0
         \li \image HueSaturation_bug.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/InnerShadow.qml b/src/effects/InnerShadow.qml
index e5f6294..ac5000c 100644
--- a/src/effects/InnerShadow.qml
+++ b/src/effects/InnerShadow.qml
@@ -66,6 +66,8 @@ import QtGraphicalEffects.private 1.0
         \li \image InnerShadow_butterfly.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/LevelAdjust.qml b/src/effects/LevelAdjust.qml
index a209cab..fda8f97 100644
--- a/src/effects/LevelAdjust.qml
+++ b/src/effects/LevelAdjust.qml
@@ -61,6 +61,8 @@ import QtGraphicalEffects.private 1.0
         \li \image LevelAdjust_butterfly.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/LinearGradient.qml b/src/effects/LinearGradient.qml
index 49adab8..ec50c57 100644
--- a/src/effects/LinearGradient.qml
+++ b/src/effects/LinearGradient.qml
@@ -59,6 +59,8 @@ import QtGraphicalEffects.private 1.0
         \li \image LinearGradient.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/MaskedBlur.qml b/src/effects/MaskedBlur.qml
index 49d1bbf..b20705e 100644
--- a/src/effects/MaskedBlur.qml
+++ b/src/effects/MaskedBlur.qml
@@ -69,6 +69,8 @@ import QtGraphicalEffects.private 1.0
         \li \image MaskedBlur_bug.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/OpacityMask.qml b/src/effects/OpacityMask.qml
index c4c5f7a..da608cb 100644
--- a/src/effects/OpacityMask.qml
+++ b/src/effects/OpacityMask.qml
@@ -60,6 +60,8 @@ import QtGraphicalEffects.private 1.0
         \li \image OpacityMask_bug.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/RadialBlur.qml b/src/effects/RadialBlur.qml
index a2ffd27..ad510f1 100644
--- a/src/effects/RadialBlur.qml
+++ b/src/effects/RadialBlur.qml
@@ -66,6 +66,8 @@ import QtGraphicalEffects.private 1.0
         \li \image RadialBlur_bug.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example Usage
 
     The following example shows how to apply the effect.
diff --git a/src/effects/RadialGradient.qml b/src/effects/RadialGradient.qml
index 06318ab..5e8a5aa 100644
--- a/src/effects/RadialGradient.qml
+++ b/src/effects/RadialGradient.qml
@@ -59,6 +59,8 @@ import QtGraphicalEffects.private 1.0
         \li \image RadialGradient.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/RectangularGlow.qml b/src/effects/RectangularGlow.qml
index 740aff4..cf65134 100644
--- a/src/effects/RectangularGlow.qml
+++ b/src/effects/RectangularGlow.qml
@@ -62,6 +62,8 @@ import QtGraphicalEffects.private 1.0
         \li \image RectangularGlow_applied.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/RecursiveBlur.qml b/src/effects/RecursiveBlur.qml
index 5e537b5..bd4eecb 100644
--- a/src/effects/RecursiveBlur.qml
+++ b/src/effects/RecursiveBlur.qml
@@ -65,6 +65,8 @@ import QtGraphicalEffects.private 1.0
         \li \image RecursiveBlur_bug.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/ThresholdMask.qml b/src/effects/ThresholdMask.qml
index 399e47c..c5635bb 100644
--- a/src/effects/ThresholdMask.qml
+++ b/src/effects/ThresholdMask.qml
@@ -64,6 +64,8 @@ import QtGraphicalEffects.private 1.0
         \li \image ThresholdMask_bug.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/ZoomBlur.qml b/src/effects/ZoomBlur.qml
index 2d08208..8969615 100644
--- a/src/effects/ZoomBlur.qml
+++ b/src/effects/ZoomBlur.qml
@@ -64,6 +64,8 @@ import QtGraphicalEffects.private 1.0
         \li \image ZoomBlur_bug.png
     \endtable
 
+    \note This effect is available when running with OpenGL.
+
     \section1 Example
 
     The following example shows how to apply the effect.
diff --git a/src/effects/doc/src/qtgraphicaleffects.qdoc b/src/effects/doc/src/qtgraphicaleffects.qdoc
index 39c2f54..d69e04e 100644
--- a/src/effects/doc/src/qtgraphicaleffects.qdoc
+++ b/src/effects/doc/src/qtgraphicaleffects.qdoc
@@ -75,6 +75,14 @@ documentation contains property descriptions and basic usage examples.
 
 Currently there is no C++ API.
 
+\note Some effects may not be available with all graphics APIs. OpenGL, which is
+used by default in most cases, has full support for all of them.  However, the
+\c software backend for instance does not support effects at all. Therefore,
+when running with graphics APIs other than OpenGL, refer to the documentation of
+the QML types in question to check if the effect is available. For more
+information on the Qt Quick scene graph backends, see
+\l{qtquick-visualcanvas-adaptations.html}{Scene Graph Adaptations}.
+
 \section1 Reference
 
 \list