aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/scenegraph/coreapi/qsgmaterial.cpp
diff options
context:
space:
mode:
authorGunnar Sletta <gunnar.sletta@digia.com>2013-01-07 16:20:39 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-01-16 21:32:32 +0100
commitc8a04f9412c1e765a98be86387fd848ca7ea6993 (patch)
tree253f1f893d4265073e18f155e0d4f5b9adb81310 /src/quick/scenegraph/coreapi/qsgmaterial.cpp
parent20f5919a63e36fe43a9d8107992badcd8cf8c915 (diff)
Greatly improved Scene Graph Overview documentation
Change-Id: I86b6bb9007d268ec039614a1693ecd839901e6d9 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/quick/scenegraph/coreapi/qsgmaterial.cpp')
-rw-r--r--src/quick/scenegraph/coreapi/qsgmaterial.cpp11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/quick/scenegraph/coreapi/qsgmaterial.cpp b/src/quick/scenegraph/coreapi/qsgmaterial.cpp
index f8f426fcda..0e40a01311 100644
--- a/src/quick/scenegraph/coreapi/qsgmaterial.cpp
+++ b/src/quick/scenegraph/coreapi/qsgmaterial.cpp
@@ -44,12 +44,21 @@
QT_BEGIN_NAMESPACE
+/*!
+ \group qtquick-scenegraph-materials
+ \title Qt Quick Scene Graph Material Classes
+ \brief classes used to define materials in the Qt Quick Scene Graph.
+
+ This page lists the material classes in \l {Qt Quick}'s
+ \l {scene graph}{Qt Quick Scene Graph}.
+ */
/*!
\class QSGMaterialShader
\brief The QSGMaterialShader class represents an OpenGL shader program
in the renderer.
\inmodule QtQuick
+ \ingroup qtquick-scenegraph-materials
The QSGMaterialShader API is very low-level. A more convenient API, which
provides almost all the same features, is available through
@@ -479,6 +488,7 @@ static void qt_print_material_count()
\class QSGMaterialType
\brief The QSGMaterialType class is used as a unique type token in combination with QSGMaterial.
\inmodule QtQuick
+ \ingroup qtquick-scenegraph-materials
It serves no purpose outside the QSGMaterial::type() function.
*/
@@ -487,6 +497,7 @@ static void qt_print_material_count()
\class QSGMaterial
\brief The QSGMaterial class encapsulates rendering state for a shader program.
\inmodule QtQuick
+ \ingroup qtquick-scenegraph-materials
The QSGMaterial API is very low-level. A more convenient API, which
provides almost all the same features, is available through