Document TileGrid limitation to tile values 0..255

Closes #6149
This commit is contained in:
Jeff Epler 2022-04-05 09:07:35 -05:00
parent 47d3d0d7f8
commit d24f3b812d
No known key found for this signature in database
GPG Key ID: D5BF15AB975AB4DE

View File

@ -53,6 +53,8 @@
//| convert the value and its location to a display native pixel color. This may be a simple color //| 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. //| 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. //| 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. //| :param Bitmap,OnDiskBitmap,Shape bitmap: The bitmap storing one or more tiles.