donner::svg::RendererDriver Class Reference

Backend-agnostic renderer driver that prepares documents for rendering and emits drawing commands through a RendererInterface implementation. More...

#include "donner/svg/renderer/RendererDriver.h"

Public Member Functions
	RendererDriver (RendererInterface &renderer, bool verbose=false)
	Create a renderer driver that will forward traversal output to the given backend implementation.
void	draw (SVGDocument &document)
	Render the given SVGDocument using the configured backend.
void	draw (SVGDocument &document, const RenderViewport &viewport, const Transform2d &surfaceFromCanvas)
	Render the given SVGDocument into viewport after applying surfaceFromCanvas to every canvas-space draw command.
RenderSnapshot	captureRenderSnapshot (SVGDocument &document)
	Capture an immutable render snapshot from the given SVGDocument.
void	draw (const RenderSnapshot &snapshot)
	Replay an already-captured render snapshot into the configured backend.
void	drawEntityRange (Registry &registry, Entity firstEntity, Entity lastEntity, const RenderViewport &viewport, const Transform2d &surfaceFromCanvas)
	Render a range of entities from an already-prepared document's render tree.
void	drawEntityRangeIntoCurrentFrame (Registry &registry, Entity firstEntity, Entity lastEntity, const RenderViewport &viewport, const Transform2d &surfaceFromCanvas)
	Render a range of entities into the renderer's already-active frame.
std::optional< Box2d >	computeEntityRangeBounds (Registry &registry, Entity firstEntity, Entity lastEntity, const RenderViewport &viewport, const Transform2d &surfaceFromCanvas)
	Compute the canvas-space bounding box of every pixel a subsequent drawEntityRange(registry, firstEntity, lastEntity, viewport, baseTransform) call would write to.
RendererBitmap	takeSnapshot () const
	Capture a snapshot from the underlying backend after rendering.

Detailed Description

Backend-agnostic renderer driver that prepares documents for rendering and emits drawing commands through a RendererInterface implementation.

Member Function Documentation

captureRenderSnapshot()

RenderSnapshot donner::svg::RendererDriver::captureRenderSnapshot ( SVGDocument & document )

nodiscard

Capture an immutable render snapshot from the given SVGDocument.

Snapshot capture prepares the live render tree under document access, then records backend-agnostic draw commands that can be replayed after access is released.

Parameters

document

Document to snapshot.

computeEntityRangeBounds()

std::optional< Box2d > donner::svg::RendererDriver::computeEntityRangeBounds ( Registry & registry, Entity firstEntity, Entity lastEntity, const RenderViewport & viewport, const Transform2d & surfaceFromCanvas )

nodiscard

Compute the canvas-space bounding box of every pixel a subsequent drawEntityRange(registry, firstEntity, lastEntity, viewport, baseTransform) call would write to.

Runs the same entity traversal as drawEntityRange but with a bounds-accumulating visitor; no side effects on the renderer or registry.

The bounds include the effect of:

• Per-entity transforms (including the base transform).
• Filter regions (via computeFilterRegion; the filter's output rectangle is taken as the entity subtree's contribution).
• Stroke widths on stroked paths (expanded by strokeWidth / 2 plus a miter margin).
• Isolated layers — child bounds accumulate into the parent.
• Clip-rects (intersect, shrink only).

Returns std::nullopt when:

• The range is empty / renders nothing.
• Any entity uses a bound-expander the visitor doesn't yet model precisely (text, markers, masks, patterns). Callers must treat nullopt as "fall back to full-canvas render", NOT as "empty segment". The design doc at docs/design_docs/0027-tight_bounded_ segments.md tracks which cases are pending.

Safe to call on a RendererDriver whose renderer holds persistent state — the traversal never invokes renderer methods.

draw() [1/2]

void donner::svg::RendererDriver::draw

(

const RenderSnapshot &

snapshot

)

Replay an already-captured render snapshot into the configured backend.

Parameters

snapshot

Snapshot to render.

draw() [2/2]

void donner::svg::RendererDriver::draw	(	SVGDocument &	document,
		const RenderViewport &	viewport,
		const Transform2d &	surfaceFromCanvas )

Render the given SVGDocument into viewport after applying surfaceFromCanvas to every canvas-space draw command.

This is used by editor-style camera rendering: SVG layout can still use the document's semantic full canvas, while the backend only allocates the visible output surface.

Parameters

document	Document to render.
viewport	Output viewport for the backend frame.
surfaceFromCanvas	Transform from document canvas coordinates to the output surface.

drawEntityRange()

void donner::svg::RendererDriver::drawEntityRange	(	Registry &	registry,
		Entity	firstEntity,
		Entity	lastEntity,
		const RenderViewport &	viewport,
		const Transform2d &	surfaceFromCanvas )

Render a range of entities from an already-prepared document's render tree.

The document must have been prepared via RendererUtils::prepareDocumentForRendering() before calling this method.

Parameters

registry	The registry containing the prepared render tree.
firstEntity	First entity in the range to render (inclusive).
lastEntity	Last entity in the range to render (inclusive).
viewport	Viewport for the render pass.
surfaceFromCanvas	Transform that maps canvas coords to the render surface (Translate(-topLeft) for tight-bounded compositor segments, identity for full-canvas layers/segments). Named with destFromSource convention; composed with each entity's worldFromEntityTransform as worldFromEntityTransform * surfaceFromCanvas (donner's left-first operator*: "apply entity-to-canvas, then canvas-to-surface").

drawEntityRangeIntoCurrentFrame()

void donner::svg::RendererDriver::drawEntityRangeIntoCurrentFrame	(	Registry &	registry,
		Entity	firstEntity,
		Entity	lastEntity,
		const RenderViewport &	viewport,
		const Transform2d &	surfaceFromCanvas )

Render a range of entities into the renderer's already-active frame.

This is the current-frame form of drawEntityRange: the caller owns RendererInterface::beginFrame() / endFrame(), and this method only emits the entity-range draw commands. It is used by the compositor when an immediate-mode span should be drawn directly into the composition render target instead of first being rasterized into an offscreen tile.

Parameters

registry	The registry containing the prepared render tree.
firstEntity	First entity in the range to render (inclusive).
lastEntity	Last entity in the range to render (inclusive).
viewport	Viewport for the active render pass.
surfaceFromCanvas	Transform that maps canvas coords to the active render surface.

---

The documentation for this class was generated from the following file:

• donner/svg/renderer/RendererDriver.h