aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/qtgraphicaleffects.qdoc
blob: 139085032c80f1132fa6459cc60c3b0be9a6e74d (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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/****************************************************************************
**
** 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 Graphical Effects module.
**
** $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 Qt Graphical Effects
\page qml-graphicaleffects-index.html
\brief Qt Graphical Effects module is a Qt Quick Add-On module.

The Qt Graphical Effects module provides a set of QML components for building
visually impressive user interfaces.
Over twenty ready-made QML graphical effect elements are currently available.
The effects include code for blending, masking, blurring, coloring, and much more.

The API for each effect is a set of QML properties which can be animated just
like any other QML properties. The element documentation contains property descriptions
and basic usage examples. Currently there is no C++ API.

Effects have been implemented with QML and GLSL.

\section1 Getting started
To load Qt Graphical Effects, add the following import statement to your .qml file:
\snippet snippets/Blend-example.qml import

\section1 Elements

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

Blend
\list
\li \l {QtGraphicalEffects1.0::Blend}{Blend} - merges two source items by using a blend mode
\endlist

Color
\list
\li \l {QtGraphicalEffects1.0::BrightnessContrast}{BrightnessContrast} - adjusts brightness and contrast
\li \l {QtGraphicalEffects1.0::Colorize}{Colorize} - sets color in the HSL color space
\li \l {QtGraphicalEffects1.0::ColorOverlay}{ColorOverlay} - applies a color layer
\li \l {QtGraphicalEffects1.0::Desaturate}{Desaturate} - reduces color saturation
\li \l {QtGraphicalEffects1.0::GammaAdjust}{GammaAdjust} - adjusts luminance
\li \l {QtGraphicalEffects1.0::HueSaturation}{HueSaturation} - adjusts colors in the HSL color space
\li \l {QtGraphicalEffects1.0::LevelAdjust}{LevelAdjust} - adjusts colors in the RGB color space
\endlist

Gradient
\list
\li \l {QtGraphicalEffects1.0::ConicalGradient}{ConicalGradient} - draws a conical gradient
\li \l {QtGraphicalEffects1.0::LinearGradient}{LinearGradient} - draws a linear gradient
\li \l {QtGraphicalEffects1.0::RadialGradient}{RadialGradient} - draws a radial gradient
\endlist

Distortion
\list
\li \l {QtGraphicalEffects1.0::Displace}{Displace} - moves the pixels of the source item according to the specified displacement source
\endlist

Drop Shadow
\list
\li \l {QtGraphicalEffects1.0::DropShadow}{DropShadow} - draws a drop shadow
\li \l {QtGraphicalEffects1.0::InnerShadow}{InnerShadow} - draws an inner shadow
\endlist

Blur
\list
\li \l {QtGraphicalEffects1.0::FastBlur}{FastBlur} - applies a fast blur effect
\li \l {QtGraphicalEffects1.0::GaussianBlur}{GaussianBlur} - applies a higher quality blur effect
\li \l {QtGraphicalEffects1.0::MaskedBlur}{MaskedBlur} - applies a varying intensity blur effect
\li \l {QtGraphicalEffects1.0::RecursiveBlur}{RecursiveBlur} - blurs repeatedly, providing a strong blur effect
\endlist

Motion Blur
\list
\li \l {QtGraphicalEffects1.0::DirectionalBlur}{DirectionalBlur} - applies a directional motion blur effect
\li \l {QtGraphicalEffects1.0::RadialBlur}{RadialBlur} - applies a radial motion blur effect
\li \l {QtGraphicalEffects1.0::ZoomBlur}{ZoomBlur} - applies a zoom motion blur effect
\endlist

Glow
\list
\li \l {QtGraphicalEffects1.0::Glow}{Glow} - draws an outer glow effect
\li \l {QtGraphicalEffects1.0::RectangularGlow}{RectangularGlow} - draws a rectangular outer glow effect
\endlist

Mask
\list
\li \l {QtGraphicalEffects1.0::OpacityMask}{OpacityMask} - masks the source item with another item
\li \l {QtGraphicalEffects1.0::ThresholdMask}{ThresholdMask} - masks the source item with another item and applies a threshold value
\endlist

*/