From 6b8a283b5880b3242050e1925cca327354b91dc3 Mon Sep 17 00:00:00 2001 From: Mats Honkamaa Date: Wed, 11 Sep 2019 10:34:19 +0300 Subject: Add documentation for blur, bloom, and color master effects Task-number: QT3DS-3938 Change-Id: Iaf754de6727425b3f3a3f9c7d5a340cf20818099 Reviewed-by: Mahmoud Badri Reviewed-by: Miikka Heikkinen --- doc/src/10-best-practices/80-effects.qdoc | 20 ++++++++- doc/src/bloom.qdoc | 56 ++++++++++++++++++++++++ doc/src/blur.qdoc | 55 ++++++++++++++++++++++++ doc/src/color-master.qdoc | 68 ++++++++++++++++++++++++++++++ doc/src/images/bloom-icon.png | Bin 0 -> 28441 bytes doc/src/images/blur-icon.png | Bin 0 -> 6418 bytes doc/src/images/color-master-icon.png | Bin 0 -> 12118 bytes doc/src/images/effects-bloom.png | Bin 0 -> 148440 bytes doc/src/images/effects-blur.png | Bin 0 -> 21347 bytes doc/src/images/effects-color-master.png | Bin 0 -> 42781 bytes 10 files changed, 198 insertions(+), 1 deletion(-) create mode 100644 doc/src/bloom.qdoc create mode 100644 doc/src/blur.qdoc create mode 100644 doc/src/color-master.qdoc create mode 100644 doc/src/images/bloom-icon.png create mode 100644 doc/src/images/blur-icon.png create mode 100644 doc/src/images/color-master-icon.png create mode 100644 doc/src/images/effects-bloom.png create mode 100644 doc/src/images/effects-blur.png create mode 100644 doc/src/images/effects-color-master.png 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 @@ -71,27 +71,45 @@ lower in the scene graph will be applied before effects that are above them. \image additive-gradient-icon.png \b {\l{Additive color gradient}} \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 Binary files /dev/null and b/doc/src/images/bloom-icon.png differ diff --git a/doc/src/images/blur-icon.png b/doc/src/images/blur-icon.png new file mode 100644 index 00000000..aa5bf441 Binary files /dev/null and b/doc/src/images/blur-icon.png 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 Binary files /dev/null and b/doc/src/images/color-master-icon.png differ diff --git a/doc/src/images/effects-bloom.png b/doc/src/images/effects-bloom.png new file mode 100644 index 00000000..98849272 Binary files /dev/null and b/doc/src/images/effects-bloom.png differ diff --git a/doc/src/images/effects-blur.png b/doc/src/images/effects-blur.png new file mode 100644 index 00000000..53594a2a Binary files /dev/null and b/doc/src/images/effects-blur.png 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 Binary files /dev/null and b/doc/src/images/effects-color-master.png differ -- cgit v1.2.3