summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndy Shaw <andy.shaw@qt.io>2018-10-03 15:55:06 +0200
committerAndy Shaw <andy.shaw@qt.io>2018-11-07 16:48:13 +0000
commit38b87cc4bb0d4dfb47d907d39906104fea60a187 (patch)
tree890e3024014d17c973c68008146f2c8daa835d95
parent993351183893c8c5b1e55b8d819b190cc11ae008 (diff)
Doc: Clarify what samples() returns if not explicitly set
Change-Id: Icf4478121a9d67356eb976039c666d6945a2099c Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
-rw-r--r--src/gui/kernel/qsurfaceformat.cpp3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/gui/kernel/qsurfaceformat.cpp b/src/gui/kernel/qsurfaceformat.cpp
index 574310f554..1a814ec21f 100644
--- a/src/gui/kernel/qsurfaceformat.cpp
+++ b/src/gui/kernel/qsurfaceformat.cpp
@@ -319,7 +319,8 @@ void QSurfaceFormat::setStereo(bool enable)
/*!
Returns the number of samples per pixel when multisampling is
- enabled. By default, multisampling is disabled.
+ enabled, or \c -1 when multisampling is disabled. The default
+ return value is \c -1.
\sa setSamples()
*/