sksg::ClipEffect Class Reference

#include <SkSGClipEffect.h>

Inheritance diagram for sksg::ClipEffect:

Public Member Functions
	~ClipEffect () override
Public Member Functions inherited from sksg::RenderNode
void	render (SkCanvas *, const RenderContext *=nullptr) const
const RenderNode *	nodeAt (const SkPoint &point) const
bool	isVisible () const
void	setVisible (bool)
Public Member Functions inherited from sksg::Node
const SkRect &	revalidate (InvalidationController *, const SkMatrix &)
void	invalidate (bool damage=true)
Public Member Functions inherited from SkRefCntBase
	SkRefCntBase ()
virtual	~SkRefCntBase ()
bool	unique () const
void	ref () const
void	unref () const

Static Public Member Functions
static sk_sp< ClipEffect >	Make (sk_sp< RenderNode > child, sk_sp< GeometryNode > clip, bool aa=false, bool force_clip=false)

Protected Member Functions
	ClipEffect (sk_sp< RenderNode >, sk_sp< GeometryNode >, bool aa, bool force_clip)
void	onRender (SkCanvas *, const RenderContext *) const override
const RenderNode *	onNodeAt (const SkPoint &) const override
SkRect	onRevalidate (InvalidationController *, const SkMatrix &) override
Protected Member Functions inherited from sksg::EffectNode
	EffectNode (sk_sp< RenderNode >, uint32_t inval_traits=0)
	~EffectNode () override
void	onRender (SkCanvas *, const RenderContext *) const override
const RenderNode *	onNodeAt (const SkPoint &) const override
SkRect	onRevalidate (InvalidationController *, const SkMatrix &) override
const sk_sp< RenderNode > &	getChild () const
Protected Member Functions inherited from sksg::RenderNode
	RenderNode (uint32_t inval_traits=0)
virtual void	onRender (SkCanvas *, const RenderContext *) const =0
virtual const RenderNode *	onNodeAt (const SkPoint &p) const =0
Protected Member Functions inherited from sksg::Node
	Node (uint32_t invalTraits)
	~Node () override
const SkRect &	bounds () const
bool	hasInval () const
virtual SkRect	onRevalidate (InvalidationController *, const SkMatrix &ctm)=0
void	observeInval (const sk_sp< Node > &)
void	unobserveInval (const sk_sp< Node > &)

Additional Inherited Members
Protected Types inherited from sksg::Node
enum	InvalTraits { kBubbleDamage_Trait = 1 << 0 , kOverrideDamage_Trait = 1 << 1 }

Detailed Description

Concrete Effect node, applying a clip to its descendants.

Definition at line 30 of file SkSGClipEffect.h.

Constructor & Destructor Documentation

~ClipEffect()

sksg::ClipEffect::~ClipEffect ( )

override

Definition at line 30 of file SkSGClipEffect.cpp.

                        {
    this->unobserveInval(fClipNode);
}

ClipEffect()

sksg::ClipEffect::ClipEffect ( sk_sp< RenderNode >  child, sk_sp< GeometryNode >  clip, bool  aa, bool  force_clip  )

protected

Definition at line 22 of file SkSGClipEffect.cpp.

    : INHERITED(std::move(child))
    , fClipNode(std::move(clip))
    , fAntiAlias(aa)
    , fForceClip(force_clip) {
    this->observeInval(fClipNode);
}

Member Function Documentation

Make()

static sk_sp< ClipEffect > sksg::ClipEffect::Make ( sk_sp< RenderNode >  child, sk_sp< GeometryNode >  clip, bool  aa = false, bool  force_clip = false  )

inlinestatic

Definition at line 32 of file SkSGClipEffect.h.

                                                                            {
        return (child && clip)
            ? sk_sp<ClipEffect>(new ClipEffect(std::move(child), std::move(clip), aa, force_clip))
            : nullptr;
    }

onNodeAt()

const RenderNode * sksg::ClipEffect::onNodeAt ( const SkPoint &  p ) const

overrideprotectedvirtual

Implements sksg::RenderNode.

Definition at line 43 of file SkSGClipEffect.cpp.

                                                             {
    return fClipNode->contains(p) ? this->INHERITED::onNodeAt(p) : nullptr;
}

onRender()

void sksg::ClipEffect::onRender ( SkCanvas *  canvas, const RenderContext *  ctx  ) const

overrideprotectedvirtual

Implements sksg::RenderNode.

Definition at line 34 of file SkSGClipEffect.cpp.

                                                                          {
    SkAutoCanvasRestore acr(canvas, !fNoop);
    if (!fNoop) {
        fClipNode->clip(canvas, fAntiAlias);
    }
 
    this->INHERITED::onRender(canvas, ctx);
}

onRevalidate()

SkRect sksg::ClipEffect::onRevalidate ( InvalidationController *  ic, const SkMatrix &  ctm  )

overrideprotectedvirtual

Implements sksg::Node.

Definition at line 47 of file SkSGClipEffect.cpp.

                                                                               {
    SkASSERT(this->hasInval());
 
    const auto clipBounds = fClipNode->revalidate(ic, ctm);
    auto childBounds = this->INHERITED::onRevalidate(ic, ctm);
 
    // When the child node is fully contained within the clip, it is usually safe to elide.
    // An exception is clip-dependent sizing for saveLayer buffers, where the clip is always
    // significant.  For those cases, we provide a mechanism to disable elision.
    fNoop = !fForceClip && fClipNode->asPath().conservativelyContainsRect(childBounds);
 
    return childBounds.intersect(clipBounds) ? childBounds : SkRect::MakeEmpty();
}

---

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

• third_party/skia/modules/sksg/include/SkSGClipEffect.h
• third_party/skia/modules/sksg/src/SkSGClipEffect.cpp