summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMats Honkamaa <mats.honkamaa@qt.io>2019-09-11 10:34:19 +0300
committerMats Honkamaa <mats.honkamaa@qt.io>2019-09-11 12:36:39 +0300
commit6b8a283b5880b3242050e1925cca327354b91dc3 (patch)
treed546237dfd0456c04004858450fa06f1a9812599
parentecec1fae6e371ac78ba9315406446b3af21588d7 (diff)
Add documentation for blur, bloom, and color master effects
Task-number: QT3DS-3938 Change-Id: Iaf754de6727425b3f3a3f9c7d5a340cf20818099 Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
-rw-r--r--doc/src/10-best-practices/80-effects.qdoc20
-rw-r--r--doc/src/bloom.qdoc56
-rw-r--r--doc/src/blur.qdoc55
-rw-r--r--doc/src/color-master.qdoc68
-rw-r--r--doc/src/images/bloom-icon.pngbin0 -> 28441 bytes
-rw-r--r--doc/src/images/blur-icon.pngbin0 -> 6418 bytes
-rw-r--r--doc/src/images/color-master-icon.pngbin0 -> 12118 bytes
-rw-r--r--doc/src/images/effects-bloom.pngbin0 -> 148440 bytes
-rw-r--r--doc/src/images/effects-blur.pngbin0 -> 21347 bytes
-rw-r--r--doc/src/images/effects-color-master.pngbin0 -> 42781 bytes
10 files changed, 198 insertions, 1 deletions
diff --git a/doc/src/10-best-practices/80-effects.qdoc b/doc/src/10-best-practices/80-effects.qdoc
index 66706f42..9b564ed7 100644
--- a/doc/src/10-best-practices/80-effects.qdoc
+++ b/doc/src/10-best-practices/80-effects.qdoc
@@ -73,25 +73,43 @@ lower in the scene graph will be applied before effects that are above them.
\enddiv
\li
\div {align="center"}
+ \image bloom-icon.png
+ \b {\l{Bloom}}
+ \enddiv
+ \li
+ \div {align="center"}
+ \image blur-icon.png
+ \b {\l{Blur}}
+ \enddiv
+ \li
+ \div {align="center"}
+ \image color-master-icon.png
+ \b {\l{Color Master}}
+ \enddiv
+\row
+ \li
+ \div {align="center"}
\image depth-of-field-icon.png
\b {\l{Depth of field HQ blur}}
\enddiv
+
\li
\div {align="center"}
\image fxaa-icon.png
\b {\l{FXAA}}
\enddiv
+
\li
\div {align="center"}
\image gaussian-blur-icon.png
\b {\l{Gaussian blur}}
\enddiv
-\row
\li
\div {align="center"}
\image hdr-bloom-tonemap-icon.png
\b {\l{HDR bloom tonemap}}
\enddiv
+\row
\li
\div {align="center"}
\image motion-blur-icon.png
diff --git a/doc/src/bloom.qdoc b/doc/src/bloom.qdoc
new file mode 100644
index 00000000..ee17022a
--- /dev/null
+++ b/doc/src/bloom.qdoc
@@ -0,0 +1,56 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 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 Bloom
+\page bloom.html
+\ingroup qt3dstudio-best-practices
+
+The bloom effect gives bright areas in the scene a glow effect and light bleeding to add
+realism to the scene. Shortly described, all parts of the scene lighter than the
+\uicontrol {Threshold of the lumino} value are extracted from the scene. Next, they are blurred,
+brightened, and finally applied on top of the scene.
+
+In the image below, the effect is applied in the right picture.
+
+\image effects-bloom.png
+
+\section1 Properties
+
+\table
+ \header
+ \li Property
+ \li Description
+ \row
+ \li
+ Threshold of the lumino
+ \li
+ Objects brighter than this will be part of the filter.
+\endtable
+
+*/
diff --git a/doc/src/blur.qdoc b/doc/src/blur.qdoc
new file mode 100644
index 00000000..c6671d67
--- /dev/null
+++ b/doc/src/blur.qdoc
@@ -0,0 +1,55 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 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 Blur
+\page blur.html
+\ingroup qt3dstudio-best-practices
+
+This is a simple blur effect which basically makes several copies of the layer, adds increased
+transparency and offsets the positions of the copies. This creates a blur effect.
+
+\image effects-blur.png
+
+\section1 Properties
+
+\table
+ \header
+ \li Property
+ \li Description
+ \row
+ \li
+ Blur amount
+ \li
+ Controls the distance of separated images.
+\endtable
+
+\section1 Usage
+
+The \uicontrol{Blur amount} controls the distance between the images created by the blur effect.
+*/
diff --git a/doc/src/color-master.qdoc b/doc/src/color-master.qdoc
new file mode 100644
index 00000000..c6397abf
--- /dev/null
+++ b/doc/src/color-master.qdoc
@@ -0,0 +1,68 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 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 Color Master
+\page color-master.html
+\ingroup qt3dstudio-best-practices
+
+This effect allows you to control the RGB color levels and saturation of the scene.
+
+In the image below, the effect is applied in the right picture.
+
+\image effects-color-master.png
+
+\section1 Properties
+
+\table
+ \header
+ \li Property
+ \li Description
+ \row
+ \li
+ Red amount
+ \li
+ Controls the amount of red.
+ \row
+ \li
+ Green amount
+ \li
+ Controls the amount of green.
+ \row
+ \li
+ Blue amount
+ \li
+ Controls the amount of blue.
+ \row
+ \li
+ Saturation
+ \li
+ Controls the intensity of the colors.
+\endtable
+
+*/
diff --git a/doc/src/images/bloom-icon.png b/doc/src/images/bloom-icon.png
new file mode 100644
index 00000000..c46a905d
--- /dev/null
+++ b/doc/src/images/bloom-icon.png
Binary files differ
diff --git a/doc/src/images/blur-icon.png b/doc/src/images/blur-icon.png
new file mode 100644
index 00000000..aa5bf441
--- /dev/null
+++ b/doc/src/images/blur-icon.png
Binary files differ
diff --git a/doc/src/images/color-master-icon.png b/doc/src/images/color-master-icon.png
new file mode 100644
index 00000000..e0853660
--- /dev/null
+++ b/doc/src/images/color-master-icon.png
Binary files differ
diff --git a/doc/src/images/effects-bloom.png b/doc/src/images/effects-bloom.png
new file mode 100644
index 00000000..98849272
--- /dev/null
+++ b/doc/src/images/effects-bloom.png
Binary files differ
diff --git a/doc/src/images/effects-blur.png b/doc/src/images/effects-blur.png
new file mode 100644
index 00000000..53594a2a
--- /dev/null
+++ b/doc/src/images/effects-blur.png
Binary files differ
diff --git a/doc/src/images/effects-color-master.png b/doc/src/images/effects-color-master.png
new file mode 100644
index 00000000..40c4c2fe
--- /dev/null
+++ b/doc/src/images/effects-color-master.png
Binary files differ