Loading...
Searching...
No Matches
icon.h File Reference

GUI: Icon API. More...

#include <stdint.h>
#include <core/common_defines.h>

Go to the source code of this file.

Typedefs

typedef struct Icon Icon
 

Functions

uint16_t icon_get_width (const Icon *instance)
 Get icon width.
 
uint16_t icon_get_height (const Icon *instance)
 Get icon height.
 
FURI_DEPRECATED const uint8_t * icon_get_data (const Icon *instance)
 Get Icon XBM bitmap data for the first frame.
 
uint32_t icon_get_frame_count (const Icon *instance)
 Get Icon frame count.
 
const uint8_t * icon_get_frame_data (const Icon *instance, uint32_t frame)
 Get Icon XBM bitmap data for a particular frame.
 

Detailed Description

GUI: Icon API.

Function Documentation

◆ icon_get_data()

FURI_DEPRECATED const uint8_t * icon_get_data ( const Icon * instance)

Get Icon XBM bitmap data for the first frame.

Parameters
[in]instancepointer to Icon data
Returns
pointer to compressed XBM bitmap data

◆ icon_get_frame_count()

uint32_t icon_get_frame_count ( const Icon * instance)

Get Icon frame count.

Parameters
[in]instancepointer to Icon data
Returns
frame count

◆ icon_get_frame_data()

const uint8_t * icon_get_frame_data ( const Icon * instance,
uint32_t frame )

Get Icon XBM bitmap data for a particular frame.

Parameters
[in]instancepointer to Icon data
[in]frameframe index
Returns
pointer to compressed XBM bitmap data

◆ icon_get_height()

uint16_t icon_get_height ( const Icon * instance)

Get icon height.

Parameters
[in]instancepointer to Icon data
Returns
height in pixels

◆ icon_get_width()

uint16_t icon_get_width ( const Icon * instance)

Get icon width.

Parameters
[in]instancepointer to Icon data
Returns
width in pixels