summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarko Niemelä <marko.a.niemela@nokia.com>2012-03-16 12:59:52 +0200
committerQt by Nokia <qt-info@nokia.com>2012-03-16 13:35:50 +0100
commitdfc5ac1b8a2b6e6a9a1a19266d4fcb3c3628a7de (patch)
treece1f06fe4a89b6b687e7fe8c1fe539a28d6a5358
parent524c5c95512dd55c21cae5f6676db52b5e331efd (diff)
downloadqtgraphicaleffects-dfc5ac1b8a2b6e6a9a1a19266d4fcb3c3628a7de.tar.gz
Updated documentation module overview.
Change-Id: Icb1b0ced6476c7478eba1f80e09b0d4018d5cb53 Reviewed-by: Kim Gronholm <kim.1.gronholm@nokia.com>
-rw-r--r--doc/src/qtgraphicaleffects.qdoc12
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/src/qtgraphicaleffects.qdoc b/doc/src/qtgraphicaleffects.qdoc
index 2343664..6417f2c 100644
--- a/doc/src/qtgraphicaleffects.qdoc
+++ b/doc/src/qtgraphicaleffects.qdoc
@@ -31,10 +31,18 @@
\brief Qt Graphical Effects module is a Qt Quick Add-On module.
The Qt Graphical Effects module provides a set of QML components for building
-visually impressive user interfaces. Effects are implemented with QML and GLSL.
+visually impressive user interfaces.
+Over twenty ready-made QML graphical effect elements are currently available.
+The effects include code for blending, masking, blurring, coloring, and much more.
+
+The API for each effect is a set of QML properties which can be animated just
+like any other QML properties. The element documentation contains property descriptions
+and basic usage examples. Currently there is no C++ API.
+
+Effects have been implemented with QML and GLSL.
\section1 Getting started
-Install the Qt Graphical Effects module, and simply add the following import statement to your .qml file:
+To load Qt Graphical Effects, add the following import statement to your .qml file:
\snippet snippets/Blend-example.qml import
\section1 Elements