donner::svg::components::ScopedFontResourceRender Class Reference

A render scope accepts exclusions only after its caller completes the corresponding traversal. More...

#include "donner/svg/components/FontResourceGraph.h"

Public Member Functions
	ScopedFontResourceRender (Registry &registry, Entity coverageRoot=entt::null)
	Start a render scope and optionally identify the root covered by its traversal.
	ScopedFontResourceRender (const ScopedFontResourceRender &)=delete
ScopedFontResourceRender &	operator= (const ScopedFontResourceRender &)=delete
void	finish (bool completed=true)
	Publish render coverage; an incomplete scope is not usable as font evidence.
void	setCoverageRoot (Entity root)
	Set the covered root of an active outermost render scope.

Static Public Member Functions
static void	recordDraw (Registry &registry, Entity entity, bool excluded)
	Record whether an entity was painted or excluded during an active render scope.

Detailed Description

A render scope accepts exclusions only after its caller completes the corresponding traversal.

Constructor & Destructor Documentation

ScopedFontResourceRender()

donner::svg::components::ScopedFontResourceRender::ScopedFontResourceRender ( Registry & registry, Entity coverageRoot = entt::null )

explicit

Start a render scope and optionally identify the root covered by its traversal.

Parameters

registry	Document registry containing the render scope state.
coverageRoot	Root of the covered tree, or null until set later.

Member Function Documentation

finish()

void donner::svg::components::ScopedFontResourceRender::finish

(

bool

completed = true

)

Publish render coverage; an incomplete scope is not usable as font evidence.

Parameters

completed

Whether the corresponding traversal reached completion.

recordDraw()

void donner::svg::components::ScopedFontResourceRender::recordDraw ( Registry & registry, Entity entity, bool excluded )

static

Record whether an entity was painted or excluded during an active render scope.

Parameters

registry	Document registry containing the render scope state.
entity	Rendered or excluded entity.
excluded	True when the entity was excluded rather than painted.

setCoverageRoot()

void donner::svg::components::ScopedFontResourceRender::setCoverageRoot

(

Entity

root

)

Set the covered root of an active outermost render scope.

Parameters

root	Root whose rendered descendants were traversed.

---

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

• donner/svg/components/FontResourceGraph.h