Add initial documentation for 2.4 OpenGL Runtime

Mostly copy paste of documentation from 2.3. Adds DataOutput
documentation and recommendations to avoid APIs that require use
of elementPath.

Task-number: QT3DS-3529
Change-Id: I75878fc2cd0e101827ea02996d6df8a981afe4fc
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Reviewed-by: Jari Karppinen <jari.karppinen@qt.io>
Reviewed-by: Janne Kangas <janne.kangas@qt.io>
Reviewed-by: Pasi Keränen <pasi.keranen@qt.io>
 

1 files changed, 7 insertions, 3 deletions

diff --git a/src/Runtime/api/studio3d/q3dsviewersettings.h b/src/Runtime/api/studio3d/q3dsviewersettings.h
index 80d5edb2..5d7abf68 100644
--- a/src/Runtime/api/studio3d/q3dsviewersettings.h
+++ b/src/Runtime/api/studio3d/q3dsviewersettings.h
@@ -44,9 +44,12 @@ class Q_STUDIO3D_EXPORT Q3DSViewerSettings : public QObject
     Q_DECLARE_PRIVATE(Q3DSViewerSettings)
     Q_ENUMS(ShadeMode)
     Q_ENUMS(ScaleMode)
+
+// #TODO: QT3DS-3542 Q3DSViewerSettings API is missing property matteEnabled compared to 2.3
+//    Q_PROPERTY(bool matteEnabled READ matteEnabled WRITE setMatteEnabled NOTIFY matteEnabledChanged)
+
     Q_PROPERTY(QColor matteColor READ matteColor WRITE setMatteColor NOTIFY matteColorChanged)
     Q_PROPERTY(bool showRenderStats READ isShowRenderStats WRITE setShowRenderStats NOTIFY showRenderStatsChanged)
-    Q_PROPERTY(ShadeMode shadeMode READ shadeMode WRITE setShadeMode NOTIFY shadeModeChanged)
     Q_PROPERTY(ScaleMode scaleMode READ scaleMode WRITE setScaleMode NOTIFY scaleModeChanged)
 
 public:
@@ -66,7 +69,6 @@ public:
 
     QColor matteColor() const;
     bool isShowRenderStats() const;
-    ShadeMode shadeMode() const;
     ScaleMode scaleMode() const;
 
     Q_INVOKABLE void save(const QString &group, const QString &organization = QString(),
@@ -77,7 +79,6 @@ public:
 public Q_SLOTS:
     void setMatteColor(const QColor &color);
     void setShowRenderStats(bool show);
-    void setShadeMode(ShadeMode mode);
     void setScaleMode(ScaleMode mode);
 
 Q_SIGNALS:
@@ -90,6 +91,9 @@ private:
     Q_DISABLE_COPY(Q3DSViewerSettings)
     Q3DSViewerSettingsPrivate *d_ptr;
 
+    ShadeMode shadeMode() const;
+    void setShadeMode(ShadeMode mode);
+
     friend class Q3DSSurfaceViewerPrivate;
     friend class Q3DSRenderer;
     friend class Q3DSStudio3D;