Return a 8bit bitmap mask that can be used with lcd.drawBitmapPattern()

@status current Introduced in 2.8.0

Parameters

• bitmap (pointer) point to a bitmap previously opened with Bitmap.open()

Return value

• a bitmap mask

Notice

Only available on Horus

Loads a bitmap in memory, for later use with lcd.drawBitmap(). Bitmaps should be loaded only once, returned object should be stored and used for drawing. If loading fails for whatever reason the resulting bitmap object will have width and height set to zero.

Bitmap loading can fail if:

• File is not found or contains invalid image

• System is low on memory

• Combined memory usage of all Lua script bitmaps exceeds certain value

@status current Introduced in 2.2.0

Parameters

• name (string) full path to the bitmap on SD card (i.e. “/IMAGES/test.bmp”)

Return value

• bitmap (object) a bitmap object that can be used with other bitmap functions

Notice

Only available on Horus

Return a resized bitmap object

@status current Introduced in 2.8.0

Parameters

• bitmap (pointer) point to a bitmap previously opened with Bitmap.open()

• width (number) the new bitmap width

• height (number) the new bitmap height

Return value

none

Notice

Only available on Horus

Return width, height of a bitmap object

@status current Introduced in 2.2.0

Parameters

• bitmap (pointer) point to a bitmap previously opened with Bitmap.open()

Return value

• multiple returns 2 values:

  • (number) width in pixels

  • (number) height in pixels

Notice

Only available on Horus