summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/doc/src/qtdatavisualization.qdoc
diff options
context:
space:
mode:
authorMiikka Heikkinen <miikka.heikkinen@digia.com>2014-02-19 10:53:01 +0200
committerMiikka Heikkinen <miikka.heikkinen@digia.com>2014-02-20 10:20:19 +0200
commite083a4ccd8ca7f890b4ee43057305e4a272256d6 (patch)
tree9b9255ed1cc49799e471c4ac4e157e784313f0eb /src/datavisualization/doc/src/qtdatavisualization.qdoc
parent9189a2dbab552ccff123ecb652083fe5616b5261 (diff)
Document the rendering changes
Change-Id: I100a516f6f5d8047b88f6d81cd8794979211df20 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@digia.com> Reviewed-by: Tomi Korpipää <tomi.korpipaa@digia.com>
Diffstat (limited to 'src/datavisualization/doc/src/qtdatavisualization.qdoc')
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization.qdoc24
1 files changed, 17 insertions, 7 deletions
diff --git a/src/datavisualization/doc/src/qtdatavisualization.qdoc b/src/datavisualization/doc/src/qtdatavisualization.qdoc
index c85b9dbb..e68a1086 100644
--- a/src/datavisualization/doc/src/qtdatavisualization.qdoc
+++ b/src/datavisualization/doc/src/qtdatavisualization.qdoc
@@ -301,24 +301,34 @@
* \fn QSurfaceFormat QtDataVisualization::qDefaultSurfaceFormat(bool antialias = true)
* \relates QAbstract3DGraph
*
- * Anti-aliasing is turned on by default on C++ and turned off on QML, except in OpenGL ES2
- * environments, where anti-aliasing is not supported by Qt Data Visualization.
- * This convenience function can be used to construct a suitable surface format for use by
+ * This convenience function can be used to create a custom surface format suitable for use by
* Qt Data Visualization graphs.
- * The \a{antialias} parameter specifies whether or not anti-aliasing is activated.
+ *
+ * The \a antialias parameter specifies whether or not antialiasing is activated.
+ *
* Give the surface format returned by this function to the graph constructor (C++) or set
* it as the window format for QQuickView (QML) before calling show on it.
*
- * For example, disable anti-aliasing on C++ application:
+ * For example, disable antialiasing on C++ application:
*
* \code
+ * #include <QtDataVisualization/qutils.h>
+ *
+ * // ...
+ *
* Q3DBars *graph = new Q3DBars(QtDataVisualization::qDefaultSurfaceFormat(false));
* \endcode
*
- * For example, enable anti-aliasing on QML application:
+ * For example, enable antialiasing for direct rendering modes on QML application:
*
* \code
- * QtQuick2ApplicationViewer viewer;
+ * #include <QtDataVisualization/qutils.h>
+ *
+ * // ...
+ *
+ * QQuickView viewer;
* viewer.setFormat(QtDataVisualization::qDefaultSurfaceFormat());
* \endcode
+ *
+ * \note Antialiasing is not supported in OpenGL ES2 environments.
*/