aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorNeil <nyamatongwe@gmail.com>2016-08-12 12:26:14 +1000
committerNeil <nyamatongwe@gmail.com>2016-08-12 12:26:14 +1000
commitab8374a72bf6ea57692938d3e7d73c64e9ae185a (patch)
tree15ef897f0e1b63b7a256c2337b366cd43f36bc1b
parent75dfa07a7eeef1ec419d8e4933e325ea8dbf5396 (diff)
downloadscintilla-mirror-ab8374a72bf6ea57692938d3e7d73c64e9ae185a.tar.gz
Discourage use of buffered mode.
-rw-r--r--doc/ScintillaDoc.html9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html
index 215f01fc3..93b9a9e70 100644
--- a/doc/ScintillaDoc.html
+++ b/doc/ScintillaDoc.html
@@ -3312,7 +3312,14 @@ struct Sci_TextToFind {
These messages turn buffered drawing on or off and report the buffered drawing state. Buffered
drawing draws each line into a bitmap rather than directly to the screen and then copies the
bitmap to the screen. This avoids flickering although it does take longer. The default is for
- drawing to be buffered.</p>
+ drawing to be buffered on Win32 and GTK+ and to not be buffered on Cocoa and Qt.
+ Buffered drawing is not supported on Cocoa.
+ </p>
+
+ <p>Current platforms perform window buffering so it is almost always better for this option to be turned off.
+ For Win32 and GTK+, client code should turn off buffering at initialisation.
+ There are some older platforms and unusual modes where buffering may still be useful.
+ </p>
<p><b id="SCI_SETPHASESDRAW">SCI_SETPHASESDRAW(int phases)</b><br />
<b id="SCI_GETPHASESDRAW">SCI_GETPHASESDRAW</b><br />