summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTony Leinonen <tony.leinonen@qt.io>2020-10-01 14:45:00 +0300
committerTony Leinonen <tony.leinonen@qt.io>2020-10-06 09:06:42 +0300
commitb123b5ebb065b23f6922d60864b403d2aeede172 (patch)
treed1e6786c702cfe132999f7abd0bbefdeaa8162e3
parentd36a73334e7a84b2a7e33672955954d95a75a104 (diff)
Add more documentation for layer effects
Added brush strokes, corona, dof bokeh, frame flipper, screenspace ao, sepia, stylize scatter, smaa1x and vignette. Task-number: QT3DS-3938 Change-Id: I8ef640e3f6cf81852ab14d2bde2d0589dfd58337 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
-rw-r--r--doc/src/10-best-practices/80-effects.qdoc53
-rw-r--r--doc/src/10-best-practices/brush-strokes.qdoc65
-rw-r--r--doc/src/10-best-practices/corona.qdoc106
-rw-r--r--doc/src/10-best-practices/emboss-effect.qdoc51
-rw-r--r--doc/src/10-best-practices/frame-flipper.qdoc60
-rw-r--r--doc/src/10-best-practices/fullscreen-texture-overlay.qdoc57
-rw-r--r--doc/src/10-best-practices/screen-space-ao.qdoc96
-rw-r--r--doc/src/10-best-practices/sepia.qdoc51
-rw-r--r--doc/src/10-best-practices/smaa1x.qdoc41
-rw-r--r--doc/src/10-best-practices/stylize-scatter.qdoc66
-rw-r--r--doc/src/10-best-practices/vignette.qdoc56
-rw-r--r--doc/src/images/brush-strokes-icon.pngbin0 -> 8695 bytes
-rw-r--r--doc/src/images/corona-icon.pngbin0 -> 11732 bytes
-rw-r--r--doc/src/images/effects-brush-strokes.pngbin0 -> 54544 bytes
-rw-r--r--doc/src/images/effects-corona.pngbin0 -> 51977 bytes
-rw-r--r--doc/src/images/effects-emboss.pngbin0 -> 61625 bytes
-rw-r--r--doc/src/images/effects-frame-flipper.pngbin0 -> 107745 bytes
-rw-r--r--doc/src/images/effects-fullscreen-texture-overlay.pngbin0 -> 57512 bytes
-rw-r--r--doc/src/images/effects-screen-space-ao.pngbin0 -> 80226 bytes
-rw-r--r--doc/src/images/effects-sepia.pngbin0 -> 46435 bytes
-rw-r--r--doc/src/images/effects-smaa1x.pngbin0 -> 39146 bytes
-rw-r--r--doc/src/images/effects-stylize-scatter.pngbin0 -> 52224 bytes
-rw-r--r--doc/src/images/effects-vignette.pngbin0 -> 59815 bytes
-rw-r--r--doc/src/images/emboss-icon.pngbin0 -> 8506 bytes
-rw-r--r--doc/src/images/frame-flipper-icon.pngbin0 -> 6009 bytes
-rw-r--r--doc/src/images/fullscreen-texture-overlay-icon.pngbin0 -> 12349 bytes
-rw-r--r--doc/src/images/screen-space-ao-icon.pngbin0 -> 11068 bytes
-rw-r--r--doc/src/images/sepia-icon.pngbin0 -> 7583 bytes
-rw-r--r--doc/src/images/smaa1x-icon.pngbin0 -> 10458 bytes
-rw-r--r--doc/src/images/stylize-scatter-icon.pngbin0 -> 10801 bytes
-rw-r--r--doc/src/images/vignette-icon.pngbin0 -> 11702 bytes
31 files changed, 702 insertions, 0 deletions
diff --git a/doc/src/10-best-practices/80-effects.qdoc b/doc/src/10-best-practices/80-effects.qdoc
index 17316b35..74ad47e1 100644
--- a/doc/src/10-best-practices/80-effects.qdoc
+++ b/doc/src/10-best-practices/80-effects.qdoc
@@ -149,6 +149,59 @@ lower in the scene graph will be applied before effects that are above them.
\image tiltshift-icon.png
\b{\l{Tilt shift}}
\enddiv
+\row
+ \li
+ \div {align="center"}
+ \image brush-strokes-icon.png
+ \b {\l{Brush Strokes}}
+ \enddiv
+ \li
+ \div {align="center"}
+ \image sepia-icon.png
+ \b {\l{Sepia}}
+ \enddiv
+ \li
+ \div {align="center"}
+ \image stylize-scatter-icon.png
+ \b {\l{Stylize Scatter}}
+ \enddiv
+ \li
+ \div {align="center"}
+ \image emboss-icon.png
+ \b {\l{Emboss}}
+ \enddiv
+\row
+ \li
+ \div {align="center"}
+ \image fullscreen-texture-overlay-icon.png
+ \b {\l{Fullscreen Texture Overlay}}
+ \enddiv
+ \li
+ \div {align="center"}
+ \image corona-icon.png
+ \b {\l{Corona}}
+ \enddiv
+ \li
+ \div {align="center"}
+ \image vignette-icon.png
+ \b {\l{Vignette}}
+ \enddiv
+ \li
+ \div {align="center"}
+ \image frame-flipper-icon.png
+ \b {\l{Frame Flipper}}
+ \enddiv
+\row
+ \li
+ \div {align="center"}
+ \image screen-space-ao-icon.png
+ \b {\l{Screen Space AO}}
+ \enddiv
+ \li
+ \div {align="center"}
+ \image smaa1x-icon.png
+ \b {\l{SMAA1X}}
+ \enddiv
\endtable
\enddiv
diff --git a/doc/src/10-best-practices/brush-strokes.qdoc b/doc/src/10-best-practices/brush-strokes.qdoc
new file mode 100644
index 00000000..dfb4cc56
--- /dev/null
+++ b/doc/src/10-best-practices/brush-strokes.qdoc
@@ -0,0 +1,65 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt 3D Studio.
+**
+** $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$
+**
+****************************************************************************/
+
+/*!
+
+\title Brush Strokes
+\page brush-strokes.html
+\ingroup qt3dstudio-best-practices
+
+The brush strokes effect will apply a painted look for your layer.
+\image effects-brush-strokes.png
+
+\section1 Properties
+
+\table
+ \header
+ \li Property
+ \li Description
+ \row
+ \li
+ Noise
+ \li
+ Texture to be used as the brush.
+ \row
+ \li
+ Brush Angle
+ \li
+ Rotation of the brush texture.
+ \row
+ \li
+ Stroke Length
+ \li
+ Length of the brush texture.
+ \row
+ \li
+ Stroke Size
+ \li
+ Overall scale of the brush.
+\endtable
+
+*/
diff --git a/doc/src/10-best-practices/corona.qdoc b/doc/src/10-best-practices/corona.qdoc
new file mode 100644
index 00000000..19a554d1
--- /dev/null
+++ b/doc/src/10-best-practices/corona.qdoc
@@ -0,0 +1,106 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt 3D Studio.
+**
+** $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$
+**
+****************************************************************************/
+
+/*!
+
+\title Corona
+\page corona.html
+\ingroup qt3dstudio-best-practices
+
+The corona effect creates colored rings around an object.
+
+\image effects-corona.png
+
+\section1 Properties
+
+\table
+ \header
+ \li Property
+ \li Description
+ \row
+ \li
+ Horizontal Blur
+ \li
+ Horizontal amount of corona glow.
+ \row
+ \li
+ Vertical Blur
+ \li
+ Vertical amount of corona glow.
+ \row
+ \li
+ Fade Amount
+ \li
+ How quickly the effect fades away. 0 means there is no glow, and 1 means the glow is permanent.
+ \row
+ \li
+ Glow Clor
+ \li
+ The color of the glow.
+ \row
+ \li
+ Noise
+ \li
+ Texture to be used for the glow noise.
+ \row
+ \li
+ Noise Density
+ \li
+ Scale of the noise texture.
+ \row
+ \li
+ Noise Brightness
+ \li
+ Brightness of the noise texture.
+ \row
+ \li
+ Noise Amount
+ \li
+ Scale of the noise texture.
+ \row
+ \li
+ Crawl Length
+ \li
+ Length of the trail for the glow animation.
+ \row
+ \li
+ Crawl Angle
+ \li
+ Angle of the glow trail.
+\endtable
+
+*/
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/src/10-best-practices/emboss-effect.qdoc b/doc/src/10-best-practices/emboss-effect.qdoc
new file mode 100644
index 00000000..b2a7209c
--- /dev/null
+++ b/doc/src/10-best-practices/emboss-effect.qdoc
@@ -0,0 +1,51 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt 3D Studio.
+**
+** $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$
+**
+****************************************************************************/
+
+/*!
+
+\title Emboss
+\page emboss-effect.html
+\ingroup qt3dstudio-best-practices
+
+The emboss effect creates an 3D embossed look for your layer.
+
+\image effects-emboss.png
+
+\section1 Properties
+
+\table
+ \header
+ \li Property
+ \li Description
+ \row
+ \li
+ Amount
+ \li
+ Controls the depth of the emboss.
+\endtable
+
+*/
diff --git a/doc/src/10-best-practices/frame-flipper.qdoc b/doc/src/10-best-practices/frame-flipper.qdoc
new file mode 100644
index 00000000..d56a54c8
--- /dev/null
+++ b/doc/src/10-best-practices/frame-flipper.qdoc
@@ -0,0 +1,60 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt 3D Studio.
+**
+** $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$
+**
+****************************************************************************/
+
+/*!
+
+\title Frame Flipper
+\page frame-flipper-effect.html
+\ingroup qt3dstudio-best-practices
+
+The frame flipper effect gives you the ability to flip the layer horizontally and vertically.
+
+In the image below, the left picture is vertically flipped and the right picture is
+horizontally flipped.
+
+\image effects-frame-flipper.png
+
+\section1 Properties
+
+\table
+ \header
+ \li Property
+ \li Description
+ \row
+ \li
+ Flip Horizontally
+ \li
+ Flips the image upside down.
+ \row
+ \li
+ Flip Vertically
+ \li
+ Flips the image sideways.
+\endtable
+
+
+*/
diff --git a/doc/src/10-best-practices/fullscreen-texture-overlay.qdoc b/doc/src/10-best-practices/fullscreen-texture-overlay.qdoc
new file mode 100644
index 00000000..f7ae9b7d
--- /dev/null
+++ b/doc/src/10-best-practices/fullscreen-texture-overlay.qdoc
@@ -0,0 +1,57 @@
+/****************************************************************************
+**
+** Copyright (C) 2029 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt 3D Studio.
+**
+** $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$
+**
+****************************************************************************/
+
+/*!
+
+\title Fullscreen Texture Overlay
+\page fullscreen-texture-overlay.html
+\ingroup qt3dstudio-best-practices
+
+With fullscreen texture overlay effect you can take any image and use it as
+texture overlay.
+
+\image effects-fullscreen-texture-overlay.png
+
+\section1 Properties
+
+\table
+ \header
+ \li Property
+ \li Description
+ \row
+ \li
+ Overlay Texture
+ \li
+ Texture to use on the overlay.
+ \row
+ \li
+ Repeat
+ \li
+ How many times the texture is repeated vertically and horizontally.
+\endtable
+
+*/
diff --git a/doc/src/10-best-practices/screen-space-ao.qdoc b/doc/src/10-best-practices/screen-space-ao.qdoc
new file mode 100644
index 00000000..fbfee194
--- /dev/null
+++ b/doc/src/10-best-practices/screen-space-ao.qdoc
@@ -0,0 +1,96 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt 3D Studio.
+**
+** $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$
+**
+****************************************************************************/
+
+/*!
+
+\title Screen Space AO
+\page screen-space-ao-effect.html
+\ingroup qt3dstudio-best-practices
+
+Screen space ambient occlusion efficiently approximates the ambient occlusion of you layer
+in real time. It is independent from the layers complexity and works with dynamic scenes.
+
+\image effects-screen-space-ao.png
+
+\table
+ \header
+ \li
+ Pros
+ \li
+ Cons
+ \row
+ \li
+ \list
+ \li
+ Independent from scene complexity.
+ \li
+ No data pre-processing needed.
+ \li
+ Works with dynamic scenes.
+ \li
+ Works in the same consistent way for every pixel on the screen.
+ \li
+ No CPU usage.
+ \endlist
+ \li
+ \list
+ \li
+ Rather local and in many cases view-dependent, as it is dependent on
+ adjacent texel depths which may be generated by any geometry whatsoever.
+ \li
+ Hard to correctly smooth/blur out the noise without bleeding onto objects.
+ \endlist
+\endtable
+
+\table
+ \header
+ \li Property
+ \li Description
+ \row
+ \li
+ Filter Size
+ \li
+ Controls the shadows size.
+ \row
+ \li
+ Distance Scale
+ \li
+ How strong the shadows are.
+ \row
+ \li
+ Distance Bias
+ \li
+ Controls distance offset.
+\endtable
+
+
+\section1 Usage
+
+The layer which the effect is applied to requires depth prepass for the effect to work.
+Make sure in your layer's advanced options "disable depth prepass" is unchecked.
+
+*/
diff --git a/doc/src/10-best-practices/sepia.qdoc b/doc/src/10-best-practices/sepia.qdoc
new file mode 100644
index 00000000..c8633f31
--- /dev/null
+++ b/doc/src/10-best-practices/sepia.qdoc
@@ -0,0 +1,51 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt 3D Studio.
+**
+** $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$
+**
+****************************************************************************/
+
+/*!
+
+\title Sepia
+\page sepia.html
+\ingroup qt3dstudio-best-practices
+
+Sepia effect will give your layer a warm color tint.
+
+\image effects-sepia.png
+
+\section1 Properties
+
+\table
+ \header
+ \li Property
+ \li Description
+ \row
+ \li
+ Amount
+ \li
+ Controls how strong the tint is.
+\endtable
+
+*/
diff --git a/doc/src/10-best-practices/smaa1x.qdoc b/doc/src/10-best-practices/smaa1x.qdoc
new file mode 100644
index 00000000..94fb5958
--- /dev/null
+++ b/doc/src/10-best-practices/smaa1x.qdoc
@@ -0,0 +1,41 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt 3D Studio.
+**
+** $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$
+**
+****************************************************************************/
+
+/*!
+
+\title SMAA1X
+\page smaa.html
+\ingroup qt3dstudio-best-practices
+
+Subpixel Morphological Antialiasing is a very efficient GPU-based MLAA implementation,
+capable of handling subpixel features seamlessly, and featuring an improved
+and advanced pattern detection & handling mechanism.
+
+\image Effects-smaa1x.png
+
+
+*/
diff --git a/doc/src/10-best-practices/stylize-scatter.qdoc b/doc/src/10-best-practices/stylize-scatter.qdoc
new file mode 100644
index 00000000..fb212c66
--- /dev/null
+++ b/doc/src/10-best-practices/stylize-scatter.qdoc
@@ -0,0 +1,66 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt 3D Studio.
+**
+** $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$
+**
+****************************************************************************/
+
+/*!
+
+\title Stylize Scatter
+\page stylize-scatter-effect.html
+\ingroup qt3dstudio-best-practices
+
+The scatter effect scatters the layers pixels around their original
+positions, giving it a smeared look.
+
+\image effects-stylize-scatter.png
+
+\section1 Properties
+
+\table
+ \header
+ \li Property
+ \li Description
+ \row
+ \li
+ Scatter Amount
+ \li
+ Controls the scatter amount and displacement area size.
+ \row
+ \li
+ Grain
+ \li
+ Controls the direction where the pixels are displaced.
+ \row
+ \li
+ Randomize Every Frame
+ \li
+ If set to true, the displacement is calculated again for every frame.
+\endtable
+
+\section1 Usage
+
+
+
+*/
diff --git a/doc/src/10-best-practices/vignette.qdoc b/doc/src/10-best-practices/vignette.qdoc
new file mode 100644
index 00000000..1b3aaf4b
--- /dev/null
+++ b/doc/src/10-best-practices/vignette.qdoc
@@ -0,0 +1,56 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt 3D Studio.
+**
+** $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$
+**
+****************************************************************************/
+
+/*!
+
+\title Vignette
+\page vignette-effect.html
+\ingroup qt3dstudio-best-practices
+
+The vignette effect darkens the corners of your layer.
+
+\image effects-vignette.png
+
+\section1 Properties
+
+\table
+ \header
+ \li Property
+ \li Description
+ \row
+ \li
+ Strength
+ \li
+ Changes the opacity of the vignette.
+ \row
+ \li
+ Radius
+ \li
+ Adjust the size of the vignette
+\endtable
+
+*/
diff --git a/doc/src/images/brush-strokes-icon.png b/doc/src/images/brush-strokes-icon.png
new file mode 100644
index 00000000..4a3b7194
--- /dev/null
+++ b/doc/src/images/brush-strokes-icon.png
Binary files differ
diff --git a/doc/src/images/corona-icon.png b/doc/src/images/corona-icon.png
new file mode 100644
index 00000000..31cbfa68
--- /dev/null
+++ b/doc/src/images/corona-icon.png
Binary files differ
diff --git a/doc/src/images/effects-brush-strokes.png b/doc/src/images/effects-brush-strokes.png
new file mode 100644
index 00000000..9d9b7c46
--- /dev/null
+++ b/doc/src/images/effects-brush-strokes.png
Binary files differ
diff --git a/doc/src/images/effects-corona.png b/doc/src/images/effects-corona.png
new file mode 100644
index 00000000..3e40ec53
--- /dev/null
+++ b/doc/src/images/effects-corona.png
Binary files differ
diff --git a/doc/src/images/effects-emboss.png b/doc/src/images/effects-emboss.png
new file mode 100644
index 00000000..2014f3bc
--- /dev/null
+++ b/doc/src/images/effects-emboss.png
Binary files differ
diff --git a/doc/src/images/effects-frame-flipper.png b/doc/src/images/effects-frame-flipper.png
new file mode 100644
index 00000000..1c7a37e2
--- /dev/null
+++ b/doc/src/images/effects-frame-flipper.png
Binary files differ
diff --git a/doc/src/images/effects-fullscreen-texture-overlay.png b/doc/src/images/effects-fullscreen-texture-overlay.png
new file mode 100644
index 00000000..af15778e
--- /dev/null
+++ b/doc/src/images/effects-fullscreen-texture-overlay.png
Binary files differ
diff --git a/doc/src/images/effects-screen-space-ao.png b/doc/src/images/effects-screen-space-ao.png
new file mode 100644
index 00000000..7062d04f
--- /dev/null
+++ b/doc/src/images/effects-screen-space-ao.png
Binary files differ
diff --git a/doc/src/images/effects-sepia.png b/doc/src/images/effects-sepia.png
new file mode 100644
index 00000000..1d46583f
--- /dev/null
+++ b/doc/src/images/effects-sepia.png
Binary files differ
diff --git a/doc/src/images/effects-smaa1x.png b/doc/src/images/effects-smaa1x.png
new file mode 100644
index 00000000..6ce6ab91
--- /dev/null
+++ b/doc/src/images/effects-smaa1x.png
Binary files differ
diff --git a/doc/src/images/effects-stylize-scatter.png b/doc/src/images/effects-stylize-scatter.png
new file mode 100644
index 00000000..e249f49d
--- /dev/null
+++ b/doc/src/images/effects-stylize-scatter.png
Binary files differ
diff --git a/doc/src/images/effects-vignette.png b/doc/src/images/effects-vignette.png
new file mode 100644
index 00000000..f3e0d27c
--- /dev/null
+++ b/doc/src/images/effects-vignette.png
Binary files differ
diff --git a/doc/src/images/emboss-icon.png b/doc/src/images/emboss-icon.png
new file mode 100644
index 00000000..c59098d5
--- /dev/null
+++ b/doc/src/images/emboss-icon.png
Binary files differ
diff --git a/doc/src/images/frame-flipper-icon.png b/doc/src/images/frame-flipper-icon.png
new file mode 100644
index 00000000..2c34e609
--- /dev/null
+++ b/doc/src/images/frame-flipper-icon.png
Binary files differ
diff --git a/doc/src/images/fullscreen-texture-overlay-icon.png b/doc/src/images/fullscreen-texture-overlay-icon.png
new file mode 100644
index 00000000..9fbda5c7
--- /dev/null
+++ b/doc/src/images/fullscreen-texture-overlay-icon.png
Binary files differ
diff --git a/doc/src/images/screen-space-ao-icon.png b/doc/src/images/screen-space-ao-icon.png
new file mode 100644
index 00000000..ad9c0468
--- /dev/null
+++ b/doc/src/images/screen-space-ao-icon.png
Binary files differ
diff --git a/doc/src/images/sepia-icon.png b/doc/src/images/sepia-icon.png
new file mode 100644
index 00000000..d248ee2e
--- /dev/null
+++ b/doc/src/images/sepia-icon.png
Binary files differ
diff --git a/doc/src/images/smaa1x-icon.png b/doc/src/images/smaa1x-icon.png
new file mode 100644
index 00000000..c6a989fc
--- /dev/null
+++ b/doc/src/images/smaa1x-icon.png
Binary files differ
diff --git a/doc/src/images/stylize-scatter-icon.png b/doc/src/images/stylize-scatter-icon.png
new file mode 100644
index 00000000..b9747566
--- /dev/null
+++ b/doc/src/images/stylize-scatter-icon.png
Binary files differ
diff --git a/doc/src/images/vignette-icon.png b/doc/src/images/vignette-icon.png
new file mode 100644
index 00000000..bc130d01
--- /dev/null
+++ b/doc/src/images/vignette-icon.png
Binary files differ