aboutsummaryrefslogtreecommitdiffstats
path: root/examples/quick/shadereffects
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2014-05-28 16:19:08 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-06-05 12:02:01 +0200
commit5f99a6388abf87c34e052f3d7e266c48852a52dd (patch)
treeb88dc0b9dc36c477d6716edf932eb328d413ad68 /examples/quick/shadereffects
parentc9553ad7d8041c7b0fd769dc8cd0f5335d9408a3 (diff)
Doc: Updated "Qt Quick Examples" pages.
-added instructions about running the example (using \include) -used the example names as sections in the collection pages -general editing and documentation polishing -updated copyright information Change-Id: I044f29fcc1921a541040505d5821acb06dc4cb35 Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'examples/quick/shadereffects')
-rw-r--r--examples/quick/shadereffects/doc/src/shadereffects.qdoc30
1 files changed, 20 insertions, 10 deletions
diff --git a/examples/quick/shadereffects/doc/src/shadereffects.qdoc b/examples/quick/shadereffects/doc/src/shadereffects.qdoc
index 3d5f42eacc..448ee9f3e3 100644
--- a/examples/quick/shadereffects/doc/src/shadereffects.qdoc
+++ b/examples/quick/shadereffects/doc/src/shadereffects.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Toolkit.
@@ -28,24 +28,34 @@
\title Qt Quick Examples - Shader Effects
\example shadereffects
\image qml-shadereffects-example.png
- \brief This is a shader effects example
+ \brief This is a shader effects example.
\ingroup qtquickexamples
This example demonstrates a couple of visual effects that you can perform
- with shaders in \l {Qt Quick}.
+ with shaders in Qt Quick. For more information, visit
+ \l{Important Concepts In Qt Quick - Graphical Effects}
- ShaderEffects typically operate on other types, using a ShaderEffectSource
+ \include examples-run.qdocinc
+
+ \section1 Using ShaderEffect
+
+ The \l ShaderEffect type typically operates on other types, using a
+ \l ShaderEffectSource:
\snippet shadereffects/shadereffects.qml source
- In the above snippet, theItem is the id of a complex QML object in the file.
- ShaderEffects can use this ShaderEffectSource as a texture in their fragment shader.
+ In the above snippet, \c theItem is the ID of a complex QML object in the
+ file.
+
+ ShaderEffects can use this ShaderEffectSource as a texture in their fragment
+ shader:
\snippet shadereffects/shadereffects.qml fragment
- You can use any custom property on the ShaderEffect in your shader. This makes
- animated shader code very easy.
+ You can use any custom property on the ShaderEffect in your shader. This
+ makes animated shader code very easy:
\snippet shadereffects/shadereffects.qml properties
- ShaderEffects can also have a custom vertext shader. Setting the mesh property on ShaderEffect
- provides more vertices for you to manipulate, enabling many effects.
+ ShaderEffects can also have a custom vertext shader. Setting the mesh
+ property on ShaderEffect provides more vertices for you to manipulate,
+ enabling more effects.
\snippet shadereffects/shadereffects.qml vertex
*/