xref: /DragonOS/docs/kernel/libs/lib_ui/scm.md (revision 0102d69fdd231e472d7bb3d609a41ae56a3799ee)
1# 屏幕管理器(SCM)
2
3:::{note}
4作者: 周瀚杰 <2625553453@qq.com>
5:::
6&emsp;&emsp;屏幕管理器用来管理控制所有ui框架,所有框架都必须先在屏幕管理器中注册才可使用,然后scm控制当前是哪个ui框架在使用
7
8## traits
9
10### ScmUiFramework
11&emsp;&emsp;每个要注册到scm中的ui框架都必须实现这个trait中的方法,具体定义如下:
12```rust
13pub trait ScmUiFramework: Sync + Send + Debug {
14    // 安装ui框架的回调函数
15    fn install(&self) -> Result<i32, SystemError> {
16        return Err(SystemError::ENOSYS);
17    }
18    // 卸载ui框架的回调函数
19    fn uninstall(&self) -> Result<i32, SystemError> {
20        return Err(SystemError::ENOSYS);
21    }
22    // 启用ui框架的回调函数
23    fn enable(&self) -> Result<i32, SystemError> {
24        return Err(SystemError::ENOSYS);
25    }
26    // 禁用ui框架的回调函数
27    fn disable(&self) -> Result<i32, SystemError> {
28        return Err(SystemError::ENOSYS);
29    }
30    // 改变ui框架的帧缓冲区的回调函数
31    fn change(&self, _buf: ScmBufferInfo) -> Result<i32, SystemError> {
32        return Err(SystemError::ENOSYS);
33    }
34    /// @brief 获取ScmUiFramework的元数据
35    /// @return 成功:Ok(ScmUiFramework的元数据)
36    ///         失败:Err(错误码)
37    fn metadata(&self) -> Result<ScmUiFrameworkMetadata, SystemError> {
38        // 若文件系统没有实现此方法,则返回“不支持”
39        return Err(SystemError::ENOSYS);
40    }
41}
42```
43## 主要API
44### scm_init() -初始化屏幕管理模块
45#### 原型
46```rust
47pub extern "C" fn scm_init()
48```
49#### 说明
50&emsp;&emsp;scm_init()主要是初始化一些scm中使用的全局变量,例如是否使用双缓冲区标志位,textui未初始化时使用的一些全局变量
51
52### scm_reinit() -当内存管理单元被初始化之后,重新初始化屏幕管理模块
53#### 原型
54```rust
55pub extern "C" fn scm_reinit() -> i32
56```
57#### 说明
58&emsp;&emsp;scm_reinit()用于当内存管理单元被初始化之后,重新处理帧缓冲区问题
59
60### scm_enable_double_buffer() -允许双缓冲区
61#### 原型
62```rust
63pub extern "C" fn scm_enable_double_buffer() -> i32
64```
65#### 说明
66&emsp;&emsp;scm_enable_double_buffer()用于启动双缓冲来往窗口输出打印信息。启用后,往窗口输出的信息会暂时放在一个缓冲区中,然后每次按一定时间将该缓冲区的信息输出到窗口帧缓冲区中,渲染显示到窗口上。
67
68### scm_framework_enable() -启用某个ui框架,将它的帧缓冲区渲染到屏幕上
69#### 原型
70```rust
71pub fn scm_framework_enable(framework: Arc<dyn ScmUiFramework>) -> Result<i32, SystemError>
72```
73#### 说明
74&emsp;&emsp;scm_framework_enable用于启用某个ui框架,将它的帧缓冲区渲染到屏幕上
75
76
77### scm_register() -向屏幕管理器注册UI框架
78#### 原型
79```rust
80pub fn scm_register(framework: Arc<dyn ScmUiFramework>) -> Result<i32, SystemError>
81```
82#### 说明
83&emsp;&emsp;scm_register用于将ui框架注册到scm中,主要是调用ui框架的回调函数以安装ui框架,并将其激活
84