aboutsummaryrefslogtreecommitdiffstats
path: root/examples/quick/shadereffects/doc/src/shadereffects.qdoc
blob: 3d5f42eacc34feb319ecfe9c51521546be5dd4a9 (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
/****************************************************************************
**
** 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 Examples - Shader Effects
    \example shadereffects
    \image qml-shadereffects-example.png
    \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}.

    ShaderEffects typically operate on other types, using a 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.
    \snippet shadereffects/shadereffects.qml fragment

    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.
    \snippet shadereffects/shadereffects.qml vertex
*/