Momentum-Firmware/documentation/js/js_gui__icon.md

GUI Icons

Retrieves and loads icons for use with GUI views such as Dialog.

Example

For an example, refer to the gui.js example script.

API reference

getBuiltin()

Gets a built-in firmware icon by its name. All known icons bundled with firmware are supported.

Parameters

• icon: name of the icon

Returns

An IconData object.

loadFxbm()

Loads a .fxbm icon (XBM Flipper sprite, from flipperzero-game-engine) from file. It will be automatically unloaded when the script exits.

Parameters

• path: path to the .fxbm file

Returns

An IconData object.