summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKai Koehne <kai.koehne@theqtcompany.com>2015-05-21 13:10:36 +0200
committerKai Koehne <kai.koehne@theqtcompany.com>2015-06-04 14:20:48 +0000
commit2556b97ab22cfde606d2b77d6e816fd282741291 (patch)
tree563d85ecae59d9b9177f68bfa5c930aa859667eb
parent2c860b9c4de8a1f423a1a6c10a3460552e959d95 (diff)
Doc: Document limits of QSGGeometry::setLineWidth5.4
Task-number: QTBUG-46260 Change-Id: Ib84a41da10d38391c3248a209a851f5b603d46b0 Reviewed-by: Gunnar Sletta <gunnar@sletta.org>
-rw-r--r--src/quick/scenegraph/coreapi/qsggeometry.cpp10
1 files changed, 8 insertions, 2 deletions
diff --git a/src/quick/scenegraph/coreapi/qsggeometry.cpp b/src/quick/scenegraph/coreapi/qsggeometry.cpp
index 7be926ad81..7e43541ef7 100644
--- 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()
*/