Skip to content
SFML.js

RmlUi 示例 ​

在原生 SFML 窗口中运行 RmlUi 文档。从计数器开始,再体验主题变量、拖动窗口、模板和视觉测试页面。

运行准备 ​

以下命令均在 monorepo 根目录执行。首次运行 bootstrap 安装依赖并构建各包。需要显示环境和 OpenGL;macOS 原生构建另需 Xcode Command Line Tools 和 CMake。详见快速开始。

sh
node tools/bootstrap.cjs

修改 RmlUi TypeScript 源码后,执行 npm run build:ts --prefix packages/sfml.js-rmlui。示例使用本地构建的包。

启动器读取包内 third_party/rmlui 下 RmlUi 6.3 的内置资源。列出全部入口:

sh
node packages/sfml.js-rmlui/examples/official.cjs --list

示例 ​

深色主题与任务按钮

主题与变量

主题切换、强调色和悬停样式

node packages/sfml.js-rmlui/examples/official.cjs variables

操作:1 切换深色、2 浅色、3 高对比度, R 随机强调色,C 重置强调色,Escape 退出。 任务按钮只展示悬停样式,上游没有注册点击行为。

原始样式表使用固定 px 长度。此示例设置 highDpi: false,Retina 下也保持 1024 × 768 帧缓冲, 与上游窗口尺寸一致。 F8 切换 Debugger;Ctrl +/-/0 是 Shell 的密度快捷键。

上游 RML

两个物品栏窗口

拖动教程

可移动和调整大小的物品栏窗口

node packages/sfml.js-rmlui/examples/official.cjs drag

操作:用鼠标移动两个窗口并调整大小,Escape 退出。

此处移植的是教程窗口设置,与上游 basic/drag 应用不同。

上游 RML

使用纹理装饰的教程窗口

模板教程

九宫格纹理与外部模板

node packages/sfml.js-rmlui/examples/official.cjs template

操作:查看使用模板装饰的窗口,Escape 退出。

上游 RML

上游文档和资源

文档加载

加载上游文档及原始模板、字体和纹理

node packages/sfml.js-rmlui/examples/official.cjs load-document

操作:查看加载后的文档,Escape 退出。 此入口未接入其他上游演示的应用动作。

上游 RML

自定义字体特效渲染的绿色文本

自定义字体特效

JavaScript FontEffectInstancer 与原生字形纹理回调

node packages/sfml.js-rmlui/examples/font-effect.cjs

操作:Space 切换发光效果,Escape 退出。

有限烟测:--frames N;--screenshot path.png 捕获最后一帧。

三种原生字节流来源

字节流

文件文档加载、原生内存快照与同步回调 RCSS 输入

node packages/sfml.js-rmlui/examples/streams.cjs

操作:Escape 退出。使用 --frames N --screenshot path.png 进行有限帧截图。

Stream API 与生命周期指南

原生嵌套合成、高斯模糊与定位透明度蒙版

图层合成

平衡的原生图层、预乘透明度、自合成滤镜与保存的蒙版快照

node packages/sfml.js-rmlui/examples/render-layers.cjs

操作:空格移动图形,Escape 退出。

--frames 6 --exercise --screenshot path.png 验证两个位置并截取最后一帧。

图层句柄、滤镜所有权与蒙版

RGBA 生成、自有纹理转移与原生图层快照

回调纹理

延迟预乘字节生成、自有句柄转移与裁剪区域图层快照

node packages/sfml.js-rmlui/examples/callback-textures.cjs

操作:空格重新生成颜色;Esc 退出。

--frames 6 --exercise --screenshot path.png 验证缓存和重新生成,并截图最后一帧。

提交接口、生命周期与所有权

原生输入控件实例化与 RML 子节点解析

元素工厂

自定义原生上下文和输入控件的分配与释放、自有文档流、独立标签及 Factory 缓存

node packages/sfml.js-rmlui/examples/factory-elements.cjs

操作:输入框编辑,空格更新文本,Escape 退出。

--frames 6 --exercise --screenshot path.png 验证编辑并截图最后一帧。

Factory 解析与缓存说明

元素实例器所有权

原生模型表达式与双向控件

原生数据模型

原生标量、递归 data-for、共享数组、稀疏补丁、getter 与变换求值、自定义 Factory 视图及默认双向控制器委派

node packages/sfml.js-rmlui/examples/data-models.cjs

操作:Increment 更新计数,编辑标题,切换详情,Escape 退出。

--frames 6 --exercise --screenshot path.png 验证真实绑定并截图最后一帧。

数据模型契约与剩余范围

上游事件模型和记录的鼠标位置

官方数据绑定

上游 Basics、Events、Invaders、Forms 四个模型,使用原生表达式和同步数组修改

node packages/sfml.js-rmlui/examples/official.cjs data-binding

操作:切换标签、编辑字段、记录或清除鼠标位置、增删主题、开始游戏并射击入侵者。Escape 退出。

--frames 45 --exercise --panel invaders --screenshot path.png 校验实际状态并截图指定标签。

Basics · Invaders · Forms

上游应用

原始 RML 和 RCSS 编辑器更新真实嵌套文档

官方控件与沙盒

六个原始标签页、装饰器与颜色补间、表单控件、四秒提交动画,以及实时 RML/RCSS 编辑器

node packages/sfml.js-rmlui/examples/official.cjs basic-demo

操作:切换标签页,调整补间,提交表单,编辑沙盒。Escape 先取消已打开的主题选择框,否则退出。F8 切换 Debugger。

--panel sandbox --frames 8 --exercise --screenshot path.png 验证两侧编辑器并截图沙盒。面板:welcome、decorators、font-effects、animations、controls、sandbox。

表单控件 · 窗口逻辑 · 事件监听器

上游应用

真实的上游示例目录树

官方树视图

遍历示例目录,按上游 FileBrowser 规则切换后代条目的可见性

node packages/sfml.js-rmlui/examples/official.cjs tree-view

操作:点击目录箭头展开或折叠。Escape 退出。

--frames 12 --exercise --screenshot path.png 校验真实目录的切换。

上游应用

原始变换、混合单位和过渡动画

官方动画

原始变换序列、颜色关键帧、淡入淡出循环、过渡及动画事件

node packages/sfml.js-rmlui/examples/official.cjs animation

操作:Space 暂停,Return 单步,+/- 微调,方向键触发动画,F8 切换 Debugger,Escape 退出。

--frames 8 --exercise --screenshot path.png 在截图前校验暂停、单步和点击控制。

上游应用

原始 benchmark 的路线行、范围控件和下拉选择

官方 benchmark

每次更新重新生成原始 50 行,保留独立渲染和 200 项 FPS 环形缓冲

node packages/sfml.js-rmlui/examples/official.cjs benchmark

操作:Space 暂停渲染,Down 单步渲染,Return 暂停行更新,Right 单步更新,F8 切换 Debugger,Escape 退出。

--frames 3 --screenshot path.png 限定运行帧数并截图。

上游应用

两个原生窗口中的原始拖动图标

官方拖动

在窗口间转移原生持有的图标,并调整图标顺序。

node packages/sfml.js-rmlui/examples/official.cjs basic-drag

将图标拖到另一个窗口或前面的图标上。Escape 退出。

上游应用

原始效果控件与经过滤镜处理的内容

官方效果

调整原始颜色滤镜、模糊、阴影、变换与不透明度。

node packages/sfml.js-rmlui/examples/official.cjs effects

打开菜单,调整滑块或重置设置。Escape 退出。

上游应用

原始正交投影与透视变换

官方变换

使用正交投影和透视投影旋转原始文档。

node packages/sfml.js-rmlui/examples/official.cjs transform

Space 暂停旋转,Escape 退出。

上游应用

原始 SVG 元素与装饰器

官方 SVG

渲染原始 SVG 元素、装饰器与内联内容更新。

node packages/sfml.js-rmlui/examples/official.cjs svg

使用原始更新控件。Escape 退出。

上游应用

原生 rlottie 渲染的原始山景动画

官方 Lottie

使用原生帧时序与栅格化播放原始山景动画。

node packages/sfml.js-rmlui/examples/official.cjs lottie

动画自动循环播放。Escape 退出。

上游应用

原始 Comfortaa 位图字体图集

官方位图字体

使用原始 FNT 字形步进、字距调整与原生图集纹理。

node packages/sfml.js-rmlui/examples/official.cjs bitmap-font

查看原始的三个文本段落。Escape 退出。

上游应用

原始多语言 HarfBuzz 文本塑形

官方 HarfBuzz

使用原始字体塑形英文、阿拉伯文与印地文段落。

node packages/sfml.js-rmlui/examples/official.cjs harfbuzz

点击语言按钮切换段落。Escape 退出。

上游应用

使用应用自身日志接口的原始文档

官方自定义日志

将原始原生日志消息及级别前缀写入指定文件。

node packages/sfml.js-rmlui/examples/official.cjs custom-log --log-file /tmp/rmlui-log.txt

默认日志位于系统临时目录。Escape 退出。

上游应用

包含表情与八种语言文本的原始 IME 表单

官方 IME

加载全部十个原始字体,打开原生输入框与多行文本框。

首次准备五个可选 Noto 字体(38 MB,校验 SHA-256):npm run download:ime-fonts --prefix packages/sfml.js-rmlui。已校验的缓存直接复用。

node packages/sfml.js-rmlui/examples/official.cjs ime

选择系统输入法,然后聚焦任一输入框。Escape 退出。

上游应用

原版 Invaders 阵型、掩体、战机和原生状态栏

Invaders

运行原始 C++ 游戏、菜单、装饰器和高分榜数据模型。

node packages/sfml.js-rmlui/examples/official.cjs invaders

左右键移动,空格开火,Escape 打开暂停菜单,F8 切换 Debugger。通过原始菜单重开或退出。

先构建包;游戏模块在同一个构建目录中生成,加载时无需编译器。macOS 已验证;Linux 和 Windows 实际执行仍待验证。

高分保存到应用数据目录。--scores-file /absolute/path/scores.txt 指定已有父目录中的文件。--frames 8 --exercise 启动限帧游戏。

原生注册 · 上游应用

原版 Lua Invaders 游戏的原生阵型和分数显示

Lua Invaders

原始 Lua 文档和 Game 表驱动原始原生游戏。

node packages/sfml.js-rmlui/examples/official.cjs lua-invaders

左右键移动,空格开火,Escape 打开暂停菜单,F8 切换 Debugger。设置保存到所选高分文件的同目录。

先构建包;游戏模块在同一个构建目录中生成,加载时无需编译器。macOS 已验证;Linux 和 Windows 实际执行仍待验证。

--scores-file /absolute/path/scores.txt 指定已有父目录中的文件。--frames 8 --exercise 启动限帧游戏。

原生注册 · 上游应用和脚本

裁剪遮罩视觉测试

VisualTests 浏览器

浏览 113 个上游视觉测试页面

node packages/sfml.js-rmlui/examples/official.cjs visual/clip_mask

操作:F6/F7 切换页面,Escape 退出。

在命令后追加 --frames 60 可在 60 帧后关闭窗口。 --frames N 接受正整数,便于限定时长的冒烟检查。 这里提供预览,未接入上游断言框架。

上游 VisualTests · 渲染覆盖范围

113 页 VisualTests 断言、真实 IME 检查、游戏的剩余平台工作及全项目独立验收仍待完成。渲染器与模块检查分别保留在对应指南的证据中。截图均来自实际运行的原生应用。

全部示例 · RmlUi 快速开始 · 上游示例

Icons made by Lorc, Delapouite & Skoll game-icons.net · CC BY 3.0