2026-07-25 23:04:39 +02:00

59 lines
1.3 KiB
C

// SPDX-License-Identifier: Apache-2.0
#pragma once
#include <stdint.h>
#include <stdbool.h>
#ifdef __cplusplus
extern "C" {
#endif
/** Affects LVGL widget style */
enum UiDensity {
/** Ideal for very small non-touch screen devices (e.g. Waveshare S3 LCD 1.3") */
LVGL_UI_DENSITY_COMPACT,
/** Nothing was changed in the LVGL UI/UX */
LVGL_UI_DENSITY_DEFAULT
};
/**
* @brief Locks the LVGL mutex.
*
* This should be called before any LVGL API calls from threads other than the LVGL task.
* It is a recursive mutex.
* @retval true when a lock was acquired, false otherwise
*/
void lvgl_lock(void);
/**
* @brief Tries to lock the LVGL mutex with a timeout.
*
* @param timeout Timeout in ticks
* @return true if the lock was acquired, false otherwise.
*/
bool lvgl_try_lock(uint32_t timeout);
/**
* @brief Unlocks the LVGL mutex.
*/
void lvgl_unlock(void);
/**
* @brief Checks if the LVGL module is currently running.
*
* @return true if running, false otherwise.
*/
bool lvgl_is_running(void);
/**
* @brief Gets the desired UI density for the target hardware.
* The density is defined in the `device.properties` of a hardware device.
* This setting is read by CMakeLists.txt and passed as a target compile definition of the LVGL module.
* @return the UI density
*/
enum UiDensity lvgl_get_ui_density(void);
#ifdef __cplusplus
}
#endif