Document stereoscopic rendering

Added documentation on stereoscopic rendering.

Task-number: QT3DS-2699
Change-Id: Ida98313a619c25f7bf9609bbba22f41b80f70287
Reviewed-by: Kaj Grönholm <kaj.gronholm@qt.io>
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>

6 files changed, 74 insertions, 0 deletions

diff --git a/doc/src/00-concepts.qdoc b/doc/src/00-concepts.qdoc
index 9f0303ae..e72b7859 100644
--- a/doc/src/00-concepts.qdoc
+++ b/doc/src/00-concepts.qdoc
@@ -55,6 +55,7 @@ interactive presentations, UIs and applications.
         \li \l{Layers}
         \li \l{Light Properties}{Lights}
         \li \l{Using Sub-Presentations}{Sub-Presentations}
+        \li \l{Stereoscopic Rendering}
       \endlist
     \li \b {Animations}
       \list
diff --git a/doc/src/images/stereo-anaglyph.png b/doc/src/images/stereo-anaglyph.png
new file mode 100644
index 00000000..f8775043
--- /dev/null
+++ b/doc/src/images/stereo-anaglyph.png
diff --git a/doc/src/images/stereo-leftright.png b/doc/src/images/stereo-leftright.png
new file mode 100644
index 00000000..45a11dbb
--- /dev/null
+++ b/doc/src/images/stereo-leftright.png
diff --git a/doc/src/images/stereo-mode-menu.png b/doc/src/images/stereo-mode-menu.png
new file mode 100644
index 00000000..0cf0e79a
--- /dev/null
+++ b/doc/src/images/stereo-mode-menu.png
diff --git a/doc/src/images/stereo-topbottom.png b/doc/src/images/stereo-topbottom.png
new file mode 100644
index 00000000..66536600
--- /dev/null
+++ b/doc/src/images/stereo-topbottom.png
diff --git a/doc/src/stereoscopic-rendering.qdoc b/doc/src/stereoscopic-rendering.qdoc
new file mode 100644
index 00000000..167b1f15
--- /dev/null
+++ b/doc/src/stereoscopic-rendering.qdoc
@@ -0,0 +1,73 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 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 Stereoscopic Rendering
+\page stereoscopic-rendering.html
+
+This is a technical preview on how stereoscopic rendering could work in Qt 3D Studio.
+
+Stereoscopy is a technique that adds the illusion of depth to a flat image. Special glasses or
+stereoscopic displays are needed to view stereoscopic images.
+
+\section1 Use Stereoscopic Rendering
+
+To enable stereoscopic rendering, follow the steps below:
+\list 1
+  \li
+  Run your presentation in the Viewer.
+  \li
+  Select the desired stereo mode from \uicontrol {View > Stereo Mode} in the menu bar. Select
+  \uicontrol {Mono} to disable stereoscopic rendering.
+  \image stereo-mode-menu.png
+\endlist
+
+You can decrease or increase camera separation from
+\uicontrol{View > Stereo Mode} or by using shortcut keys
+\e {Ctrl + Shift + -} and \e {Ctrl + Shift + +}
+
+\section1 Stereo Modes
+The following stereo modes are available.
+
+\section2 Top-Bottom
+Render two images, one for each eye, one above the other.
+
+\image stereo-topbottom.png
+
+\section2 Left-Right
+Render two images, one for each eye, side-by-side.
+
+\image stereo-leftright.png
+
+\section2 Anaglyph
+Render two differently colored images, one for each eye. Supported anaglyph glasses
+are Red-Cyan and Green-Magenta.
+
+\image stereo-anaglyph.png
+
+*/