aboutsummaryrefslogtreecommitdiffstats
path: root/examples/quick/shadereffects/doc
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2012-08-08 12:18:55 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2012-09-21 10:25:11 +0200
commit5c88efc06d152ac675b4369d854699b137631fa0 (patch)
tree85e833ecd1914c71ae92280aaf44c48a878d0453 /examples/quick/shadereffects/doc
parentf66624bf294663a3dd0777692e8ad8dbb19f3819 (diff)
Examples: Moved example documentation.
-inline \example pages into separate .qdoc files -fixed broken links to paths -moved ui-components under examples/quick Change-Id: I6e009b9213be3e1f4bed51bdbeb76a7a2142c80b Reviewed-by: Martin Smith <martin.smith@digia.com>
Diffstat (limited to 'examples/quick/shadereffects/doc')
-rw-r--r--examples/quick/shadereffects/doc/src/shadereffects.qdoc51
1 files changed, 51 insertions, 0 deletions
diff --git a/examples/quick/shadereffects/doc/src/shadereffects.qdoc b/examples/quick/shadereffects/doc/src/shadereffects.qdoc
new file mode 100644
index 0000000000..75199daffe
--- /dev/null
+++ b/examples/quick/shadereffects/doc/src/shadereffects.qdoc
@@ -0,0 +1,51 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+/*!
+ \title QML Examples - Shader Effects
+ \example quick/shadereffects
+ \image qml-shadereffects-example.png
+ \brief This is a shader effects example
+
+ This example demonstrates a couple of visual effects that you can perform
+ with shaders in QtQuick 2.0
+
+ ShaderEffects typically operate on other elements, using a ShaderEffectSource
+ \snippet examples/quick/shadereffects/shadereffects.qml source
+ In the above snippet, theItem is the id of a complex QML element in the file.
+
+ ShaderEffects can use this ShaderEffectSource as a texture in their fragment shader.
+ \snippet examples/quick/shadereffects/shadereffects.qml fragment
+
+ You can use any custom property on the ShaderEffect in your shader. This makes
+ animated shader code very easy.
+ \snippet examples/quick/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.
+ \snippet examples/quick/shadereffects/shadereffects.qml vertex
+*/
+