Add OpenGL-only notes to the simple materials

Change-Id: I4b7f9ef379f2641da9c06572daa5ba41b03dd994
Reviewed-by: Gunnar Sletta <gunnar@sletta.org>
This commit is contained in:
Laszlo Agocs 2016-06-03 12:52:24 +02:00
parent c639588c2c
commit 787918e7f2
4 changed files with 16 additions and 1 deletions

View File

@ -125,6 +125,9 @@ void FlatColorMaterialShader::initialize()
\inmodule QtQuick
\ingroup qtquick-scenegraph-materials
\warning This utility class is only functional when running with the OpenGL
backend of the Qt Quick scenegraph.
The flat color material will fill every pixel in a geometry using
a solid color. The color can contain transparency.

View File

@ -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

View File

@ -127,6 +127,9 @@ void QSGOpaqueTextureMaterialShader::updateState(const RenderState &state, QSGMa
\inmodule QtQuick
\ingroup qtquick-scenegraph-materials
\warning This utility class is only functional when running with the OpenGL
backend of the Qt Quick scenegraph.
The opaque textured material will fill every pixel in a geometry with
the supplied texture. The material does not respect the opacity of the
QSGMaterialShader::RenderState, so opacity nodes in the parent chain
@ -321,6 +324,9 @@ int QSGOpaqueTextureMaterial::compare(const QSGMaterial *o) const
\inmodule QtQuick
\ingroup qtquick-scenegraph-materials
\warning This utility class is only functional when running with the OpenGL
backend of the Qt Quick scenegraph.
The textured material will fill every pixel in a geometry with
the supplied texture.

View File

@ -107,6 +107,9 @@ void QSGVertexColorMaterialShader::initialize()
\inmodule QtQuick
\ingroup qtquick-scenegraph-materials
\warning This utility class is only functional when running with the OpenGL
backend of the Qt Quick scenegraph.
The vertex color material will give each vertex in a geometry a color. Pixels between
vertices will be linearly interpolated. The colors can contain transparency.