examples/particles/customparticle/customparticle.qml

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the examples of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:BSD$
   9 ** You may use this file under the terms of the BSD license as follows:
  10 **
  11 ** "Redistribution and use in source and binary forms, with or without
  12 ** modification, are permitted provided that the following conditions are
  13 ** met:
  14 **   * Redistributions of source code must retain the above copyright
  15 **     notice, this list of conditions and the following disclaimer.
  16 **   * Redistributions in binary form must reproduce the above copyright
  17 **     notice, this list of conditions and the following disclaimer in
  18 **     the documentation and/or other materials provided with the
  19 **     distribution.
  20 **   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
  21 **     the names of its contributors may be used to endorse or promote
  22 **     products derived from this software without specific prior written
  23 **     permission.
  24 **
  25 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26 ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27 ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28 ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29 ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31 ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32 ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33 ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35 ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
  36 **
  37 ** $QT_END_LICENSE$
  38 **
  39 ****************************************************************************/
  40
  41 import QtQuick 2.0
  42 import "../../shared" as Examples
  43
  44 /*!
  45     \title QtQuick.Particles Examples - CustomParticle
  46     \example particles/customparticle
  47     \brief This is a collection of examples using CustomParticle in the QML particle system.
  48     \image qml-customparticle-example.png
  49
  50     This is a collection of small QML examples relating to using CustomParticle in the particle system.
  51     Each example is a small QML file emphasizing a different way to use CustomParticle.
  52
  53     Blur Particles adds a blur effect to the particles, which increases over the particle's life time.
  54     It uses a custom vertex shader:
  55     \snippet examples/particles/customparticle/content/blurparticles.qml vertex
  56     to propagate life time simulation to a custom fragment shader:
  57     \snippet examples/particles/customparticle/content/blurparticles.qml fragment
  58     which has access to both the normal image sampler and a blurred sampler, the image plus a ShaderEffect.
  59
  60     Fragment Shader just uses the particle system as a vertex delivery system.
  61     \snippet examples/particles/customparticle/content/fragmentshader.qml 0
  62
  63     Image Colors uses CustomParticle to assign colors to particles based on their location in a picture.
  64     The vertex shader,
  65     \snippet examples/particles/customparticle/content/imagecolors.qml vertex
  66     passes along the starting position for each vertex to the fragment shader,
  67     \snippet examples/particles/customparticle/content/imagecolors.qml fragment
  68     which uses it to determine the color for that particle.
  69
  70 */
  71
  72 Item {
  73     height: 480
  74     width: 320
  75     Examples.LauncherList {
  76         id: ll
  77         anchors.fill: parent
  78         Component.onCompleted: {
  79             addExample("Blur Particles", "Particles that get blurred over time",  Qt.resolvedUrl("content/blurparticles.qml"));
  80             addExample("Fragment Shader", "Particles drawn with a custom fragment shader", Qt.resolvedUrl("content/fragmentshader.qml"));
  81             addExample("Image Colors", "An image explodes into colored particles", Qt.resolvedUrl("content/imagecolors.qml"));
  82         }
  83     }
  84 }