Fix documentation for QSGGeometry::allocate()

Make clear in the documentation that client code must dirty the
geometry node that contains the geometry class, to allow the
renderer implementation to update internal buffers.

Change-Id: I5cfddee1d0969410d7b3175c381679bd9083cc2b
Reviewed-by: Damian Jansen <damian.jansen@nokia.com>
Reviewed-by: Alex Wilson <alex.wilson@nokia.com>

diff --git a/src/quick/scenegraph/coreapi/qsggeometry.cpp b/src/quick/scenegraph/coreapi/qsggeometry.cpp
index cf39c30..c4c6c4f 100644 (file)
--- a/src/quick/scenegraph/coreapi/qsggeometry.cpp
+++ b/src/quick/scenegraph/coreapi/qsggeometry.cpp
@@ -302,6 +302,9 @@ void QSGGeometry::setLineWidth(float w)
     vertices and \a indexCount indices.
 
     Vertex and index data will be invalidated after this call and the caller must
+    mark the associated geometry node as dirty, by calling
+    node->markDirty(QSGNode::DirtyGeometry) to ensure that the renderer has
+    a chance to update internal buffers.
  */
 void QSGGeometry::allocate(int vertexCount, int indexCount)
 {