aboutsummaryrefslogtreecommitdiffstats
path: root/examples/quick/particles/customparticle/doc/src/customparticle.qdoc
blob: ccef82c9229e765e7b8cb1f143055da8194e147a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
/****************************************************************************
**
** Copyright (C) 2013 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.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Free Documentation License Usage
** 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.  Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \title Qt Quick 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 quick/particles/customparticle/content/blurparticles.qml vertex
    to propagate life time simulation to a custom fragement shader:
    \snippet quick/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 quick/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 quick/particles/customparticle/content/imagecolors.qml vertex
    passes along the starting position for each vertex to the fragment shader,
    \snippet quick/particles/customparticle/content/imagecolors.qml fragment
    which uses it to determine the color for that particle.

*/