dream-soft-render 2.0.0

Deterministic CPU rasterizer for 2D meshes and egui frames, writing premultiplied RGBA8
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
// SPDX-License-Identifier: MIT OR Apache-2.0

//! The generic drawing API: a golden scene that exercises every draw call, and the validation
//! contract for bad input.

use dream_soft_render::{
    ClipRect, Color, Error, MAX_SURFACE_PIXELS, MAX_TEXTURE_BYTES, Mesh, Rect, SoftwareRenderer,
    Vertex, VertexField,
};

const GOLDEN_SCENE_HASH: u64 = 0xdcb5_803b_00db_a499;

fn fnv1a(bytes: &[u8]) -> u64 {
    bytes.iter().fold(0xcbf2_9ce4_8422_2325, |hash, byte| {
        (hash ^ u64::from(*byte)).wrapping_mul(0x0000_0100_0000_01b3)
    })
}

fn gradient_texture(width: usize, height: usize) -> Vec<u8> {
    let mut pixels = Vec::with_capacity(width * height * 4);
    for y in 0..height {
        for x in 0..width {
            let alpha = u8::try_from((x * 255) / (width - 1)).unwrap_or(u8::MAX);
            let shade = u8::try_from((y * 255) / (height - 1)).unwrap_or(u8::MAX);
            pixels.extend_from_slice(
                &Color::from_rgba_unmultiplied(shade, 96, 255 - shade, alpha).to_array(),
            );
        }
    }
    pixels
}

fn draw_golden_scene(renderer: &mut SoftwareRenderer) -> Result<Vec<u8>, Error> {
    let badge = renderer.create_texture(16, 8, &gradient_texture(16, 8))?;
    let mut frame = renderer.begin_frame(160, 120)?;
    frame.clear(Color::from_rgb(17, 20, 28));
    frame.fill_rect(
        Rect::from_min_size([6.25, 5.5], [70.0, 30.0]),
        Color::from_rgb(40, 44, 58),
        ClipRect::ALL,
    )?;
    frame.fill_rect(
        Rect::from_min_size([40.0, 20.0], [90.0, 50.0]),
        Color::from_rgba_unmultiplied(255, 140, 0, 128),
        ClipRect::new(0, 0, 110, 60),
    )?;
    frame.textured_rect(
        Rect::from_min_size([10.0, 60.0], [64.0, 32.0]),
        Rect::FULL_UV,
        badge,
        Color::WHITE,
        ClipRect::ALL,
    )?;
    frame.textured_rect(
        Rect::from_min_size([90.0, 80.0], [48.0, 24.0]),
        Rect::from_min_max([1.0, 0.0], [0.0, 1.0]),
        badge,
        Color::from_rgba_unmultiplied(200, 255, 200, 200),
        ClipRect::ALL,
    )?;
    let vertices = [
        Vertex::new(
            [80.0, 8.0],
            [0.0, 0.0],
            Color::from_rgba_unmultiplied(255, 0, 0, 255),
        ),
        Vertex::new(
            [150.0, 30.0],
            [1.0, 0.0],
            Color::from_rgba_unmultiplied(0, 255, 0, 160),
        ),
        Vertex::new(
            [100.5, 70.25],
            [0.5, 1.0],
            Color::from_rgba_unmultiplied(0, 0, 255, 64),
        ),
        Vertex::new([155.0, 75.0], [1.0, 1.0], Color::WHITE),
    ];
    frame.mesh(
        Mesh {
            vertices: &vertices,
            indices: &[0, 1, 2, 2, 1, 3],
            texture: None,
        },
        ClipRect::ALL,
    )?;
    frame.mesh(
        Mesh {
            vertices: &vertices,
            indices: &[2, 1, 3],
            texture: Some(badge),
        },
        ClipRect::new(100, 40, 160, 120),
    )?;
    Ok(frame.surface().pixels.clone())
}

#[test]
fn generic_scene_matches_golden_hash() {
    let pixels = draw_golden_scene(&mut SoftwareRenderer::default()).expect("scene draws");
    assert_eq!(
        fnv1a(&pixels),
        GOLDEN_SCENE_HASH,
        "hash=0x{:016x}",
        fnv1a(&pixels)
    );
}

#[test]
fn surface_size_is_validated() {
    let mut renderer = SoftwareRenderer::default();
    assert!(matches!(
        renderer.begin_frame(MAX_SURFACE_PIXELS + 1, 1),
        Err(Error::SurfaceSize { .. })
    ));
    assert!(matches!(
        renderer.begin_frame(usize::MAX, 2),
        Err(Error::SurfaceSize { .. })
    ));
    assert!(renderer.begin_frame(1280, 720).is_ok());
}

// The rasterizer's pixel coordinates are f32s clamped to u16::MAX, so a longer side drew
// everything past 65535 as if it ended there.
#[test]
fn surfaces_are_at_most_65535_pixels_on_a_side() -> Result<(), Error> {
    let mut renderer = SoftwareRenderer::default();
    for (width, height) in [(65_536, 1), (1, 65_536), (100_000, 2)] {
        assert_eq!(
            renderer.begin_frame(width, height).map(|_| ()),
            Err(Error::SurfaceSize { width, height })
        );
    }

    let mut frame = renderer.begin_frame(65_535, 1)?;
    frame.clear(Color::BLACK);
    frame.fill_rect(
        Rect::from_min_max([0.0, 0.0], [60_000.0, 1.0]),
        Color::from_rgba_premultiplied(100, 0, 0, 100),
        ClipRect::ALL,
    )?;
    let covered = frame
        .surface()
        .pixels
        .as_chunks::<4>()
        .0
        .iter()
        .filter(|pixel| pixel[0] != 0)
        .count();
    assert_eq!(covered, 60_000);
    Ok(())
}

#[test]
fn texture_creation_is_validated() {
    let mut renderer = SoftwareRenderer::default();
    assert_eq!(
        renderer.create_texture(0, 4, &[]),
        Err(Error::TextureSize {
            width: 0,
            height: 4
        })
    );
    assert_eq!(
        renderer.create_texture(2, 2, &[0; 15]),
        Err(Error::PixelDataLength {
            expected: 16,
            actual: 15
        })
    );
    let side = 1024;
    let full = vec![0; side * side * 4];
    let first = renderer
        .create_texture(side, side, &full)
        .expect("4 MiB fits");
    let second = renderer
        .create_texture(side, side, &full)
        .expect("8 MiB fits");
    assert_eq!(
        renderer.create_texture(1, 1, &[0; 4]),
        Err(Error::TextureBudget {
            requested: MAX_TEXTURE_BYTES + 4,
            budget: MAX_TEXTURE_BYTES
        })
    );
    renderer.free_texture(first).expect("free");
    assert!(renderer.create_texture(1, 1, &[0; 4]).is_ok());
    assert_ne!(first, second);
}

// Texel indices are computed in f32 from the texture's size clamped to u16::MAX, so a texture
// longer than 65536 texels on a side sampled the wrong texels: uv 0.5 of 100000 was texel 32768.
#[test]
fn textures_are_at_most_65536_texels_on_a_side() -> Result<(), Error> {
    let mut renderer = SoftwareRenderer::default();
    for (width, height) in [(65_537, 1), (1, 65_537), (100_000, 2)] {
        assert_eq!(
            renderer.create_texture(width, height, &vec![0; width * height * 4]),
            Err(Error::TextureSize { width, height })
        );
    }

    let width = 65_536;
    let pixels: Vec<u8> = (0..width)
        .flat_map(|x: usize| {
            let [low, high, ..] = x.to_le_bytes();
            [low, high, 0, 255]
        })
        .collect();
    let texture = renderer.create_texture(width, 1, &pixels)?;
    let mut frame = renderer.begin_frame(1, 1)?;
    frame.textured_rect(
        Rect::from_min_max([0.0, 0.0], [1.0, 1.0]),
        Rect::from_min_max([0.75, 0.0], [0.75, 1.0]),
        texture,
        Color::WHITE,
        ClipRect::ALL,
    )?;
    let texel = u16::from_le_bytes([frame.surface().pixels[0], frame.surface().pixels[1]]);
    assert_eq!(texel, 49_151, "round(0.75 * 65535)");
    Ok(())
}

#[test]
fn texture_updates_and_frees_are_validated() {
    let mut renderer = SoftwareRenderer::default();
    let texture = renderer.create_texture(4, 4, &[0; 64]).expect("texture");
    assert!(
        renderer
            .update_texture(texture, 2, 2, 2, 2, &[255; 16])
            .is_ok()
    );
    assert_eq!(
        renderer.update_texture(texture, 3, 0, 2, 1, &[0; 8]),
        Err(Error::TextureUpdateOutOfBounds(texture))
    );
    assert_eq!(
        renderer.update_texture(texture, 0, 0, 2, 2, &[0; 8]),
        Err(Error::PixelDataLength {
            expected: 16,
            actual: 8
        })
    );
    renderer.free_texture(texture).expect("free");
    assert_eq!(
        renderer.free_texture(texture),
        Err(Error::UnknownTexture(texture))
    );
    assert_eq!(
        renderer.update_texture(texture, 0, 0, 1, 1, &[0; 4]),
        Err(Error::UnknownTexture(texture))
    );
    let mut frame = renderer.begin_frame(8, 8).expect("frame");
    assert_eq!(
        frame.textured_rect(
            Rect::from_min_size([0.0, 0.0], [4.0, 4.0]),
            Rect::FULL_UV,
            texture,
            Color::WHITE,
            ClipRect::ALL
        ),
        Err(Error::UnknownTexture(texture))
    );
}

#[test]
fn meshes_and_rects_are_validated() {
    let mut renderer = SoftwareRenderer::default();
    let mut frame = renderer.begin_frame(8, 8).expect("frame");
    let vertices = [Vertex::default(); 3];
    assert_eq!(
        frame.mesh(
            Mesh {
                vertices: &vertices,
                indices: &[0, 1],
                texture: None
            },
            ClipRect::ALL
        ),
        Err(Error::IndexCount(2))
    );
    assert_eq!(
        frame.mesh(
            Mesh {
                vertices: &vertices,
                indices: &[0, 1, 3],
                texture: None
            },
            ClipRect::ALL
        ),
        Err(Error::IndexOutOfRange {
            index: 3,
            vertex_count: 3
        })
    );
    assert_eq!(
        frame.fill_rect(
            Rect::from_min_max([0.0, f32::NAN], [4.0, 4.0]),
            Color::WHITE,
            ClipRect::ALL
        ),
        Err(Error::NonFiniteRect)
    );
}

#[test]
fn empty_rects_and_clips_draw_nothing() {
    let mut renderer = SoftwareRenderer::default();
    let mut frame = renderer.begin_frame(8, 8).expect("frame");
    frame.clear(Color::BLACK);
    let before = frame.surface().pixels.clone();
    let inverted = Rect::from_min_max([6.0, 6.0], [2.0, 2.0]);
    frame
        .fill_rect(inverted, Color::WHITE, ClipRect::ALL)
        .expect("empty rect");
    let rect = Rect::from_min_size([0.0, 0.0], [8.0, 8.0]);
    frame
        .fill_rect(rect, Color::WHITE, ClipRect::new(5, 5, 5, 8))
        .expect("empty clip");
    frame
        .fill_rect(rect, Color::WHITE, ClipRect::new(20, 0, 30, 8))
        .expect("clip past surface");
    assert_eq!(frame.surface().pixels, before);
}

#[test]
fn fill_rect_covers_pixel_centers_inside_the_rect() {
    let mut renderer = SoftwareRenderer::default();
    let mut frame = renderer.begin_frame(6, 1).expect("frame");
    frame.clear(Color::BLACK);
    // Centers at 0.5 .. 5.5: 1.5 and 2.5 lie in (0.5, 2.5]; 0.5 does not.
    frame
        .fill_rect(
            Rect::from_min_max([0.5, 0.0], [2.5, 1.0]),
            Color::WHITE,
            ClipRect::ALL,
        )
        .expect("rect");
    let lit: Vec<bool> = frame
        .surface()
        .pixels
        .chunks(4)
        .map(|pixel| pixel[0] == 255)
        .collect();
    assert_eq!(lit, [false, true, true, false, false, false]);
}

#[test]
fn clear_overwrites_and_blending_writes_opaque_alpha() {
    let mut renderer = SoftwareRenderer::default();
    let mut frame = renderer.begin_frame(2, 1).expect("frame");
    frame.clear(Color::TRANSPARENT);
    assert_eq!(frame.surface().pixels, [0; 8]);
    frame
        .fill_rect(
            Rect::from_min_max([0.0, 0.0], [1.0, 1.0]),
            Color::from_rgba_premultiplied(100, 50, 0, 128),
            ClipRect::ALL,
        )
        .expect("rect");
    assert_eq!(&frame.surface().pixels[..4], &[100, 50, 0, 255]);
    assert_eq!(&frame.surface().pixels[4..], &[0, 0, 0, 0]);
}

#[test]
fn texture_handles_do_not_alias_across_renderers() {
    let mut first = SoftwareRenderer::default();
    let mut second = SoftwareRenderer::default();
    let first_texture = first.create_texture(1, 1, &[255; 4]).expect("texture");
    let second_texture = second.create_texture(1, 1, &[255; 4]).expect("texture");
    assert_ne!(first_texture, second_texture);

    assert_eq!(
        second.free_texture(first_texture),
        Err(Error::UnknownTexture(first_texture))
    );
    assert_eq!(
        second.update_texture(first_texture, 0, 0, 1, 1, &[0; 4]),
        Err(Error::UnknownTexture(first_texture))
    );
    let mut frame = second.begin_frame(4, 4).expect("frame");
    assert_eq!(
        frame.textured_rect(
            Rect::from_min_size([0.0, 0.0], [4.0, 4.0]),
            Rect::FULL_UV,
            first_texture,
            Color::WHITE,
            ClipRect::ALL
        ),
        Err(Error::UnknownTexture(first_texture))
    );
    second
        .free_texture(second_texture)
        .expect("own texture frees");
    first
        .free_texture(first_texture)
        .expect("own texture frees");
}

#[test]
fn non_finite_vertices_are_rejected() {
    let mut renderer = SoftwareRenderer::default();
    let mut frame = renderer.begin_frame(8, 8).expect("frame");
    frame.clear(Color::BLACK);
    let before = frame.surface().pixels.clone();
    let good = Vertex::new([1.0, 1.0], [0.0, 0.0], Color::WHITE);
    let cases = [
        (
            Vertex::new([f32::NAN, 1.0], [0.0, 0.0], Color::WHITE),
            VertexField::Position,
        ),
        (
            Vertex::new([1.0, f32::INFINITY], [0.0, 0.0], Color::WHITE),
            VertexField::Position,
        ),
        (
            Vertex::new([1.0, 1.0], [f32::NEG_INFINITY, 0.0], Color::WHITE),
            VertexField::Uv,
        ),
        (
            Vertex::new([1.0, 1.0], [0.0, f32::NAN], Color::WHITE),
            VertexField::Uv,
        ),
    ];
    for (bad, field) in cases {
        // The bad vertex is not referenced by any triangle; it is still malformed input.
        let vertices = [
            good,
            Vertex::new([7.0, 1.0], [0.0, 0.0], Color::WHITE),
            good,
            bad,
        ];
        assert_eq!(
            frame.mesh(
                Mesh {
                    vertices: &vertices,
                    indices: &[0, 1, 2],
                    texture: None,
                },
                ClipRect::ALL,
            ),
            Err(Error::NonFiniteVertex { index: 3, field })
        );
    }
    assert_eq!(frame.surface().pixels, before);
}