aboutsummaryrefslogtreecommitdiffstats
path: root/src/effects/doc/src/overview-graphicaleffects.qdoc
blob: 1011c09aa9f50f4947bb488fb45dcd0f04b5288f (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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Graphical Effects module.
**
** $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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

    /*!
    \page graphicaleffects.html
    \title Graphical Effects
    \brief Effects provided by the Qt Graphical Effects API

    Effects are visual items that can be added to Qt Quick user interface as UI
    components. To import the Qt Graphical Effects types, include the Qt
    Graphical Effects module by adding the following statement to the QML file:

    \qml \QtMinorVersion
    import QtGraphicalEffects 1.\1
    \endqml

    To use the effects, simply add a specific effect declaration to the QML
    scene and configure the effects properties. The source item type can be any
    QML type, even video or another effect. Pipelining multiple effects together
    is a simple way to create even more impressive output.

    The following list presents the functional division of types that are part
    of Qt Graphical Effects:

    \section1 Color
        \annotatedlist qtgraphicaleffects-color

    \section1 Gradient
        \annotatedlist qtgraphicaleffects-gradient

    \section1 Distortion
        \annotatedlist qtgraphicaleffects-distortion

    \section1 Drop Shadow
        \annotatedlist qtgraphicaleffects-drop-shadow

    \section1 Blur
        \annotatedlist qtgraphicaleffects-blur

    \section1 Glow
        \annotatedlist qtgraphicaleffects-glow

    \section1 Mask
        \annotatedlist qtgraphicaleffects-mask
    */