diff options
author | Peter Hinch <peter@hinch.me.uk> | 2017-04-01 07:00:09 +0100 |
---|---|---|
committer | Damien George <damien.p.george@gmail.com> | 2017-04-04 17:38:33 +1000 |
commit | 468c6f9da147d6e752e437a32211e317a116b6df (patch) | |
tree | a719f6e6a2b97d3ab23d59b6aa3c35e472a86790 /docs | |
parent | fc245d1ca4367f9876ac32c7e08e169da7db79b9 (diff) | |
download | micropython-468c6f9da147d6e752e437a32211e317a116b6df.tar.gz micropython-468c6f9da147d6e752e437a32211e317a116b6df.zip |
extmod/modframebuf: Make monochrome bitmap formats start with MONO_.
MONO_xxx is much easier to read if you're not familiar with the code.
MVLSB is deprecated but kept for backwards compatibility, for the time
being.
This patch also updates the associated docs and tests.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/library/framebuf.rst | 25 |
1 files changed, 24 insertions, 1 deletions
diff --git a/docs/library/framebuf.rst b/docs/library/framebuf.rst index 91fc362fdd..61f0635f36 100644 --- a/docs/library/framebuf.rst +++ b/docs/library/framebuf.rst @@ -116,9 +116,32 @@ Other methods Constants --------- -.. data:: framebuf.MVLSB +.. data:: framebuf.MONO_VLSB Monochrome (1-bit) color format + This defines a mapping where the bits in a byte are vertically mapped with + bit 0 being nearest the top of the screen. Consequently each byte occupies + 8 vertical pixels. Subsequent bytes appear at successive horizontal + locations until the rightmost edge is reached. Further bytes are rendered + at locations starting at the leftmost edge, 8 pixels lower. + +.. data:: framebuf.MONO_HLSB + + Monochrome (1-bit) color format + This defines a mapping where the bits in a byte are horizontally mapped. + Each byte occupies 8 horizontal pixels with bit 0 being the leftmost. + Subsequent bytes appear at successive horizontal locations until the + rightmost edge is reached. Further bytes are rendered on the next row, one + pixel lower. + +.. data:: framebuf.MONO_HMSB + + Monochrome (1-bit) color format + This defines a mapping where the bits in a byte are horizontally mapped. + Each byte occupies 8 horizontal pixels with bit 7 being the leftmost. + Subsequent bytes appear at successive horizontal locations until the + rightmost edge is reached. Further bytes are rendered on the next row, one + pixel lower. .. data:: framebuf.RGB565 |