summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Hinch <peter@hinch.me.uk>2017-09-12 16:48:39 +0100
committerDamien George <damien.p.george@gmail.com>2017-09-13 16:36:57 +1000
commitd42b89bc3a9b85488a272235b1cc5fb342ab2536 (patch)
tree1b2d7b5dd2658197aedefaa040b294c6d85e2e84
parentd7cd1d2027504278a58795eefab41c80ea14d5e9 (diff)
docs/library/framebuf.rst: Generalise constructor to all colour formats.
-rw-r--r--docs/library/framebuf.rst11
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/library/framebuf.rst b/docs/library/framebuf.rst
index b92bd08ef..74c9f8564 100644
--- a/docs/library/framebuf.rst
+++ b/docs/library/framebuf.rst
@@ -38,9 +38,9 @@ Constructors
- *width* is the width of the FrameBuffer in pixels
- *height* is the height of the FrameBuffer in pixels
- *format* specifies the type of pixel used in the FrameBuffer;
- valid values are ``framebuf.MVLSB``, ``framebuf.RGB565``
- and ``framebuf.GS4_HMSB``. MVLSB is monochrome 1-bit color,
- RGB565 is RGB 16-bit color, and GS4_HMSB is grayscale 4-bit color.
+ permissible values are listed under Constants below. These set the
+ number of bits used to encode a color value and the layout of these
+ bits in *buffer*.
Where a color value c is passed to a method, c is a small integer
with an encoding that is dependent on the format of the FrameBuffer.
- *stride* is the number of pixels between each horizontal line
@@ -110,8 +110,9 @@ Other methods
corresponding color will be considered transparent: all pixels with that
color value will not be drawn.
- This method works between FrameBuffer's utilising different formats, but the
- resulting colors may be unexpected due to the mismatch in color formats.
+ This method works between FrameBuffer instances utilising different formats,
+ but the resulting colors may be unexpected due to the mismatch in color
+ formats.
Constants
---------