cabi documentation needs to include height limitation

Question

cabi documentation needs to include height limitation

unwiredben opened this issue 4 years ago · 3 comments

I was trying to figure out why some of the bitmaps I'd tried to compress didn't work correctly, and found the note at the bottom of https://github.com/Team-ARG-Museum/drawCompressed -- bitmaps that aren't a multiple of 8 pixels in height won't be compressed properly. I think this should be called out on the cabi readme page or the code should be fixed to automatically pad heights to the next mulitple of 8 since drawCompressed will ignore writing of zero bits anyway.

Answer 1 · 2020-08-31T20:26:42.000Z

Thanks.

I'll update the documentation for Cabi and also the drawCompressed() function with notes to that effect.

Answer 2 · 2020-08-31T20:35:23.000Z

I'll also modify the code to output an error and abort if the height of the bitmap isn't a multiple of 8.

Answer 3 · 2020-09-30T10:44:10.000Z

cabi.c now reports an error and exits if the input image's height isn't a multiple of 8 pixels. The README.md file for Cabi has been updated to include this restriction.
500d81a