Merge pull request #6245 from jepler/document-tilegrid-8bit

Document TileGrid limitation to tile values 0..255 & improve mp3 doc
This commit is contained in:
Dan Halbert 2022-04-06 09:40:41 -04:00 committed by GitHub
commit 85ce1610ea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 0 deletions

View File

@ -44,6 +44,20 @@
//| :param typing.BinaryIO file: Already opened mp3 file
//| :param ~circuitpython_typing.WriteableBuffer buffer: Optional pre-allocated buffer, that will be split in half and used for double-buffering of the data. If not provided, two buffers are allocated internally. The specific buffer size required depends on the mp3 file.
//|
//| Playback of mp3 audio is CPU intensive, and the
//| exact limit depends on many factors such as the particular
//| microcontroller, SD card or flash performance, and other
//| code in use such as displayio. If playback is garbled,
//| skips, or plays as static, first try using a "simpler" mp3:
//|
//| * Use constant bit rate (CBR) not VBR or ABR (variable or average bit rate) when encoding your mp3 file
//| * Use a lower sample rate (e.g., 11.025kHz instead of 48kHz)
//| * Use a lower bit rate (e.g., 32kbit/s instead of 256kbit/s)
//|
//| Reduce activity taking place at the same time as
//| mp3 playback. For instance, only update small portions of a
//| displayio screen if audio is playing. Disable auto-refresh
//| and explicitly call refresh.
//|
//| Playing a mp3 file from flash::
//|

View File

@ -53,6 +53,8 @@
//| convert the value and its location to a display native pixel color. This may be a simple color
//| palette lookup, a gradient, a pattern or a color transformer.
//|
//| To save RAM usage, tile values are only allowed in the range from 0 to 255 inclusive (single byte values).
//|
//| tile_width and tile_height match the height of the bitmap by default.
//|
//| :param Bitmap,OnDiskBitmap,Shape bitmap: The bitmap storing one or more tiles.