mirrors
/
micropython
mirror of https://github.com/micropython/micropython.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs/library/framebuf.rst: Generalise constructor to all colour formats.

This commit is contained in:
Peter Hinch 2017-09-12 16:48:39 +01:00 committed by Damien George
parent d7cd1d2027
commit d42b89bc3a
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/library/framebuf.rst
View File

@ -38,9 +38,9 @@ Constructors
- *width* is the width of the FrameBuffer in pixels - *width* is the width of the FrameBuffer in pixels
- *height* is the height of the FrameBuffer in pixels - *height* is the height of the FrameBuffer in pixels
- *format* specifies the type of pixel used in the FrameBuffer; - *format* specifies the type of pixel used in the FrameBuffer;
valid values are ``framebuf.MVLSB``, ``framebuf.RGB565`` permissible values are listed under Constants below. These set the
and ``framebuf.GS4_HMSB``. MVLSB is monochrome 1-bit color, number of bits used to encode a color value and the layout of these
RGB565 is RGB 16-bit color, and GS4_HMSB is grayscale 4-bit color. bits in *buffer*.
Where a color value c is passed to a method, c is a small integer 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. with an encoding that is dependent on the format of the FrameBuffer.
- *stride* is the number of pixels between each horizontal line - *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 corresponding color will be considered transparent: all pixels with that
color value will not be drawn. color value will not be drawn.
This method works between FrameBuffer's utilising different formats, but the This method works between FrameBuffer instances utilising different formats,
resulting colors may be unexpected due to the mismatch in color formats. but the resulting colors may be unexpected due to the mismatch in color
formats.
Constants Constants
--------- ---------