Zayden-Jung/endorphin-tessera-gui
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: explain source paint lifecycle and software composition

Browse Source
This commit is contained in:
Codex Bot
2026-11-12 18:54:25 +08:00
parent b18d56c439
commit ac6cc82b0e
2 changed files with 140 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/render/software_renderer.rs
+72
View File
@@ -8,6 +8,7 @@ use crate::{
};
/// 显示列表的 CPU 执行入口，错误在原生 present 前向上传递。
// shell 的窗口呈现和 scene3d::panel 的离屏纹理都使用同一执行器，输入是已转换到目标像素空间的 DisplayList。
pub struct SoftwareRenderer;
// 预算按渲染线程维护，递归 3D/面板渲染共用同一组计数；不同线程之间不共享额度。
@@ -19,8 +20,10 @@ thread_local! {
pub(crate) struct RenderScope;
impl RenderScope {
/// 进入一次嵌套渲染并检查深度上限；最外层调用重新开始累计像素预算。
// SoftwareRenderer::render 与 scene3d::render_aspect 每次进入都建立作用域，面板中的嵌套视口继续累计。
pub fn enter() -> Result<Self, &'static str> {
RENDER_DEPTH.with(|depth| {
// 先读取进入前深度；拒绝分支不递增，因此不会产生没有配对 Guard 的计数。
let current = depth.get();
// 拒绝第 19 层进入，不先增加深度；成功返回的 RenderScope 析构时才对应减一。
if current >= 18 {
@@ -30,6 +33,7 @@ impl RenderScope {
if current == 0 {
PIXEL_UNITS.with(|pixels| pixels.set(0));
}
// 仅成功进入后递增；返回的 RenderScope 析构时归还这一层。
depth.set(current + 1);
Ok(Self)
})
@@ -42,10 +46,12 @@ impl Drop for RenderScope {
}
}
/// 累加本帧中间表面工作量，超过预算立即返回错误。
// 3D 颜色/深度缓冲和 UI 面板纹理分配前调用；普通目标缓冲由外层分配，不在这里自动计入。
pub(crate) fn reserve_pixels(units: usize) -> Result<(), &'static str> {
PIXEL_UNITS.with(|pixels| {
// 累计申请工作量而非当前存活像素；释放一个中间表面不会返还额度，饱和加法避免溢出绕过限制。
let next = pixels.get().saturating_add(units);
// 超额时不提交 next，错误向上传递结束本次离屏绘制；预算不是可释放再循环使用的内存额度。
if next > 16_777_216 {
return Err("nested render pixel budget exceeded");
}
@@ -56,6 +62,7 @@ pub(crate) fn reserve_pixels(units: usize) -> Result<(), &'static str> {
impl SoftwareRenderer {
/// 顺序执行显示列表并维护裁剪栈；3D 和面板可递归进入同一渲染预算域。
// 外部窗口和离屏面板调用；此函数不重新验证全部命令，也不负责创建或调整 target 长度。
pub fn render(
list: &DisplayList,
target: &mut [u32],
@@ -64,15 +71,19 @@ impl SoftwareRenderer {
) -> Result<(), &'static str> {
// RAII 保护让成功、提前返回和错误传播都恢复深度；target 长度须由调用方保证至少 width×height。
let _scope = RenderScope::enter()?;
// 借用传入像素缓冲建立当前画布，初始 clip 是整张目标；后续命令只修改画布状态或像素。
let mut canvas = Canvas {
pixels: target,
width,
height,
clip: Rect::new(0.0, 0.0, width as f32, height as f32),
};
// 保存 PushClip 之前的裁剪，PopClip 恢复上一层；栈只在本次 render 内存活。
let mut clips = Vec::new();
// 严格按列表顺序执行，后续不透明命令覆盖已有像素，透明命令与当时像素混合。
for command in list.commands() {
// 图像和 3D 各有专用采样路径，其余变体转交 Canvas；坐标不再经过布局或页面相机。
match command {
DrawCommand::Image {
image,
@@ -82,6 +93,7 @@ impl SoftwareRenderer {
opacity,
tint,
} => {
// 图像旋转与透明度在 draw_image 中处理；这里仅解引用命令字段，保持共享图像资源。
canvas.draw_image(image, *origin, *rect, *angle, *opacity, *tint);
}
DrawCommand::Scene3D { rect, view } => {
@@ -98,15 +110,20 @@ impl SoftwareRenderer {
.min(height as f32)
.ceil()
.max(0.) as u32;
// 交集为空或原矩形退化时直接跳过，避免申请无用 3D 表面并发生归一化除零。
if left >= right || top >= bottom || rect.width <= 0. || rect.height <= 0. {
continue;
}
// 3D 中间表面的最长边限制到约 2048 像素，再采样到请求尺寸；相机宽高比仍用原 rect，避免改变透视比例。
let lod = (2048. / rect.width.max(rect.height)).min(1.);
// 按同一 lod 求两个输出轴并向上取整至少一个像素；rect 宽高仍决定相机 aspect。
let w = (rect.width * lod).ceil().max(1.) as u32;
let h = (rect.height * lod).ceil().max(1.) as u32;
// 获取不可变缓存像素，光栅化或预算错误立即传播；已经写入 target 的其他命令不会自动回滚。
let surface = crate::scene3d::surface(view, w, h, rect.width / rect.height)?;
// 只遍历裁剪可见的目标行列，来源坐标按完整 rect 映射而不是按裁剪交集重新拉伸。
for y in top..bottom {
// 目标像素中心在低分辨率 3D 表面上取最近邻，LOD 改变采样密度而非布局位置。
for x in left..right {
// 按目标像素中心反算纹理坐标并钳到有效表面边界；只复制可见区域，不循环整个放大矩形。
let u = (((x as f32 + 0.5 - rect.x) / rect.width) * w as f32)
@@ -124,6 +141,7 @@ impl SoftwareRenderer {
DrawCommand::PushClip(rect) => {
// 先保存旧裁剪，再求交；嵌套 PushClip 只能收窄，矩形分离时宽高归零。
clips.push(canvas.clip);
// 以两个左上边界较大值为交集起点，右下边界较小值再钳到起点，确保非负尺寸。
let x = canvas.clip.x.max(rect.x);
let y = canvas.clip.y.max(rect.y);
canvas.clip = Rect::new(
@@ -145,6 +163,7 @@ impl SoftwareRenderer {
canvas.clip = clip;
}
}
// Clear 忽略 clip 填满整个切片；生成显示列表时应避免在局部子树中随意插入清屏。
DrawCommand::Clear(color) => canvas.clear(*color),
DrawCommand::FillRoundedRect {
rect,
@@ -177,15 +196,18 @@ impl SoftwareRenderer {
/// 借用目标像素切片并维护当前裁剪；图形/文字受裁剪，Clear 明确填满整个目标。
struct Canvas<'a> {
// 原地写入的不透明 0xRRGGBB 目标，生命周期只覆盖一次 render 调用。
pixels: &'a mut [u32],
width: u32,
height: u32,
// 当前目标空间矩形裁剪；图形扫描先收窄范围，blend_pixel 再检查最终像素坐标。
clip: Rect,
}
impl Canvas<'_> {
/// Inverse-map only clipped destination pixels. Images use straight RGBA;
/// bilinear interpolation happens in premultiplied alpha to avoid dark halos.
// render 的 Image 分支调用；对目标可见像素做逆旋转映射，避免正向散点产生空洞。
fn draw_image(
&mut self,
image: &crate::render::image::Image,
@@ -195,9 +217,11 @@ impl Canvas<'_> {
opacity: f32,
tint: Option<Color>,
) {
// 退化尺寸或非有限旋转/透明度没有可用映射；直接返回且不改变像素。
if rect.width <= 0. || rect.height <= 0. || !angle.is_finite() || !opacity.is_finite() {
return;
}
// angle 是弧度；四个局部矩形角旋转后求目标包围盒，用于限制扫描范围。
let (sin, cos) = angle.sin_cos();
let corners = [
(rect.x, rect.y),
@@ -205,8 +229,10 @@ impl Canvas<'_> {
(rect.x, rect.y + rect.height),
(rect.x + rect.width, rect.y + rect.height),
];
// 最小值从正无穷、最大值从负无穷初始化，确保首个角点建立真实范围，不误含原点。
let mut lo = Point::new(f32::INFINITY, f32::INFINITY);
let mut hi = Point::new(f32::NEG_INFINITY, f32::NEG_INFINITY);
// 绕命令 origin 旋转局部角点；rect.x/y 仍是相对该 origin 的偏移。
for (x, y) in corners {
let px = origin.x + cos * x - sin * y;
let py = origin.y + sin * x + cos * y;
@@ -215,16 +241,23 @@ impl Canvas<'_> {
hi.x = hi.x.max(px);
hi.y = hi.y.max(py);
}
// 旋转后的轴对齐包围盒还可能包含矩形外部像素，下面的 u/v 范围判断继续排除。
let (left, top, right, bottom) =
self.clamped_bounds(Rect::new(lo.x, lo.y, hi.x - lo.x, hi.y - lo.y));
// 只扫描包围盒与当前 clip/画布的交集，不按原始图像分辨率遍历。
for y in top..bottom {
for x in left..right {
// 目标像素中心先减 origin，再乘反向旋转矩阵，恢复局部矩形坐标。
let dx = x as f32 + 0.5 - origin.x;
let dy = y as f32 + 0.5 - origin.y;
// 减去局部 rect 原点并除宽高，得到采样函数接受的归一化纹理位置。
let u = (cos * dx + sin * dy - rect.x) / rect.width;
let v = (-sin * dx + cos * dy - rect.y) / rect.height;
// 旋转包围盒内但局部矩形外的点不能采样；右/下边界为开区间。
if (0. ..1.).contains(&u) && (0. ..1.).contains(&v) {
// 图像采样内部在预乘 alpha 空间插值，返回非预乘颜色供 blend_pixel 合成；整体透明度钳到 [0,1]。
let mut sample = image.sample(u, v, opacity.clamp(0., 1.));
// 有 tint 时替换 RGB 而保留采样 alpha，把图像当作覆盖遮罩使用，不逐通道乘原图颜色。
if let Some(tint) = tint {
sample.red = tint.red;
sample.green = tint.green;
@@ -237,18 +270,23 @@ impl Canvas<'_> {
}
/// 用不透明 RGB 填满目标切片；此命令忽略当前裁剪和输入颜色 alpha。
// render 的 Clear 分支调用；target 若大于 width×height，这里也会填满额外切片，因此调用方应传精确缓冲。
fn clear(&mut self, color: Color) {
// Clear 填整个提供的目标切片，不受当前 clip 约束；pack 忽略 alpha，清屏色作为不透明 RGB。
self.pixels.fill(pack(color));
}
/// 只遍历裁剪后的矩形像素，按圆角覆盖决定填充区域。
// render 的 FillRoundedRect 分支调用；圆角内像素交给 blend_pixel，统一透明度与边界判断。
fn fill_rounded_rect(&mut self, rect: Rect, radius: f32, color: Color) {
// 先求保守整数扫描范围，随后按浮点像素中心精确判断圆角形状。
let bounds = self.clamped_bounds(rect);
// 半径钳到非负且不超过半宽/半高；后续用像素中心判定圆角内外，不做边缘面积覆盖积分。
let radius = radius.max(0.0).min(rect.width / 2.0).min(rect.height / 2.0);
// bounds 顺序为 left/top/right/bottom，使用左闭右开的整数扫描区间。
for y in bounds.1..bounds.3 {
for x in bounds.0..bounds.2 {
// 只有落在圆角形状内才混合；clip 外的候选即使被保守范围包含也会被 blend_pixel 拒绝。
if rounded_rect_contains(rect, radius, x as f32 + 0.5, y as f32 + 0.5) {
self.blend_pixel(x, y, color);
}
@@ -257,10 +295,12 @@ impl Canvas<'_> {
}
/// 用外轮廓与内轮廓的差绘制边框，避免把边框当成整个矩形填充。
// render 的 StrokeRoundedRect 分支调用；边框占据外圆角形状减去内圆角形状的区域。
fn stroke_rounded_rect(&mut self, rect: Rect, radius: f32, width: f32, color: Color) {
let bounds = self.clamped_bounds(rect);
// 描边请求先至少一单位再限制为半宽/半高；inner 从四边缩入，最终绘制外轮廓减内轮廓。
let width = width.max(1.0).min(rect.width / 2.0).min(rect.height / 2.0);
// 外半径受矩形半尺寸限制，内半径稍后扣描边宽并钳到零。
let outer_radius = radius.max(0.0).min(rect.width / 2.0).min(rect.height / 2.0);
let inner = Rect::new(
rect.x + width,
@@ -268,12 +308,16 @@ impl Canvas<'_> {
(rect.width - width * 2.0).max(0.0),
(rect.height - width * 2.0).max(0.0),
);
// 内轮廓与缩进矩形配套；宽描边把内区缩到零时，内轮廓判定返回 false。
let inner_radius = (outer_radius - width).max(0.0);
// 只扫描外框包围盒，逐像素以同一中心采样比较外内形状。
for y in bounds.1..bounds.3 {
for x in bounds.0..bounds.2 {
// 像素中心坐标复用于外轮廓和内轮廓，避免两次判定使用不同采样约定。
let px = x as f32 + 0.5;
let py = y as f32 + 0.5;
// 外形内且内形外才属于描边；内部填充区域保持已有目标颜色。
if rounded_rect_contains(rect, outer_radius, px, py)
&& !rounded_rect_contains(inner, inner_radius, px, py)
{
@@ -284,6 +328,7 @@ impl Canvas<'_> {
}
/// 把文字原点转换为局部裁剪区域，交给有界字形绘制，再混合到目标缓冲。
// render 的 Text 分支调用；字形覆盖由 text 模块产生，本模块只处理目标位置、clip 和混合。
fn draw_text(&mut self, origin: Point, value: &str, style: TextStyle, color: Color) {
// 将文字原点对齐整数像素；转换 clip 到字形局部空间，回调再加原点写回目标。
let x = origin.x.round() as i32;
@@ -294,13 +339,16 @@ impl Canvas<'_> {
self.clip.width,
self.clip.height,
);
// None 表示没有段落换行宽度；回调收到字形局部像素，平移后仍经 blend_pixel 检查目标边界。
text::draw_clipped(value, style, color, None, clip, |dx, dy, pixel| {
self.blend_pixel(x + dx, y + dy, pixel)
});
}
/// 把段落矩形与当前裁剪相交，按受限宽度绘制，再恢复外层裁剪。
// render 的 WrappedText 分支调用；与普通文字共用字形路径，但临时加上段落框裁剪。
fn draw_wrapped_text(&mut self, rect: Rect, value: &str, style: TextStyle, color: Color) {
// 空段落框直接跳过，不进入文字排版也不修改当前 clip。
if rect.width <= 0.0 || rect.height <= 0.0 {
return;
}
@@ -314,6 +362,7 @@ impl Canvas<'_> {
((old.x + old.width).min(rect.x + rect.width) - x).max(0.0),
((old.y + old.height).min(rect.y + rect.height) - y).max(0.0),
);
// 段落原点对齐整数像素，随后把交集 clip 换到文字局部空间；排版宽度仍保持原框宽。
let left = rect.x.round() as i32;
let top = rect.y.round() as i32;
let clip = Rect::new(
@@ -331,10 +380,12 @@ impl Canvas<'_> {
clip,
|dx, dy, pixel| self.blend_pixel(left + dx, top + dy, pixel),
);
// 文字回调同步执行完成后恢复外层 clip，后续显示命令不继承段落框限制。
self.clip = old;
}
/// 把连续矩形转换成目标缓冲内的整数像素范围，避免在不可见区域进行光栅循环。
// 填充、描边和图像共同使用；完全分离时可产生空的整数区间，调用方 range 循环自然不执行。
fn clamped_bounds(&self, rect: Rect) -> (i32, i32, i32, i32) {
// 左/上 floor，右/下 ceil 形成保守循环范围；blend_pixel 还会按当前 clip 检查实际整数像素。
(
@@ -352,6 +403,7 @@ impl Canvas<'_> {
}
/// 在画布与当前裁剪范围内进行透明度混合，防止文字/图形写出目标缓冲。
// 文字覆盖回调、矩形和图像最终都进入此处；3D 表面分支已经自行裁剪，直接复制 RGB。
fn blend_pixel(&mut self, x: i32, y: i32, source: Color) {
// 拒绝画布外、裁剪外与全透明像素；只有通过后才计算线性下标，避免负坐标转 usize。
if x < 0
@@ -367,6 +419,7 @@ impl Canvas<'_> {
return;
}
// 边界检查通过后才将坐标转 usize，目标下标按 width 逐行计算。
let index = y as usize * self.width as usize + x as usize;
// 全不透明像素可直接打包覆盖，省去目的通道解码与乘除法。
if source.alpha == 255 {
@@ -374,6 +427,7 @@ impl Canvas<'_> {
return;
}
// 半透明路径拆开已有 RGB，再用源 alpha 与剩余权重逐通道合成；目的缓冲没有单独 alpha。
let destination = self.pixels[index];
let dst_red = (destination >> 16) & 0xff;
let dst_green = (destination >> 8) & 0xff;
@@ -389,10 +443,13 @@ impl Canvas<'_> {
}
/// 测试一个像素采样点是否位于圆角矩形内，角区域使用圆弧距离。
// fill/stroke 的内部形状测试，参数 x/y 是像素中心；radius<=0 退化为普通矩形判断。
fn rounded_rect_contains(rect: Rect, radius: f32, x: f32, y: f32) -> bool {
// 零或负面积没有内部，描边内框缩到零时也依赖这一返回值。
if rect.width <= 0.0 || rect.height <= 0.0 {
return false;
}
// 普通矩形走直接边界比较，避免不必要的圆心距离计算。
if radius <= 0.0 {
return x >= rect.x && x <= rect.x + rect.width && y >= rect.y && y <= rect.y + rect.height;
}
@@ -404,12 +461,14 @@ fn rounded_rect_contains(rect: Rect, radius: f32, x: f32, y: f32) -> bool {
// 先减大原点可降低浮点舍入导致 clamp 上下界反转的风险。
let local_x = x - rect.x;
let local_y = y - rect.y;
// 把局部点投影到圆心可达矩形，差向量长度就是到最近圆角中心/中心带的距离。
let dx = local_x - local_x.clamp(radius, rect.width - radius);
let dy = local_y - local_y.clamp(radius, rect.height - radius);
dx * dx + dy * dy <= radius * radius
}
/// 将颜色通道打包成目标缓冲的整数像素表示。
// clear 和全不透明 blend_pixel 直接使用；半透明路径先完成合成再自行打包。
fn pack(color: Color) -> u32 {
// 像素格式为 0x00RRGGBB，高字节不存透明度；透明度已在混合阶段折算进 RGB。
(color.red as u32) << 16 | (color.green as u32) << 8 | color.blue as u32
@@ -422,6 +481,7 @@ mod tests {
#[test]
/// 画长文字进入嵌套裁剪，逐像素检查多行与裁剪交集；PopClip后的蓝矩形验证后续命令不沿用旧clip。
fn wrapped_text_uses_multiple_lines_respects_nested_clips_and_restores_the_clip() {
// 依次构造白底、祖先 clip、换行文字、PopClip、零宽文字与远处蓝框，用不同命令检测裁剪状态。
let mut list = DisplayList::default();
list.push(DrawCommand::Clear(Color::rgb(255, 255, 255)));
list.push(DrawCommand::PushClip(Rect::new(12.0, 5.0, 20.0, 40.0)));
@@ -443,13 +503,18 @@ mod tests {
radius: 0.0,
color: Color::rgb(0, 0, 255),
});
// 目标尺寸覆盖文字和蓝框，初始化后由 Clear 建立统一白背景。
let mut pixels = vec![0; 80 * 60];
SoftwareRenderer::render(&list, &mut pixels, 80, 60).unwrap();
// 确认文字确实换成多行且每个非背景文字像素都落在嵌套裁剪交集内，蓝色矩形验证裁剪已恢复。
// 记录是否在第二行高度出现文字像素，不能仅用“有黑点”证明换行生效。
let mut second_line = false;
// 遍历整张目标，跳过白背景和蓝框后，剩余文字像素必须全部位于裁剪交集。
for y in 0..60 {
for x in 0..80 {
// 按目标行宽 80 读取 RGB；此测试不依赖具体字体的逐像素位图。
let color = pixels[y * 80 + x];
// 识别文字及其抗锯齿边缘，检查位置并累计第二行存在性。
if color != 0xffffff && color != 0x0000ff {
assert!((12..32).contains(&x) && (5..45).contains(&y));
second_line |= y >= 25;
@@ -457,12 +522,14 @@ mod tests {
}
}
assert!(second_line);
// 蓝框在原祖先 clip 外，成功出现说明 PopClip 与段落私有 clip 都已恢复。
assert_eq!(pixels[50 * 80 + 70], 0x0000ff);
}
#[test]
/// 在黑底4x4缓冲画2x2红矩形，核对内部像素变红、外部仍黑，覆盖最小坐标/打包路径。
fn renderer_changes_pixels_inside_a_rectangle() {
// 建立黑底加红色无圆角小矩形，隔离最基本的填充与像素坐标路径。
let mut list = DisplayList::default();
list.push(DrawCommand::Clear(Color::rgb(0, 0, 0)));
list.push(DrawCommand::FillRoundedRect {
@@ -470,6 +537,7 @@ mod tests {
radius: 0.0,
color: Color::rgb(255, 0, 0),
});
// 4×4 行主序缓冲中下标 5 是 (1,1)，下标 0 在矩形外，分别断言覆盖与保留。
let mut pixels = vec![0; 16];
SoftwareRenderer::render(&list, &mut pixels, 4, 4).unwrap();
assert_eq!(pixels[5], 0x00ff0000);
@@ -479,6 +547,7 @@ mod tests {
#[test]
/// 半透明白字叠黑底必须含中间抗锯齿值且通道不超128；alpha=0的文字完全不改像素。
fn text_edges_are_antialiased_and_respect_opacity() {
// 白色字形以 alpha=128 画在黑底，抗锯齿覆盖进一步降低边缘 alpha，输出应包含中间亮度。
let mut list = DisplayList::default();
list.push(DrawCommand::Clear(Color::rgb(0, 0, 0)));
list.push(DrawCommand::Text {
@@ -487,6 +556,7 @@ mod tests {
style: TextStyle::ui(1).scaled(1.25),
color: Color::rgba(255, 255, 255, 128),
});
// 留出足够宽度覆盖混合中英文字，不通过裁剪截掉全部内容来误判透明度。
let mut pixels = vec![0; 256 * 48];
SoftwareRenderer::render(&list, &mut pixels, 256, 48).unwrap();
assert!(pixels.iter().any(|pixel| *pixel > 0));
@@ -494,6 +564,7 @@ mod tests {
assert!(pixels.iter().all(|pixel| (pixel & 255) <= 128));
assert!(pixels.iter().any(|pixel| (1..128).contains(&(pixel & 255))));
// 另建全透明文字列表，不依赖上一张已绘制缓冲；零 alpha 应在混合入口直接跳过。
let mut invisible = DisplayList::default();
invisible.push(DrawCommand::Text {
origin: Point::new(2.0, 2.0),
@@ -501,6 +572,7 @@ mod tests {
style: TextStyle::ui(1),
color: Color::rgba(255, 255, 255, 0),
});
// 重新分配黑底后渲染透明字，整张仍为零才证明没有残留写入。
let mut pixels = vec![0; 256 * 48];
SoftwareRenderer::render(&invisible, &mut pixels, 256, 48).unwrap();
assert!(pixels.iter().all(|pixel| *pixel == 0));