diff options
author | Jerome Pasion <jerome.pasion@digia.com> | 2012-08-08 12:18:55 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2012-09-21 10:25:11 +0200 |
commit | 5c88efc06d152ac675b4369d854699b137631fa0 (patch) | |
tree | 85e833ecd1914c71ae92280aaf44c48a878d0453 /examples/particles/customparticle | |
parent | f66624bf294663a3dd0777692e8ad8dbb19f3819 (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/particles/customparticle')
-rw-r--r-- | examples/particles/customparticle/customparticle.qml | 28 | ||||
-rw-r--r-- | examples/particles/customparticle/doc/src/customparticle.qdoc | 54 |
2 files changed, 54 insertions, 28 deletions
diff --git a/examples/particles/customparticle/customparticle.qml b/examples/particles/customparticle/customparticle.qml index eb4f772e97..694dfb0fc6 100644 --- a/examples/particles/customparticle/customparticle.qml +++ b/examples/particles/customparticle/customparticle.qml @@ -41,34 +41,6 @@ import QtQuick 2.0 import "../../shared" as Examples -/*! - \title QtQuick.Particles Examples - CustomParticle - \example particles/customparticle - \brief This is a collection of examples using CustomParticle in the QML particle system. - \image qml-customparticle-example.png - - This is a collection of small QML examples relating to using CustomParticle in the particle system. - Each example is a small QML file emphasizing a different way to use CustomParticle. - - Blur Particles adds a blur effect to the particles, which increases over the particle's life time. - It uses a custom vertex shader: - \snippet examples/particles/customparticle/content/blurparticles.qml vertex - to propagate life time simulation to a custom fragment shader: - \snippet examples/particles/customparticle/content/blurparticles.qml fragment - which has access to both the normal image sampler and a blurred sampler, the image plus a ShaderEffect. - - Fragment Shader just uses the particle system as a vertex delivery system. - \snippet examples/particles/customparticle/content/fragmentshader.qml 0 - - Image Colors uses CustomParticle to assign colors to particles based on their location in a picture. - The vertex shader, - \snippet examples/particles/customparticle/content/imagecolors.qml vertex - passes along the starting position for each vertex to the fragment shader, - \snippet examples/particles/customparticle/content/imagecolors.qml fragment - which uses it to determine the color for that particle. - -*/ - Item { height: 480 width: 320 diff --git a/examples/particles/customparticle/doc/src/customparticle.qdoc b/examples/particles/customparticle/doc/src/customparticle.qdoc new file mode 100644 index 0000000000..8faaf4b8c7 --- /dev/null +++ b/examples/particles/customparticle/doc/src/customparticle.qdoc @@ -0,0 +1,54 @@ +/**************************************************************************** +** +** 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 QtQuick.Particles Examples - CustomParticle + \example particles/customparticle + \brief This is a collection of examples using CustomParticle in the QML particle system. + \image qml-customparticle-example.png + + This is a collection of small QML examples relating to using CustomParticle in the particle system. + Each example is a small QML file emphasizing a different way to use CustomParticle. + + Blur Particles adds a blur effect to the particles, which increases over the particle's life time. + It uses a custom vertex shader: + \snippet examples/particles/customparticle/content/blurparticles.qml vertex + to propagate life time simulation to a custom fragement shader: + \snippet examples/particles/customparticle/content/blurparticles.qml fragment + which has access to both the normal image sampler and a blurred sampler, the image plus a ShaderEffect. + + Fragment Shader just uses the particle system as a vertex delivery system. + \snippet examples/particles/customparticle/content/fragmentshader.qml 0 + + Image Colors uses CustomParticle to assign colors to particles based on their location in a picture. + The vertex shader, + \snippet examples/particles/customparticle/content/imagecolors.qml vertex + passes along the starting position for each vertex to the fragment shader, + \snippet examples/particles/customparticle/content/imagecolors.qml fragment + which uses it to determine the color for that particle. + +*/ |