SkSVGRenderContext Class Reference

#include <SkSVGRenderContext.h>

Classes
class	BorrowedNode
struct	OBBScope
struct	OBBTransform

Public Types
enum	ApplyFlags { kLeaf = 1 << 0 }

Public Member Functions
	SkSVGRenderContext (SkCanvas *, const sk_sp< SkFontMgr > &, const sk_sp< skresources::ResourceProvider > &, const SkSVGIDMapper &, const SkSVGLengthContext &, const SkSVGPresentationContext &, const OBBScope &, const sk_sp< SkShapers::Factory > &)
	SkSVGRenderContext (const SkSVGRenderContext &)
	SkSVGRenderContext (const SkSVGRenderContext &, SkCanvas *)
	SkSVGRenderContext (const SkSVGRenderContext &, const SkSVGNode *)
	~SkSVGRenderContext ()
const SkSVGLengthContext &	lengthContext () const
SkSVGLengthContext *	writableLengthContext ()
const SkSVGPresentationContext &	presentationContext () const
SkCanvas *	canvas () const
void	saveOnce ()
void	applyPresentationAttributes (const SkSVGPresentationAttributes &, uint32_t flags)
BorrowedNode	findNodeById (const SkSVGIRI &) const
SkTLazy< SkPaint >	fillPaint () const
SkTLazy< SkPaint >	strokePaint () const
SkSVGColorType	resolveSvgColor (const SkSVGColor &) const
const SkPath *	clipPath () const
const sk_sp< skresources::ResourceProvider > &	resourceProvider () const
sk_sp< SkFontMgr >	fontMgr () const
OBBTransform	transformForCurrentOBB (SkSVGObjectBoundingBoxUnits) const
SkRect	resolveOBBRect (const SkSVGLength &x, const SkSVGLength &y, const SkSVGLength &w, const SkSVGLength &h, SkSVGObjectBoundingBoxUnits) const
std::unique_ptr< SkShaper >	makeShaper () const
std::unique_ptr< SkShaper::BiDiRunIterator >	makeBidiRunIterator (const char *utf8, size_t utf8Bytes, uint8_t bidiLevel) const
std::unique_ptr< SkShaper::ScriptRunIterator >	makeScriptRunIterator (const char *utf8, size_t utf8Bytes) const

Detailed Description

Definition at line 63 of file SkSVGRenderContext.h.

Member Enumeration Documentation

ApplyFlags

enum SkSVGRenderContext::ApplyFlags

Enumerator
kLeaf

Definition at line 93 of file SkSVGRenderContext.h.

                    {
        kLeaf = 1 << 0, // the target node doesn't have descendants
    };

Constructor & Destructor Documentation

SkSVGRenderContext() [1/4]

SkSVGRenderContext::SkSVGRenderContext	(	SkCanvas *	canvas,
		const sk_sp< SkFontMgr > &	fmgr,
		const sk_sp< skresources::ResourceProvider > &	rp,
		const SkSVGIDMapper &	mapper,
		const SkSVGLengthContext &	lctx,
		const SkSVGPresentationContext &	pctx,
		const OBBScope &	obbs,
		const sk_sp< SkShapers::Factory > &	fact
	)

Definition at line 149 of file SkSVGRenderContext.cpp.

        : fFontMgr(fmgr)
        , fTextShapingFactory(fact)
        , fResourceProvider(rp)
        , fIDMapper(mapper)
        , fLengthContext(lctx)
        , fPresentationContext(pctx)
        , fCanvas(canvas)
        , fCanvasSaveCount(canvas->getSaveCount())
        , fOBBScope(obbs) {}

SkSVGRenderContext() [2/4]

SkSVGRenderContext::SkSVGRenderContext

(

const SkSVGRenderContext &

other

)

Definition at line 167 of file SkSVGRenderContext.cpp.

        : SkSVGRenderContext(other.fCanvas,
                             other.fFontMgr,
                             other.fResourceProvider,
                             other.fIDMapper,
                             *other.fLengthContext,
                             *other.fPresentationContext,
                             other.fOBBScope,
                             other.fTextShapingFactory) {}

SkSVGRenderContext() [3/4]

SkSVGRenderContext::SkSVGRenderContext	(	const SkSVGRenderContext &	other,
		SkCanvas *	canvas
	)

Definition at line 177 of file SkSVGRenderContext.cpp.

        : SkSVGRenderContext(canvas,
                             other.fFontMgr,
                             other.fResourceProvider,
                             other.fIDMapper,
                             *other.fLengthContext,
                             *other.fPresentationContext,
                             other.fOBBScope,
                             other.fTextShapingFactory) {}

SkSVGRenderContext() [4/4]

SkSVGRenderContext::SkSVGRenderContext	(	const SkSVGRenderContext &	other,
		const SkSVGNode *	node
	)

Definition at line 187 of file SkSVGRenderContext.cpp.

        : SkSVGRenderContext(other.fCanvas,
                             other.fFontMgr,
                             other.fResourceProvider,
                             other.fIDMapper,
                             *other.fLengthContext,
                             *other.fPresentationContext,
                             OBBScope{node, this},
                             other.fTextShapingFactory) {}

~SkSVGRenderContext()

SkSVGRenderContext::~SkSVGRenderContext

(

)

Definition at line 197 of file SkSVGRenderContext.cpp.

                                        {
    fCanvas->restoreToCount(fCanvasSaveCount);
}

Member Function Documentation

applyPresentationAttributes()

void SkSVGRenderContext::applyPresentationAttributes	(	const SkSVGPresentationAttributes &	attrs,
		uint32_t	flags
	)

Definition at line 209 of file SkSVGRenderContext.cpp.

                                                                     {
 
#define ApplyLazyInheritedAttribute(ATTR)                                               \
    do {                                                                                \
        /* All attributes should be defined on the inherited context. */                \
        SkASSERT(fPresentationContext->fInherited.f ## ATTR.isValue());                 \
        const auto& attr = attrs.f ## ATTR;                                             \
        if (attr.isValue() && *attr != *fPresentationContext->fInherited.f ## ATTR) {   \
            /* Update the local attribute value */                                      \
            fPresentationContext.writable()->fInherited.f ## ATTR.set(*attr);           \
        }                                                                               \
    } while (false)
 
    ApplyLazyInheritedAttribute(Fill);
    ApplyLazyInheritedAttribute(FillOpacity);
    ApplyLazyInheritedAttribute(FillRule);
    ApplyLazyInheritedAttribute(FontFamily);
    ApplyLazyInheritedAttribute(FontSize);
    ApplyLazyInheritedAttribute(FontStyle);
    ApplyLazyInheritedAttribute(FontWeight);
    ApplyLazyInheritedAttribute(ClipRule);
    ApplyLazyInheritedAttribute(Stroke);
    ApplyLazyInheritedAttribute(StrokeDashOffset);
    ApplyLazyInheritedAttribute(StrokeDashArray);
    ApplyLazyInheritedAttribute(StrokeLineCap);
    ApplyLazyInheritedAttribute(StrokeLineJoin);
    ApplyLazyInheritedAttribute(StrokeMiterLimit);
    ApplyLazyInheritedAttribute(StrokeOpacity);
    ApplyLazyInheritedAttribute(StrokeWidth);
    ApplyLazyInheritedAttribute(TextAnchor);
    ApplyLazyInheritedAttribute(Visibility);
    ApplyLazyInheritedAttribute(Color);
    ApplyLazyInheritedAttribute(ColorInterpolation);
    ApplyLazyInheritedAttribute(ColorInterpolationFilters);
 
#undef ApplyLazyInheritedAttribute
 
    // Uninherited attributes.  Only apply to the current context.
 
    const bool hasFilter = attrs.fFilter.isValue();
    if (attrs.fOpacity.isValue()) {
        this->applyOpacity(*attrs.fOpacity, flags, hasFilter);
    }
 
    if (attrs.fClipPath.isValue()) {
        this->applyClip(*attrs.fClipPath);
    }
 
    if (attrs.fMask.isValue()) {
        this->applyMask(*attrs.fMask);
    }
 
    // TODO: when both a filter and opacity are present, we can apply both with a single layer
    if (hasFilter) {
        this->applyFilter(*attrs.fFilter);
    }
 
    // Remaining uninherited presentation attributes are accessed as SkSVGNode fields, not via
    // the render context.
    // TODO: resolve these in a pre-render styling pass and assert here that they are values.
    // - stop-color
    // - stop-opacity
    // - flood-color
    // - flood-opacity
    // - lighting-color
}

canvas()

SkCanvas * SkSVGRenderContext::canvas ( ) const

inline

Definition at line 90 of file SkSVGRenderContext.h.

{ return fCanvas; }

clipPath()

const SkPath * SkSVGRenderContext::clipPath ( ) const

inline

Definition at line 140 of file SkSVGRenderContext.h.

{ return fClipPath.getMaybeNull(); }

fillPaint()

SkTLazy< SkPaint > SkSVGRenderContext::fillPaint

(

)

const

Definition at line 443 of file SkSVGRenderContext.cpp.

                                                     {
    const auto& props = fPresentationContext->fInherited;
    auto p = this->commonPaint(*props.fFill, *props.fFillOpacity);
 
    if (p.isValid()) {
        p->setStyle(SkPaint::kFill_Style);
    }
 
    return p;
}

findNodeById()

SkSVGRenderContext::BorrowedNode SkSVGRenderContext::findNodeById

(

const SkSVGIRI &

iri

)

const

Definition at line 201 of file SkSVGRenderContext.cpp.

                                                                                         {
    if (iri.type() != SkSVGIRI::Type::kLocal) {
        SkDebugf("non-local iri references not currently supported");
        return BorrowedNode(nullptr);
    }
    return BorrowedNode(fIDMapper.find(iri.iri()));
}

fontMgr()

sk_sp< SkFontMgr > SkSVGRenderContext::fontMgr ( ) const

inline

Definition at line 146 of file SkSVGRenderContext.h.

                                     {
        // It is probably an oversight to try to render <text> without having set the SkFontMgr.
        // We will assert this in debug mode, but fallback to an empty fontmgr in release builds.
        SkASSERT(fFontMgr);
        return fFontMgr ? fFontMgr : SkFontMgr::RefEmpty();
    }

lengthContext()

const SkSVGLengthContext & SkSVGRenderContext::lengthContext ( ) const

inline

Definition at line 85 of file SkSVGRenderContext.h.

{ return *fLengthContext; }

makeBidiRunIterator()

std::unique_ptr< SkShaper::BiDiRunIterator > SkSVGRenderContext::makeBidiRunIterator ( const char *  utf8, size_t  utf8Bytes, uint8_t  bidiLevel  ) const

inline

Definition at line 169 of file SkSVGRenderContext.h.

                                                                                            {
        SkASSERT(fTextShapingFactory);
        return fTextShapingFactory->makeBidiRunIterator(utf8, utf8Bytes, bidiLevel);
    }

makeScriptRunIterator()

std::unique_ptr< SkShaper::ScriptRunIterator > SkSVGRenderContext::makeScriptRunIterator ( const char *  utf8, size_t  utf8Bytes  ) const

inline

Definition at line 176 of file SkSVGRenderContext.h.

                                                                                               {
        SkASSERT(fTextShapingFactory);
        constexpr SkFourByteTag unknownScript = SkSetFourByteTag('Z', 'z', 'z', 'z');
        return fTextShapingFactory->makeScriptRunIterator(utf8, utf8Bytes, unknownScript);
    }

makeShaper()

std::unique_ptr< SkShaper > SkSVGRenderContext::makeShaper ( ) const

inline

Definition at line 164 of file SkSVGRenderContext.h.

                                               {
        SkASSERT(fTextShapingFactory);
        return fTextShapingFactory->makeShaper(this->fontMgr());
    }

presentationContext()

const SkSVGPresentationContext & SkSVGRenderContext::presentationContext ( ) const

inline

Definition at line 88 of file SkSVGRenderContext.h.

{ return *fPresentationContext; }

resolveOBBRect()

SkRect SkSVGRenderContext::resolveOBBRect	(	const SkSVGLength &	x,
		const SkSVGLength &	y,
		const SkSVGLength &	w,
		const SkSVGLength &	h,
		SkSVGObjectBoundingBoxUnits	obbu
	)		const

Definition at line 503 of file SkSVGRenderContext.cpp.

                                                                                  {
    SkTCopyOnFirstWrite<SkSVGLengthContext> lctx(fLengthContext);
 
    if (obbu.type() == SkSVGObjectBoundingBoxUnits::Type::kObjectBoundingBox) {
        *lctx.writable() = SkSVGLengthContext({1,1});
    }
 
    auto r = lctx->resolveRect(x, y, w, h);
    const auto obbt = this->transformForCurrentOBB(obbu);
 
    return SkRect::MakeXYWH(obbt.scale.x * r.x() + obbt.offset.x,
                            obbt.scale.y * r.y() + obbt.offset.y,
                            obbt.scale.x * r.width(),
                            obbt.scale.y * r.height());
}

resolveSvgColor()

SkSVGColorType SkSVGRenderContext::resolveSvgColor

(

const SkSVGColor &

color

)

const

Definition at line 471 of file SkSVGRenderContext.cpp.

                                                                                {
    if (fPresentationContext->fNamedColors) {
        for (auto&& ident : color.vars()) {
            SkSVGColorType* c = fPresentationContext->fNamedColors->find(ident);
            if (c) {
                return *c;
            }
        }
    }
    switch (color.type()) {
        case SkSVGColor::Type::kColor:
            return color.color();
        case SkSVGColor::Type::kCurrentColor:
            return *fPresentationContext->fInherited.fColor;
        case SkSVGColor::Type::kICCColor:
            SkDebugf("ICC color unimplemented");
            return SK_ColorBLACK;
    }
    SkUNREACHABLE;
}

resourceProvider()

const sk_sp< skresources::ResourceProvider > & SkSVGRenderContext::resourceProvider ( ) const

inline

Definition at line 142 of file SkSVGRenderContext.h.

                                                                       {
        return fResourceProvider;
    }

saveOnce()

void SkSVGRenderContext::saveOnce

(

)

Definition at line 323 of file SkSVGRenderContext.cpp.

                                  {
    // The canvas only needs to be saved once, per local SkSVGRenderContext.
    if (fCanvas->getSaveCount() == fCanvasSaveCount) {
        fCanvas->save();
    }
 
    SkASSERT(fCanvas->getSaveCount() > fCanvasSaveCount);
}

strokePaint()

SkTLazy< SkPaint > SkSVGRenderContext::strokePaint

(

)

const

Definition at line 454 of file SkSVGRenderContext.cpp.

                                                       {
    const auto& props = fPresentationContext->fInherited;
    auto p = this->commonPaint(*props.fStroke, *props.fStrokeOpacity);
 
    if (p.isValid()) {
        p->setStyle(SkPaint::kStroke_Style);
        p->setStrokeWidth(fLengthContext->resolve(*props.fStrokeWidth,
                                                  SkSVGLengthContext::LengthType::kOther));
        p->setStrokeCap(toSkCap(*props.fStrokeLineCap));
        p->setStrokeJoin(toSkJoin(*props.fStrokeLineJoin));
        p->setStrokeMiter(*props.fStrokeMiterLimit);
        p->setPathEffect(dash_effect(props, *fLengthContext));
    }
 
    return p;
}

transformForCurrentOBB()

SkSVGRenderContext::OBBTransform SkSVGRenderContext::transformForCurrentOBB

(

SkSVGObjectBoundingBoxUnits

u

)

const

Definition at line 493 of file SkSVGRenderContext.cpp.

                                                                              {
    if (!fOBBScope.fNode || u.type() == SkSVGObjectBoundingBoxUnits::Type::kUserSpaceOnUse) {
        return {{0,0},{1,1}};
    }
    SkASSERT(fOBBScope.fCtx);
 
    const auto obb = fOBBScope.fNode->objectBoundingBox(*fOBBScope.fCtx);
    return {{obb.x(), obb.y()}, {obb.width(), obb.height()}};
}

writableLengthContext()

SkSVGLengthContext * SkSVGRenderContext::writableLengthContext ( )

inline

Definition at line 86 of file SkSVGRenderContext.h.

{ return fLengthContext.writable(); }

---

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

• third_party/skia/modules/svg/include/SkSVGRenderContext.h
• third_party/skia/modules/svg/src/SkSVGRenderContext.cpp