From e1d3fe529ddce015f62cc7ca22c29e8950c9cd39 Mon Sep 17 00:00:00 2001 From: Miikka Heikkinen Date: Tue, 14 Jan 2014 12:03:24 +0200 Subject: Documentation additions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Task-number: QTRD-2735 Change-Id: I4b28ac2876ad025c262f861e7620aa4d6de6ff60 Reviewed-by: Tomi Korpipää --- ...tdatavisualization-qml-abstractdeclarative.qdoc | 6 +++++ .../doc/src/qtdatavisualization.qdoc | 26 ++++++++++++++++++++++ 2 files changed, 32 insertions(+) (limited to 'src/datavisualization/doc') diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc index 5ac6a03f..71be09a2 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc @@ -28,6 +28,12 @@ Note that this type is uncreatable, but contains properties that are shared between the 3D visualizations. + \note QML doesn't support the type of anti-aliasing used by Qt Data Visualization graphs + by default. Setting the \c antialiasing property doesn't affect graphs. To enable + anti-aliasing for graphs, a custom surface format must be set up for the QQuickView + before showing it. You can use the convenience function + \c{QtDataVisualization::qDefaultSurfaceFormat()} to create the custom surface format object. + \sa Bars3D, Scatter3D, Surface3D, {Qt Data Visualization C++ Classes} */ diff --git a/src/datavisualization/doc/src/qtdatavisualization.qdoc b/src/datavisualization/doc/src/qtdatavisualization.qdoc index 9c951877..d29de4f7 100644 --- a/src/datavisualization/doc/src/qtdatavisualization.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization.qdoc @@ -286,3 +286,29 @@ When multiple series are added to a graph, selecting an item in one of them will clear the selection on other series. */ + +/*! + * \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 + * Qt Data Visualization graphs. + * The \a{antialias} parameter specifies whether or not anti-aliasing 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: + * + * \code + * Q3DBars *graph = new Q3DBars(QtDataVisualization::qDefaultSurfaceFormat(false)); + * \endcode + * + * For example, enable anti-aliasing on QML application: + * + * \code + * QtQuick2ApplicationViewer viewer; + * viewer.setFormat(QtDataVisualization::qDefaultSurfaceFormat()); + * \endcode + */ -- cgit v1.2.3