From: Casper van Donderen Date: Wed, 21 Sep 2011 05:13:38 +0000 (+0200) Subject: Add QSGPaintedItem docs to module and fix non-standard wording. X-Git-Url: http://git.silmor.de/gitweb/?a=commitdiff_plain;h=6c0215a523b1294015e238018dc34cf56a46024c;p=konrad%2Fqtdeclarative.git Add QSGPaintedItem docs to module and fix non-standard wording. Change-Id: I763b1fdabdac36935bd14005a9e38b2494319726 Reviewed-on: http://codereview.qt-project.org/5521 Reviewed-by: Qt Sanity Bot Reviewed-by: Casper van Donderen --- diff --git a/src/declarative/items/qsgpainteditem.cpp b/src/declarative/items/qsgpainteditem.cpp index 19d2a9a..16c3b3d 100644 --- a/src/declarative/items/qsgpainteditem.cpp +++ b/src/declarative/items/qsgpainteditem.cpp @@ -54,6 +54,8 @@ QT_BEGIN_NAMESPACE \brief The QSGPaintedItem class provides a way to use the QPainter API in the QML Scene Graph. + \inmodule QtDeclarative + The QSGPaintedItem makes it possible to use the QPainter API with the QML Scene Graph. It sets up a textured rectangle in the Scene Graph and uses a QPainter to paint onto the texture. The render target can be either a QImage or a QOpenGLFramebufferObject. diff --git a/src/declarative/scenegraph/coreapi/qsgnode.cpp b/src/declarative/scenegraph/coreapi/qsgnode.cpp index 083b073..764071c 100644 --- a/src/declarative/scenegraph/coreapi/qsgnode.cpp +++ b/src/declarative/scenegraph/coreapi/qsgnode.cpp @@ -62,6 +62,8 @@ static void qt_print_node_count() \class QSGNode \brief The QSGNode class is the base class for all nodes in the scene graph. + \inmodule QtDeclarative + The QSGNode class can be used as a child container. Children are added with the appendChildNode(), prependChildNode(), insertChildNodeBefore() and insertChildNodeAfter(). Ordering of nodes is important as geometry nodes @@ -476,7 +478,9 @@ void QSGNode::markDirty(DirtyFlags flags) /*! \class QSGBasicGeometryNode - \brief The QSGBasicGeometryNode serves as a baseclass for geometry based nodes + \brief The QSGBasicGeometryNode class serves as a baseclass for geometry based nodes + + \inmodule QtDeclarative The QSGBasicGeometryNode class should not be used by itself. It is only encapsulates shared functionality between the QSGGeometryNode and QSGClipNode classes. @@ -539,6 +543,8 @@ void QSGBasicGeometryNode::setGeometry(QSGGeometry *geometry) \class QSGGeometryNode \brief The QSGGeometryNode class is used for all rendered content in the scene graph. + \inmodule QtDeclarative + The QSGGeometryNode consists of geometry and material. The geometry defines the mesh, the vertices and their structure, to be drawn. The Material defines how the shape is filled. @@ -704,7 +710,9 @@ void QSGGeometryNode::setInheritedOpacity(qreal opacity) /*! \class QSGClipNode - \brief The QSGClipNode implements the clipping functionality in the scene graph. + \brief The QSGClipNode class implements the clipping functionality in the scene graph. + + \inmodule QtDeclarative Clipping applies to the node's subtree and can be nested. Multiple clip nodes will be accumulated by intersecting all their geometries. The accumulation happens @@ -790,7 +798,9 @@ void QSGClipNode::setClipRect(const QRectF &rect) /*! \class QSGTransformNode - \brief The QSGTransformNode implements transformations in the scene graph + \brief The QSGTransformNode class implements transformations in the scene graph + + \inmodule QtDeclarative Transformations apply the node's subtree and can be nested. Multiple transform nodes will be accumulated by intersecting all their matrices. The accumulation happens @@ -909,9 +919,11 @@ void QSGRootNode::notifyNodeChange(QSGNode *node, DirtyFlags flags) /*! \class QSGOpacityNode - \brief The QSGOpacityNode is used + \brief The QSGOpacityNode class is used to change opacity of nodes. + + \inmodule QtDeclarative - Opacity apply to its subtree and can be nested. Multiple opacity nodes + Opacity applies to its subtree and can be nested. Multiple opacity nodes will be accumulated by multiplying their opacity. The accumulation happens as part of the rendering. @@ -926,7 +938,7 @@ void QSGRootNode::notifyNodeChange(QSGNode *node, DirtyFlags flags) /*! Constructs an opacity node with a default opacity of 1. - Opacity accumulate downwards in the scene graph so a node with two + Opacity accumulates downwards in the scene graph so a node with two QSGOpacityNode instances above it, both with opacity of 0.5, will have effective opacity of 0.25. diff --git a/src/declarative/scenegraph/util/qsgflatcolormaterial.cpp b/src/declarative/scenegraph/util/qsgflatcolormaterial.cpp index affdcad..ee73616 100644 --- a/src/declarative/scenegraph/util/qsgflatcolormaterial.cpp +++ b/src/declarative/scenegraph/util/qsgflatcolormaterial.cpp @@ -119,9 +119,11 @@ const char *FlatColorMaterialShader::fragmentShader() const { /*! \class QSGFlatColorMaterial - \brief The QSGFlatColorMaterial provides a convenient way of rendering + \brief The QSGFlatColorMaterial class provides a convenient way of rendering solid colored geometry in the scene graph. + \inmodule QtDeclarative + The flat color material will fill every pixel in a geometry using a solid color. The color can contain transparency. diff --git a/src/declarative/scenegraph/util/qsgsimpletexturenode.cpp b/src/declarative/scenegraph/util/qsgsimpletexturenode.cpp index 5ada853..a0d6616 100644 --- a/src/declarative/scenegraph/util/qsgsimpletexturenode.cpp +++ b/src/declarative/scenegraph/util/qsgsimpletexturenode.cpp @@ -58,10 +58,12 @@ static void qsgsimpletexturenode_update(QSGGeometry *g, /*! \class QSGSimpleTextureNode - \brief The QSGSimpleTextureNode provided for convenience to easily draw + \brief The QSGSimpleTextureNode class is provided for convenience to easily draw textured content using the QML scene graph. - \warning The simple texture node class must have texture before being + \inmodule QtDeclarative + + \warning The simple texture node class must have a texture before being added to the scene graph to be rendered. */ diff --git a/src/declarative/scenegraph/util/qsgvertexcolormaterial.cpp b/src/declarative/scenegraph/util/qsgvertexcolormaterial.cpp index 637d549..5f62703 100644 --- a/src/declarative/scenegraph/util/qsgvertexcolormaterial.cpp +++ b/src/declarative/scenegraph/util/qsgvertexcolormaterial.cpp @@ -110,9 +110,11 @@ const char *QSGVertexColorMaterialShader::fragmentShader() const { /*! \class QSGVertexColorMaterial - \brief The QSGVertexColorMaterial provides a convenient way of rendering per-vertex + \brief The QSGVertexColorMaterial class provides a convenient way of rendering per-vertex colored geometry in the scene graph. + \inmodule QtDeclarative + 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. @@ -123,7 +125,7 @@ const char *QSGVertexColorMaterialShader::fragmentShader() const { QSGGeometry::defaultAttributes_ColoredPoint2D() constructs an attribute set compatible with this material. - The vertex color material respets both current opacity and current matrix when + The vertex color material respects both current opacity and current matrix when updating it's rendering state. */