Skip to content

Commit d42b89b

Browse files
peterhinchdpgeorge
authored andcommitted
docs/library/framebuf.rst: Generalise constructor to all colour formats.
1 parent d7cd1d2 commit d42b89b

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

docs/library/framebuf.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ Constructors
3838
- *width* is the width of the FrameBuffer in pixels
3939
- *height* is the height of the FrameBuffer in pixels
4040
- *format* specifies the type of pixel used in the FrameBuffer;
41-
valid values are ``framebuf.MVLSB``, ``framebuf.RGB565``
42-
and ``framebuf.GS4_HMSB``. MVLSB is monochrome 1-bit color,
43-
RGB565 is RGB 16-bit color, and GS4_HMSB is grayscale 4-bit color.
41+
permissible values are listed under Constants below. These set the
42+
number of bits used to encode a color value and the layout of these
43+
bits in *buffer*.
4444
Where a color value c is passed to a method, c is a small integer
4545
with an encoding that is dependent on the format of the FrameBuffer.
4646
- *stride* is the number of pixels between each horizontal line
@@ -110,8 +110,9 @@ Other methods
110110
corresponding color will be considered transparent: all pixels with that
111111
color value will not be drawn.
112112

113-
This method works between FrameBuffer's utilising different formats, but the
114-
resulting colors may be unexpected due to the mismatch in color formats.
113+
This method works between FrameBuffer instances utilising different formats,
114+
but the resulting colors may be unexpected due to the mismatch in color
115+
formats.
115116

116117
Constants
117118
---------

0 commit comments

Comments
 (0)