aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/scenegraph/util/qsgsimplematerial.cpp
diff options
context:
space:
mode:
authorLaszlo Agocs <laszlo.agocs@theqtcompany.com>2016-06-03 12:52:24 +0200
committerLaszlo Agocs <laszlo.agocs@theqtcompany.com>2016-06-06 10:11:06 +0000
commit787918e7f2885272754f24cf589e65a9193c679b (patch)
tree813dc3ff5466f1bc99b6421039ced03cda5d1ffc /src/quick/scenegraph/util/qsgsimplematerial.cpp
parentc639588c2cfa4eac2512238cc03c7126c8c19371 (diff)
Add OpenGL-only notes to the simple materials
Change-Id: I4b7f9ef379f2641da9c06572daa5ba41b03dd994 Reviewed-by: Gunnar Sletta <gunnar@sletta.org>
Diffstat (limited to 'src/quick/scenegraph/util/qsgsimplematerial.cpp')
-rw-r--r--src/quick/scenegraph/util/qsgsimplematerial.cpp5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/quick/scenegraph/util/qsgsimplematerial.cpp b/src/quick/scenegraph/util/qsgsimplematerial.cpp
index 923179071b..7214a255df 100644
--- a/src/quick/scenegraph/util/qsgsimplematerial.cpp
+++ b/src/quick/scenegraph/util/qsgsimplematerial.cpp
@@ -41,11 +41,14 @@
\class QSGSimpleMaterialShader
\brief The QSGSimpleMaterialShader class provides a convenient way of
- building custom materials for the scene graph.
+ building custom OpenGL-based materials for the scene graph.
\inmodule QtQuick
\ingroup qtquick-scenegraph-materials
+ \warning This utility class is only functional when running with the OpenGL
+ backend of the Qt Quick scenegraph.
+
Where the QSGMaterial and QSGMaterialShader API requires a bit of
boilerplate code to create a functioning material, the
QSGSimpleMaterialShader tries to hide some of this through the use