1
0
mirror of https://github.com/TomHarte/CLK.git synced 2024-09-27 18:55:48 +00:00

Adds note on the buffering scan target's minor adaptation of data_offset.

This commit is contained in:
Thomas Harte 2020-08-09 20:44:46 -04:00
parent 57fecdc09e
commit ced4a75a1a

View File

@ -48,13 +48,15 @@ class BufferingScanTarget: public Outputs::Display::ScanTarget {
// It is the subclass's responsibility to post timings. // It is the subclass's responsibility to post timings.
Metrics display_metrics_; Metrics display_metrics_;
// Extends the definition of a Scan to include two extra fields, /// Extends the definition of a Scan to include two extra fields,
// completing this scan's source data and destination locations. /// completing this scan's source data and destination locations.
struct Scan { struct Scan {
Outputs::Display::ScanTarget::Scan scan; Outputs::Display::ScanTarget::Scan scan;
/// Stores the y coordinate for this scan's data within the write area texture. /// Stores the y coordinate for this scan's data within the write area texture.
/// Use this plus the scan's endpoints' data_offsets to locate this data in 2d. /// Use this plus the scan's endpoints' data_offsets to locate this data in 2d.
/// Note that the data_offsets will have been adjusted to be relative to the line
/// they fall within, not the data allocation.
uint16_t data_y; uint16_t data_y;
/// Stores the y coordinate assigned to this scan within the intermediate buffers. /// Stores the y coordinate assigned to this scan within the intermediate buffers.
/// Use this plus this scan's endpoints' x locations to determine where to composite /// Use this plus this scan's endpoints' x locations to determine where to composite