sksg::ImageFilterEffect Class Reference

#include <SkSGRenderEffect.h>

Inheritance diagram for sksg::ImageFilterEffect:

Public Types
enum class	Cropping { kNone , kContent }

Public Member Functions
	~ImageFilterEffect () 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< RenderNode >	Make (sk_sp< RenderNode > child, sk_sp< ImageFilter > filter)

Protected Member Functions
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

Attaches an ImageFilter (chain) to the render DAG.

Definition at line 136 of file SkSGRenderEffect.h.

Member Enumeration Documentation

Cropping

enum class sksg::ImageFilterEffect::Cropping

strong

Enumerator
kNone
kContent

Definition at line 142 of file SkSGRenderEffect.h.

                        {
        kNone,    // Doesn't use a crop rect.
        kContent, // Uses the content bounding box as a crop rect.
    };

Constructor & Destructor Documentation

~ImageFilterEffect()

sksg::ImageFilterEffect::~ImageFilterEffect ( )

override

Definition at line 109 of file SkSGRenderEffect.cpp.

                                      {
    this->unobserveInval(fImageFilter);
}

Member Function Documentation

Make()

sk_sp< RenderNode > sksg::ImageFilterEffect::Make ( sk_sp< RenderNode >  child, sk_sp< ImageFilter >  filter  )

static

Definition at line 97 of file SkSGRenderEffect.cpp.

                                                                                            {
    return filter ? sk_sp<RenderNode>(new ImageFilterEffect(std::move(child), std::move(filter)))
                  : child;
}

onNodeAt()

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

overrideprotectedvirtual

Reimplemented from sksg::EffectNode.

Definition at line 135 of file SkSGRenderEffect.cpp.

                                                                    {
    // TODO: map p through the filter DAG and dispatch to descendants?
    // For now, image filters occlude hit-testing.
    SkASSERT(this->bounds().contains(p.x(), p.y()));
    return this;
}

onRender()

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

overrideprotectedvirtual

Reimplemented from sksg::EffectNode.

Definition at line 142 of file SkSGRenderEffect.cpp.

                                                                                 {
    // Note: we're using the source content bounds for saveLayer, not our local/filtered bounds.
    const auto filter_ctx =
        ScopedRenderContext(canvas, ctx).setFilterIsolation(this->getChild()->bounds(),
                                                            canvas->getTotalMatrix(),
                                                            fImageFilter->getFilter());
    this->INHERITED::onRender(canvas, filter_ctx);
}

onRevalidate()

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

overrideprotectedvirtual

Reimplemented from sksg::EffectNode.

Definition at line 113 of file SkSGRenderEffect.cpp.

                                                                                      {
    const auto content_bounds = this->INHERITED::onRevalidate(ic, ctm);
 
    if (fCropping == Cropping::kContent) {
        fImageFilter->setCropRect(content_bounds);
    } else {
        fImageFilter->setCropRect(std::nullopt);
    }
 
    // FIXME: image filter effects should replace the descendents' damage!
    fImageFilter->revalidate(ic, ctm);
 
    const auto& filter = fImageFilter->getFilter();
 
    // Would be nice for this this to stick, but canComputeFastBounds()
    // appears to be conservative (false negatives).
    // SkASSERT(!filter || filter->canComputeFastBounds());
 
    return filter ? filter->computeFastBounds(content_bounds)
                  : content_bounds;
}

---

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

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