agg-rust 1.0.2

Pure Rust port of Anti-Grain Geometry (AGG) 2.6 - high quality 2D vector graphics rendering
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
//! Anti-aliased scanline storage.
//!
//! Port of `agg_scanline_storage_aa.h`.
//! Stores rasterized scanlines in memory for later boolean operations
//! or serialized replay. Each span stores per-pixel coverage data.

use crate::rasterizer_scanline_aa::Scanline;

/// Stored span data: x, len (positive=per-pixel, negative=solid), covers offset.
#[derive(Debug, Clone, Copy, Default)]
struct SpanData {
    x: i32,
    len: i32,
    covers_offset: usize,
}

/// Per-scanline metadata.
#[derive(Debug, Clone, Copy, Default)]
struct ScanlineData {
    y: i32,
    num_spans: u32,
    start_span: usize,
}

/// Anti-aliased scanline storage.
///
/// Port of C++ `scanline_storage_aa<T>`.
/// Stores rendered scanlines for later replay, boolean operations, or serialization.
pub struct ScanlineStorageAa {
    spans: Vec<SpanData>,
    covers: Vec<u8>,
    scanlines: Vec<ScanlineData>,
    min_x: i32,
    min_y: i32,
    max_x: i32,
    max_y: i32,
    cur_scanline: usize,
}

impl ScanlineStorageAa {
    pub fn new() -> Self {
        Self {
            spans: Vec::new(),
            covers: Vec::new(),
            scanlines: Vec::new(),
            min_x: i32::MAX,
            min_y: i32::MAX,
            max_x: i32::MIN,
            max_y: i32::MIN,
            cur_scanline: 0,
        }
    }

    /// Prepare for new rendering (clear all stored data).
    pub fn prepare(&mut self) {
        self.spans.clear();
        self.covers.clear();
        self.scanlines.clear();
        self.min_x = i32::MAX;
        self.min_y = i32::MAX;
        self.max_x = i32::MIN;
        self.max_y = i32::MIN;
        self.cur_scanline = 0;
    }

    /// Store a scanline from a ScanlineU8 (unpacked, per-pixel covers).
    pub fn render_scanline_u8(&mut self, sl: &crate::scanline_u::ScanlineU8) {
        let y = sl.y();
        if y < self.min_y {
            self.min_y = y;
        }
        if y > self.max_y {
            self.max_y = y;
        }

        let start_span = self.spans.len();
        let mut num_spans = 0u32;

        let spans = sl.begin();
        let covers_buf = sl.covers();

        for sp in spans {
            let x = sp.x;
            let len = sp.len;
            if len > 0 {
                // Per-pixel covers
                let xe = x + len - 1;
                if x < self.min_x {
                    self.min_x = x;
                }
                if xe > self.max_x {
                    self.max_x = xe;
                }
                let covers_offset = self.covers.len();
                self.covers
                    .extend_from_slice(&covers_buf[sp.cover_offset..sp.cover_offset + len as usize]);
                self.spans.push(SpanData {
                    x,
                    len,
                    covers_offset,
                });
            }
            num_spans += 1;
        }

        self.scanlines.push(ScanlineData {
            y,
            num_spans,
            start_span,
        });
    }

    /// Store a scanline from a ScanlineP8 (packed, may have solid spans).
    pub fn render_scanline_p8(&mut self, sl: &crate::scanline_p::ScanlineP8) {
        let y = sl.y();
        if y < self.min_y {
            self.min_y = y;
        }
        if y > self.max_y {
            self.max_y = y;
        }

        let start_span = self.spans.len();
        let mut num_spans = 0u32;

        let spans = sl.begin();
        let covers_buf = sl.covers();

        for sp in spans {
            let x = sp.x;
            let len = sp.len;
            let abs_len = len.unsigned_abs() as i32;
            let xe = x + abs_len - 1;
            if x < self.min_x {
                self.min_x = x;
            }
            if xe > self.max_x {
                self.max_x = xe;
            }
            let covers_offset = self.covers.len();
            if len < 0 {
                // Solid span — store single cover value
                self.covers.push(covers_buf[sp.cover_offset]);
            } else {
                // Per-pixel covers
                self.covers
                    .extend_from_slice(&covers_buf[sp.cover_offset..sp.cover_offset + len as usize]);
            }
            self.spans.push(SpanData {
                x,
                len,
                covers_offset,
            });
            num_spans += 1;
        }

        self.scanlines.push(ScanlineData {
            y,
            num_spans,
            start_span,
        });
    }

    /// Reset the scanline iteration pointer.
    pub fn rewind_scanlines(&mut self) -> bool {
        self.cur_scanline = 0;
        !self.scanlines.is_empty()
    }

    /// Sweep the next stored scanline into an output scanline container.
    /// Returns false when all scanlines have been consumed.
    pub fn sweep_scanline<SL: Scanline>(&mut self, sl: &mut SL) -> bool {
        sl.reset_spans();
        loop {
            if self.cur_scanline >= self.scanlines.len() {
                return false;
            }
            let sld = self.scanlines[self.cur_scanline];
            let num_spans = sld.num_spans;
            self.cur_scanline += 1;

            if num_spans == 0 {
                continue;
            }

            for i in 0..num_spans as usize {
                let sp = self.spans[sld.start_span + i];
                if sp.len < 0 {
                    // Solid span
                    sl.add_span(sp.x, (-sp.len) as u32, self.covers[sp.covers_offset] as u32);
                } else if sp.len > 0 {
                    // Per-pixel spans — add cell by cell
                    for j in 0..sp.len as usize {
                        sl.add_cell(sp.x + j as i32, self.covers[sp.covers_offset + j] as u32);
                    }
                }
            }
            sl.finalize(sld.y);
            return true;
        }
    }

    pub fn min_x(&self) -> i32 {
        self.min_x
    }
    pub fn min_y(&self) -> i32 {
        self.min_y
    }
    pub fn max_x(&self) -> i32 {
        self.max_x
    }
    pub fn max_y(&self) -> i32 {
        self.max_y
    }

    pub fn num_scanlines(&self) -> usize {
        self.scanlines.len()
    }

    // ========================================================================
    // Embedded scanline access (for boolean algebra)
    // ========================================================================

    /// Get the Y coordinate for a stored scanline by index.
    pub fn scanline_y(&self, idx: usize) -> i32 {
        self.scanlines[idx].y
    }

    /// Get the number of spans for a stored scanline by index.
    pub fn scanline_num_spans(&self, idx: usize) -> u32 {
        self.scanlines[idx].num_spans
    }

    /// Get the covers slice for a span.
    fn span_covers(&self, sp: &SpanData) -> &[u8] {
        if sp.len < 0 {
            &self.covers[sp.covers_offset..sp.covers_offset + 1]
        } else {
            &self.covers[sp.covers_offset..sp.covers_offset + sp.len as usize]
        }
    }

    /// Iterate over embedded scanline spans for boolean algebra.
    /// Returns an iterator of (x, len, covers_slice) tuples.
    pub fn embedded_spans(
        &self,
        sl_idx: usize,
    ) -> impl Iterator<Item = EmbeddedSpan<'_>> + '_ {
        let sld = &self.scanlines[sl_idx];
        let spans = &self.spans[sld.start_span..sld.start_span + sld.num_spans as usize];
        spans.iter().map(move |sp| EmbeddedSpan {
            x: sp.x,
            len: sp.len,
            covers: self.span_covers(sp),
        })
    }
}

impl Default for ScanlineStorageAa {
    fn default() -> Self {
        Self::new()
    }
}

/// A span reference from embedded scanline iteration.
#[derive(Debug, Clone, Copy)]
pub struct EmbeddedSpan<'a> {
    pub x: i32,
    pub len: i32,
    pub covers: &'a [u8],
}

impl<'a> EmbeddedSpan<'a> {
    /// Get the absolute length (number of pixels).
    pub fn abs_len(&self) -> i32 {
        self.len.abs()
    }

    /// Get end X (exclusive).
    pub fn x_end(&self) -> i32 {
        self.x + self.abs_len()
    }

    /// Get the coverage at pixel offset `i` from span start.
    pub fn cover_at(&self, i: usize) -> u8 {
        if self.len < 0 {
            self.covers[0] // solid span
        } else {
            self.covers[i]
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::scanline_u::ScanlineU8;

    #[test]
    fn test_empty_storage() {
        let storage = ScanlineStorageAa::new();
        assert_eq!(storage.num_scanlines(), 0);
    }

    #[test]
    fn test_store_and_replay() {
        let mut storage = ScanlineStorageAa::new();
        storage.prepare();

        // Build a scanline with a few cells
        let mut sl = ScanlineU8::new();
        sl.reset(0, 100);
        sl.add_cell(10, 128);
        sl.add_cell(11, 255);
        sl.add_cell(12, 64);
        sl.finalize(5);
        storage.render_scanline_u8(&sl);

        assert_eq!(storage.num_scanlines(), 1);
        assert_eq!(storage.min_x(), 10);
        assert_eq!(storage.max_x(), 12);
        assert_eq!(storage.min_y(), 5);
        assert_eq!(storage.max_y(), 5);

        // Replay into a fresh scanline
        assert!(storage.rewind_scanlines());
        let mut sl2 = ScanlineU8::new();
        sl2.reset(0, 100);
        assert!(storage.sweep_scanline(&mut sl2));
        assert_eq!(sl2.y(), 5);
        assert_eq!(sl2.num_spans(), 1);

        // Check coverage values
        let spans = sl2.begin();
        let covers = sl2.covers();
        assert_eq!(spans[0].x, 10);
        assert_eq!(spans[0].len, 3);
        assert_eq!(covers[spans[0].cover_offset], 128);
        assert_eq!(covers[spans[0].cover_offset + 1], 255);
        assert_eq!(covers[spans[0].cover_offset + 2], 64);
    }

    #[test]
    fn test_multiple_scanlines() {
        let mut storage = ScanlineStorageAa::new();
        storage.prepare();

        let mut sl = ScanlineU8::new();
        sl.reset(0, 100);
        sl.add_cell(5, 200);
        sl.finalize(0);
        storage.render_scanline_u8(&sl);

        sl.reset_spans();
        sl.add_cell(10, 100);
        sl.finalize(1);
        storage.render_scanline_u8(&sl);

        assert_eq!(storage.num_scanlines(), 2);
        assert_eq!(storage.min_y(), 0);
        assert_eq!(storage.max_y(), 1);

        // Replay
        assert!(storage.rewind_scanlines());
        let mut sl2 = ScanlineU8::new();
        sl2.reset(0, 100);
        assert!(storage.sweep_scanline(&mut sl2));
        assert_eq!(sl2.y(), 0);
        assert!(storage.sweep_scanline(&mut sl2));
        assert_eq!(sl2.y(), 1);
        assert!(!storage.sweep_scanline(&mut sl2));
    }

    #[test]
    fn test_prepare_clears() {
        let mut storage = ScanlineStorageAa::new();

        let mut sl = ScanlineU8::new();
        sl.reset(0, 100);
        sl.add_cell(5, 200);
        sl.finalize(0);
        storage.render_scanline_u8(&sl);

        storage.prepare();
        assert_eq!(storage.num_scanlines(), 0);
    }

    #[test]
    fn test_embedded_spans() {
        let mut storage = ScanlineStorageAa::new();
        storage.prepare();

        let mut sl = ScanlineU8::new();
        sl.reset(0, 100);
        sl.add_cell(10, 128);
        sl.add_cell(11, 255);
        sl.add_cell(20, 64);
        sl.finalize(5);
        storage.render_scanline_u8(&sl);

        let spans: Vec<_> = storage.embedded_spans(0).collect();
        assert_eq!(spans.len(), 2);
        assert_eq!(spans[0].x, 10);
        assert_eq!(spans[0].len, 2);
        assert_eq!(spans[0].cover_at(0), 128);
        assert_eq!(spans[0].cover_at(1), 255);
        assert_eq!(spans[1].x, 20);
        assert_eq!(spans[1].len, 1);
        assert_eq!(spans[1].cover_at(0), 64);
    }
}