Doc: Document limits of QSGGeometry::setLineWidth

Task-number: QTBUG-46260
Change-Id: Ib84a41da10d38391c3248a209a851f5b603d46b0
Reviewed-by: Gunnar Sletta <gunnar@sletta.org>

diff --git a/src/quick/scenegraph/coreapi/qsggeometry.cpp b/src/quick/scenegraph/coreapi/qsggeometry.cpp
index 7be926ad814b7fa9fa4787d2dfc12f774e77ccc9..7e43541ef7ef0ec1a6bddda05337dc9a360d3933 100644 (file)
--- a/src/quick/scenegraph/coreapi/qsggeometry.cpp
+++ b/src/quick/scenegraph/coreapi/qsggeometry.cpp
@@ -522,7 +522,8 @@ void QSGGeometry::setDrawingMode(GLenum mode)
 /*!
     Gets the current line or point width or to be used for this geometry. This property
     only applies to line width when the drawingMode is \c GL_LINES, \c GL_LINE_STRIP, or
-    \c GL_LINE_LOOP, and only applies to point size when the drawingMode is \c GL_POINTS.
+    \c GL_LINE_LOOP. For desktop OpenGL, it also applies to point size when the drawingMode
+    is \c GL_POINTS.
 
     The default value is \c 1.0
 
@@ -536,7 +537,12 @@ float QSGGeometry::lineWidth() const
 /*!
     Sets the line or point width to be used for this geometry to \a width. This property
     only applies to line width when the drawingMode is \c GL_LINES, \c GL_LINE_STRIP, or
-    \c GL_LINE_LOOP, and only applies to point size when the drawingMode is \c GL_POINTS.
+    \c GL_LINE_LOOP. For Desktop OpenGL, it also applies to point size when the drawingMode
+    is \c GL_POINTS.
+
+    \note How line width and point size are treated is implementation dependent: The application
+    should not rely on these, but rather create triangles or similar to draw areas. On OpenGL ES,
+    line width support is limited and point size is unsupported.
 
     \sa lineWidth(), drawingMode()
 */