2021-10-03 13:36:05 +03:00
|
|
|
/**
|
|
|
|
* @file gui.h
|
|
|
|
* GUI: main API
|
|
|
|
*/
|
|
|
|
|
Display and UI implementation (#169)
* Menu app. Lib: add mlib submodule.
* Menu: new startup lib dependency definition
* Menu: hierarchy in menu. Cube: fix heap1/4 inconsistency, stack protection.
* GUI: rendering pipeline initial version.
* GUI: layered widget composing, FURI record. Menu: FURI record, api.
* GUI: input dispatching. Menu: switch to input from GUI.
* GUI, MENU: code style cleanup, fix type conversion warnings.
* GUI, Menu: syntax check.
* Makefile: check and reinit submodules, format.
* Menu: lock on event processing. Makefile: proper submodule initialization.
* Menu: fix stack corruption by queue.
* GUI: refactor.
* Makefile: format rule fix, st-util pid.
* GUI, Menu, FURI: format with clang-format.
* GUI, MENU: locks in critical sections, fix stack corruption, ready signaling.
* Makefile: clang format rule cleanup.
* GUI,MENU: migrate to new API.
* Applications: PRODUCTION_HW variable, skip drivers build on local target.
* refactor production build
* add git to dockerfile
* GUI: uncomment lock block
Co-authored-by: Aleksandr Kutuzov <aku@plooks.com>
2020-10-14 13:21:55 +03:00
|
|
|
#pragma once
|
|
|
|
|
2021-01-29 16:52:16 +03:00
|
|
|
#include "view_port.h"
|
2020-10-15 18:05:28 +03:00
|
|
|
#include "canvas.h"
|
Display and UI implementation (#169)
* Menu app. Lib: add mlib submodule.
* Menu: new startup lib dependency definition
* Menu: hierarchy in menu. Cube: fix heap1/4 inconsistency, stack protection.
* GUI: rendering pipeline initial version.
* GUI: layered widget composing, FURI record. Menu: FURI record, api.
* GUI: input dispatching. Menu: switch to input from GUI.
* GUI, MENU: code style cleanup, fix type conversion warnings.
* GUI, Menu: syntax check.
* Makefile: check and reinit submodules, format.
* Menu: lock on event processing. Makefile: proper submodule initialization.
* Menu: fix stack corruption by queue.
* GUI: refactor.
* Makefile: format rule fix, st-util pid.
* GUI, Menu, FURI: format with clang-format.
* GUI, MENU: locks in critical sections, fix stack corruption, ready signaling.
* Makefile: clang format rule cleanup.
* GUI,MENU: migrate to new API.
* Applications: PRODUCTION_HW variable, skip drivers build on local target.
* refactor production build
* add git to dockerfile
* GUI: uncomment lock block
Co-authored-by: Aleksandr Kutuzov <aku@plooks.com>
2020-10-14 13:21:55 +03:00
|
|
|
|
[FL-140] Core api dynamic records (#296)
* SYSTEM: tickless mode with deep sleep.
* Move FreeRTOS ticks to lptim2
* API: move all sumbodules init routines to one place. Timebase: working lptim2 at tick source.
* API Timebase: lp-timer routines, timer access safe zones prediction and synchronization. FreeRTOS: adjust configuration for tickless mode.
* NFC: support for tickless mode.
* API Timebase: improve tick error handling in IRQ. Apploader: use insomnia mode to run applications.
* BLE: prevent sleep while core2 starting
* HAL: nap while in insomnia mode
* init records work
* try to implement record delete
* tests and flapp
* flapp subsystem
* new core functions to get app stat, simplify core code
* fix thread termination
* add strdup to core
* fix tests
* Refactoring: remove all unusued parts, update API usage, aggreagate API sources and headers, new record storage
* Refactoring: update furi record api usage, cleanup code
* Fix broken merge for freertos apps
* Core, Target: fix compilation warnings
* Drop firmware target local
* HAL Timebase, Power, Clock: semaphore guarded access to clock and power modes, better sleep mode.
* SD-Filesystem: wait for all deps to arrive before adding widget. Core, BLE: disable debug dump to serial.
* delete old app example-ipc
* delete old app fatfs list
* fix strobe app, add input header
* delete old display driver
* comment old app qr-code
* fix sd-card test, add forced widget update
* remove unused new core test
* increase heap to 128k
* comment and assert old core tests
* fix syntax
Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>
2021-01-20 19:09:26 +03:00
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
2021-10-03 13:36:05 +03:00
|
|
|
/** Gui layers */
|
2020-10-15 11:32:48 +03:00
|
|
|
typedef enum {
|
2021-11-24 19:21:12 +03:00
|
|
|
GuiLayerDesktop, /**< Desktop layer for internal use. Like fullscreen but with status bar */
|
|
|
|
|
|
|
|
GuiLayerWindow, /**< Window layer, status bar is shown */
|
Display and UI implementation (#169)
* Menu app. Lib: add mlib submodule.
* Menu: new startup lib dependency definition
* Menu: hierarchy in menu. Cube: fix heap1/4 inconsistency, stack protection.
* GUI: rendering pipeline initial version.
* GUI: layered widget composing, FURI record. Menu: FURI record, api.
* GUI: input dispatching. Menu: switch to input from GUI.
* GUI, MENU: code style cleanup, fix type conversion warnings.
* GUI, Menu: syntax check.
* Makefile: check and reinit submodules, format.
* Menu: lock on event processing. Makefile: proper submodule initialization.
* Menu: fix stack corruption by queue.
* GUI: refactor.
* Makefile: format rule fix, st-util pid.
* GUI, Menu, FURI: format with clang-format.
* GUI, MENU: locks in critical sections, fix stack corruption, ready signaling.
* Makefile: clang format rule cleanup.
* GUI,MENU: migrate to new API.
* Applications: PRODUCTION_HW variable, skip drivers build on local target.
* refactor production build
* add git to dockerfile
* GUI: uncomment lock block
Co-authored-by: Aleksandr Kutuzov <aku@plooks.com>
2020-10-14 13:21:55 +03:00
|
|
|
|
2021-10-03 13:36:05 +03:00
|
|
|
GuiLayerStatusBarLeft, /**< Status bar left-side layer, auto-layout */
|
|
|
|
GuiLayerStatusBarRight, /**< Status bar right-side layer, auto-layout */
|
2021-11-24 19:21:12 +03:00
|
|
|
|
|
|
|
GuiLayerFullscreen, /**< Fullscreen layer, no status bar */
|
2020-10-26 20:00:17 +03:00
|
|
|
|
2021-10-03 13:36:05 +03:00
|
|
|
GuiLayerMAX /**< Don't use or move, special value */
|
2020-10-26 20:00:17 +03:00
|
|
|
} GuiLayer;
|
Display and UI implementation (#169)
* Menu app. Lib: add mlib submodule.
* Menu: new startup lib dependency definition
* Menu: hierarchy in menu. Cube: fix heap1/4 inconsistency, stack protection.
* GUI: rendering pipeline initial version.
* GUI: layered widget composing, FURI record. Menu: FURI record, api.
* GUI: input dispatching. Menu: switch to input from GUI.
* GUI, MENU: code style cleanup, fix type conversion warnings.
* GUI, Menu: syntax check.
* Makefile: check and reinit submodules, format.
* Menu: lock on event processing. Makefile: proper submodule initialization.
* Menu: fix stack corruption by queue.
* GUI: refactor.
* Makefile: format rule fix, st-util pid.
* GUI, Menu, FURI: format with clang-format.
* GUI, MENU: locks in critical sections, fix stack corruption, ready signaling.
* Makefile: clang format rule cleanup.
* GUI,MENU: migrate to new API.
* Applications: PRODUCTION_HW variable, skip drivers build on local target.
* refactor production build
* add git to dockerfile
* GUI: uncomment lock block
Co-authored-by: Aleksandr Kutuzov <aku@plooks.com>
2020-10-14 13:21:55 +03:00
|
|
|
|
2021-10-03 13:36:05 +03:00
|
|
|
/** Gui Canvas Commit Callback */
|
2021-02-13 14:40:20 +03:00
|
|
|
typedef void (*GuiCanvasCommitCallback)(uint8_t* data, size_t size, void* context);
|
|
|
|
|
2022-07-26 15:21:51 +03:00
|
|
|
#define RECORD_GUI "gui"
|
|
|
|
|
2020-12-14 13:50:32 +03:00
|
|
|
typedef struct Gui Gui;
|
|
|
|
|
2021-10-03 13:36:05 +03:00
|
|
|
/** Add view_port to view_port tree
|
|
|
|
*
|
|
|
|
* @remark thread safe
|
|
|
|
*
|
|
|
|
* @param gui Gui instance
|
|
|
|
* @param view_port ViewPort instance
|
|
|
|
* @param[in] layer GuiLayer where to place view_port
|
2020-12-14 13:50:32 +03:00
|
|
|
*/
|
2021-01-29 16:52:16 +03:00
|
|
|
void gui_add_view_port(Gui* gui, ViewPort* view_port, GuiLayer layer);
|
2020-12-14 13:50:32 +03:00
|
|
|
|
2021-10-03 13:36:05 +03:00
|
|
|
/** Remove view_port from rendering tree
|
|
|
|
*
|
|
|
|
* @remark thread safe
|
|
|
|
*
|
|
|
|
* @param gui Gui instance
|
|
|
|
* @param view_port ViewPort instance
|
2020-12-14 13:50:32 +03:00
|
|
|
*/
|
2021-01-29 16:52:16 +03:00
|
|
|
void gui_remove_view_port(Gui* gui, ViewPort* view_port);
|
[FL-140] Core api dynamic records (#296)
* SYSTEM: tickless mode with deep sleep.
* Move FreeRTOS ticks to lptim2
* API: move all sumbodules init routines to one place. Timebase: working lptim2 at tick source.
* API Timebase: lp-timer routines, timer access safe zones prediction and synchronization. FreeRTOS: adjust configuration for tickless mode.
* NFC: support for tickless mode.
* API Timebase: improve tick error handling in IRQ. Apploader: use insomnia mode to run applications.
* BLE: prevent sleep while core2 starting
* HAL: nap while in insomnia mode
* init records work
* try to implement record delete
* tests and flapp
* flapp subsystem
* new core functions to get app stat, simplify core code
* fix thread termination
* add strdup to core
* fix tests
* Refactoring: remove all unusued parts, update API usage, aggreagate API sources and headers, new record storage
* Refactoring: update furi record api usage, cleanup code
* Fix broken merge for freertos apps
* Core, Target: fix compilation warnings
* Drop firmware target local
* HAL Timebase, Power, Clock: semaphore guarded access to clock and power modes, better sleep mode.
* SD-Filesystem: wait for all deps to arrive before adding widget. Core, BLE: disable debug dump to serial.
* delete old app example-ipc
* delete old app fatfs list
* fix strobe app, add input header
* delete old display driver
* comment old app qr-code
* fix sd-card test, add forced widget update
* remove unused new core test
* increase heap to 128k
* comment and assert old core tests
* fix syntax
Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>
2021-01-20 19:09:26 +03:00
|
|
|
|
2021-10-03 13:36:05 +03:00
|
|
|
/** Send ViewPort to the front
|
|
|
|
*
|
2021-02-10 12:06:29 +03:00
|
|
|
* Places selected ViewPort to the top of the drawing stack
|
2021-10-03 13:36:05 +03:00
|
|
|
*
|
|
|
|
* @param gui Gui instance
|
|
|
|
* @param view_port ViewPort instance
|
2021-02-10 12:06:29 +03:00
|
|
|
*/
|
2021-10-06 18:41:22 +03:00
|
|
|
void gui_view_port_send_to_front(Gui* gui, ViewPort* view_port);
|
2021-02-10 12:06:29 +03:00
|
|
|
|
2021-10-03 13:36:05 +03:00
|
|
|
/** Send ViewPort to the back
|
|
|
|
*
|
2021-02-10 12:06:29 +03:00
|
|
|
* Places selected ViewPort to the bottom of the drawing stack
|
2021-10-03 13:36:05 +03:00
|
|
|
*
|
|
|
|
* @param gui Gui instance
|
|
|
|
* @param view_port ViewPort instance
|
2021-02-10 12:06:29 +03:00
|
|
|
*/
|
2021-10-06 18:41:22 +03:00
|
|
|
void gui_view_port_send_to_back(Gui* gui, ViewPort* view_port);
|
2021-02-10 12:06:29 +03:00
|
|
|
|
2022-03-17 12:44:54 +03:00
|
|
|
/** Add gui canvas commit callback
|
2021-10-03 13:36:05 +03:00
|
|
|
*
|
|
|
|
* This callback will be called upon Canvas commit Callback dispatched from GUI
|
|
|
|
* thread and is time critical
|
|
|
|
*
|
|
|
|
* @param gui Gui instance
|
|
|
|
* @param callback GuiCanvasCommitCallback
|
2021-11-01 19:26:37 +03:00
|
|
|
* @param context GuiCanvasCommitCallback context
|
2021-02-13 14:40:20 +03:00
|
|
|
*/
|
2022-03-17 12:44:54 +03:00
|
|
|
void gui_add_framebuffer_callback(Gui* gui, GuiCanvasCommitCallback callback, void* context);
|
2021-02-13 14:40:20 +03:00
|
|
|
|
2022-03-17 12:44:54 +03:00
|
|
|
/** Remove gui canvas commit callback
|
2022-03-16 11:52:11 +03:00
|
|
|
*
|
|
|
|
* @param gui Gui instance
|
2022-03-17 12:44:54 +03:00
|
|
|
* @param callback GuiCanvasCommitCallback
|
|
|
|
* @param context GuiCanvasCommitCallback context
|
|
|
|
*/
|
|
|
|
void gui_remove_framebuffer_callback(Gui* gui, GuiCanvasCommitCallback callback, void* context);
|
|
|
|
|
|
|
|
/** Get gui canvas frame buffer size
|
|
|
|
* *
|
|
|
|
* @param gui Gui instance
|
|
|
|
* @return size_t size of frame buffer in bytes
|
2022-03-16 11:52:11 +03:00
|
|
|
*/
|
2022-03-17 12:44:54 +03:00
|
|
|
size_t gui_get_framebuffer_size(Gui* gui);
|
2022-03-16 11:52:11 +03:00
|
|
|
|
2022-01-29 14:20:55 +03:00
|
|
|
/** Set lockdown mode
|
|
|
|
*
|
|
|
|
* When lockdown mode is enabled, only GuiLayerDesktop is shown.
|
|
|
|
* This feature prevents services from showing sensitive information when flipper is locked.
|
|
|
|
*
|
|
|
|
* @param gui Gui instance
|
|
|
|
* @param lockdown bool, true if enabled
|
|
|
|
*/
|
|
|
|
void gui_set_lockdown(Gui* gui, bool lockdown);
|
|
|
|
|
2022-12-29 14:35:26 +03:00
|
|
|
/** Acquire Direct Draw lock and get Canvas instance
|
|
|
|
*
|
|
|
|
* This method return Canvas instance for use in monopoly mode. Direct draw lock
|
|
|
|
* disables input and draw call dispatch functions in GUI service. No other
|
|
|
|
* applications or services will be able to draw until gui_direct_draw_release
|
|
|
|
* call.
|
|
|
|
*
|
|
|
|
* @param gui The graphical user interface
|
|
|
|
*
|
|
|
|
* @return Canvas instance
|
|
|
|
*/
|
|
|
|
Canvas* gui_direct_draw_acquire(Gui* gui);
|
|
|
|
|
|
|
|
/** Release Direct Draw Lock
|
|
|
|
*
|
|
|
|
* Release Direct Draw Lock, enables Input and Draw call processing. Canvas
|
|
|
|
* acquired in gui_direct_draw_acquire will become invalid after this call.
|
|
|
|
*
|
|
|
|
* @param gui Gui instance
|
|
|
|
*/
|
|
|
|
void gui_direct_draw_release(Gui* gui);
|
|
|
|
|
[FL-140] Core api dynamic records (#296)
* SYSTEM: tickless mode with deep sleep.
* Move FreeRTOS ticks to lptim2
* API: move all sumbodules init routines to one place. Timebase: working lptim2 at tick source.
* API Timebase: lp-timer routines, timer access safe zones prediction and synchronization. FreeRTOS: adjust configuration for tickless mode.
* NFC: support for tickless mode.
* API Timebase: improve tick error handling in IRQ. Apploader: use insomnia mode to run applications.
* BLE: prevent sleep while core2 starting
* HAL: nap while in insomnia mode
* init records work
* try to implement record delete
* tests and flapp
* flapp subsystem
* new core functions to get app stat, simplify core code
* fix thread termination
* add strdup to core
* fix tests
* Refactoring: remove all unusued parts, update API usage, aggreagate API sources and headers, new record storage
* Refactoring: update furi record api usage, cleanup code
* Fix broken merge for freertos apps
* Core, Target: fix compilation warnings
* Drop firmware target local
* HAL Timebase, Power, Clock: semaphore guarded access to clock and power modes, better sleep mode.
* SD-Filesystem: wait for all deps to arrive before adding widget. Core, BLE: disable debug dump to serial.
* delete old app example-ipc
* delete old app fatfs list
* fix strobe app, add input header
* delete old display driver
* comment old app qr-code
* fix sd-card test, add forced widget update
* remove unused new core test
* increase heap to 128k
* comment and assert old core tests
* fix syntax
Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>
2021-01-20 19:09:26 +03:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|