nbgl_screen.h File Reference

API to manage screens. More...

#include "nbgl_types.h"
#include "nbgl_obj.h"

Include dependency graph for nbgl_screen.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	nbgl_screenTickerConfiguration_s
	struct to configure a screen layer More...
struct	nbgl_screen_s
	struct to represent a screen (SCREEN type) More...

Typedefs
typedef void(*	nbgl_tickerCallback_t) (void)
	prototype of function to be called when a timer on screen is fired
typedef struct PACKED__ nbgl_screenTickerConfiguration_s	nbgl_screenTickerConfiguration_t
	struct to configure a screen layer
typedef struct PACKED__ nbgl_screen_s	nbgl_screen_t
	struct to represent a screen (SCREEN type)

Functions
void	nbgl_screen_reinit (void)
void	nbgl_wait_pipeline (void)
void	nbgl_screenRedraw (void)
nbgl_obj_t *	nbgl_screenGetAt (uint8_t screenIndex)
nbgl_obj_t *	nbgl_screenGetTop (void)
uint8_t	nbgl_screenGetCurrentStackSize (void)
uint8_t	nbgl_screenGetUxStackSize (void)
bool	nbgl_screenContainsObj (nbgl_obj_t *obj)
nbgl_obj_t *	nbgl_screenContainsObjType (nbgl_screen_t *screen, nbgl_obj_type_t type)
int	nbgl_screenSet (nbgl_obj_t ***elements, uint8_t nbElements, const nbgl_screenTickerConfiguration_t *ticker, nbgl_touchCallback_t touchCallback)
int	nbgl_screenUpdateNbElements (uint8_t screenIndex, uint8_t nbElements)
int	nbgl_screenUpdateBackgroundColor (uint8_t screenIndex, color_t color)
int	nbgl_screenUpdateTicker (uint8_t screenIndex, const nbgl_screenTickerConfiguration_t *ticker)
nbgl_obj_t **	nbgl_screenGetElements (uint8_t screenIndex)
int	nbgl_screenRelease (void)
int	nbgl_screenPush (nbgl_obj_t ***elements, uint8_t nbElements, const nbgl_screenTickerConfiguration_t *ticker, nbgl_touchCallback_t touchCallback)
int	nbgl_screenPop (uint8_t screenIndex)
int	nbgl_screenReset (void)
void	nbgl_screenHandler (uint32_t intervaleMs)

Detailed Description

API to manage screens.

Definition in file nbgl_screen.h.

Typedef Documentation

nbgl_screen_t

typedef struct PACKED__ nbgl_screen_s nbgl_screen_t

struct to represent a screen (SCREEN type)

Note

Only for internal usage

inherits from container

nbgl_screenTickerConfiguration_t

typedef struct PACKED__ nbgl_screenTickerConfiguration_s nbgl_screenTickerConfiguration_t

struct to configure a screen layer

nbgl_tickerCallback_t

typedef void(* nbgl_tickerCallback_t) (void)

prototype of function to be called when a timer on screen is fired

Definition at line 32 of file nbgl_screen.h.

Function Documentation

nbgl_screen_reinit()

void nbgl_screen_reinit

(

void

)

nbgl_screenContainsObj()

bool nbgl_screenContainsObj

(

nbgl_obj_t *

obj

)

nbgl_screenContainsObjType()

nbgl_obj_t * nbgl_screenContainsObjType	(	nbgl_screen_t *	screen,
		nbgl_obj_type_t	type
	)

nbgl_screenGetAt()

nbgl_obj_t * nbgl_screenGetAt

(

uint8_t

screenIndex

)

nbgl_screenGetCurrentStackSize()

uint8_t nbgl_screenGetCurrentStackSize

(

void

)

nbgl_screenGetElements()

nbgl_obj_t ** nbgl_screenGetElements

(

uint8_t

screenIndex

)

nbgl_screenGetTop()

nbgl_obj_t * nbgl_screenGetTop

(

void

)

nbgl_screenGetUxStackSize()

uint8_t nbgl_screenGetUxStackSize

(

void

)

nbgl_screenHandler()

void nbgl_screenHandler

(

uint32_t

intervaleMs

)

nbgl_screenPop()

int nbgl_screenPop

(

uint8_t

screenIndex

)

nbgl_screenPush()

int nbgl_screenPush	(	nbgl_obj_t ***	elements,
		uint8_t	nbElements,
		const nbgl_screenTickerConfiguration_t *	ticker,
		nbgl_touchCallback_t	touchCallback
	)

nbgl_screenRedraw()

void nbgl_screenRedraw

(

void

)

nbgl_screenRelease()

int nbgl_screenRelease

(

void

)

nbgl_screenReset()

int nbgl_screenReset

(

void

)

nbgl_screenSet()

int nbgl_screenSet	(	nbgl_obj_t ***	elements,
		uint8_t	nbElements,
		const nbgl_screenTickerConfiguration_t *	ticker,
		nbgl_touchCallback_t	touchCallback
	)

nbgl_screenUpdateBackgroundColor()

int nbgl_screenUpdateBackgroundColor	(	uint8_t	screenIndex,
		color_t	color
	)

nbgl_screenUpdateNbElements()

int nbgl_screenUpdateNbElements	(	uint8_t	screenIndex,
		uint8_t	nbElements
	)

nbgl_screenUpdateTicker()

int nbgl_screenUpdateTicker	(	uint8_t	screenIndex,
		const nbgl_screenTickerConfiguration_t *	ticker
	)

nbgl_wait_pipeline()

void nbgl_wait_pipeline

(

void

)