Skia
2D Graphics Library
Public Member Functions | Protected Types | Protected Member Functions | List of all members
sksg::EffectNode Class Reference

Base class for nodes which apply some transformation when rendering their descendants. More...

#include <SkSGEffectNode.h>

Inheritance diagram for sksg::EffectNode:
Inheritance graph
[legend]

Public Member Functions

void render (SkCanvas *, const RenderContext *=nullptr) const
 
const RenderNode * nodeAt (const SkPoint &point) const
 
bool isVisible () const
 
void setVisible (bool)
 
const SkRect & revalidate (InvalidationController *, const SkMatrix &)
 
void invalidate (bool damage=true)
 
bool unique () const
 May return true if the caller is the only owner. More...
 
void ref () const
 Increment the reference count. More...
 
void unref () const
 Decrement the reference count. More...
 

Protected Types

enum  InvalTraits { kBubbleDamage_Trait = 1 << 0 , kOverrideDamage_Trait = 1 << 1 }
 

Protected Member Functions

 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
 
const SkRect & bounds () const
 
bool hasInval () const
 
void observeInval (const sk_sp< Node > &)
 
void unobserveInval (const sk_sp< Node > &)
 

Detailed Description

Base class for nodes which apply some transformation when rendering their descendants.

This includes transforms, clipping, filters, etc.

Member Enumeration Documentation

◆ InvalTraits

enum sksg::Node::InvalTraits
protectedinherited
Enumerator
kBubbleDamage_Trait 
kOverrideDamage_Trait 

Constructor & Destructor Documentation

◆ EffectNode()

sksg::EffectNode::EffectNode ( sk_sp< RenderNode >  ,
uint32_t  inval_traits = 0 
)
explicitprotected

◆ ~EffectNode()

sksg::EffectNode::~EffectNode ( )
overrideprotected

Member Function Documentation

◆ bounds()

const SkRect& sksg::Node::bounds ( ) const
inlineprotectedinherited

◆ getChild()

const sk_sp<RenderNode>& sksg::EffectNode::getChild ( ) const
inlineprotected

◆ hasInval()

bool sksg::Node::hasInval ( ) const
inlineprotectedinherited

◆ invalidate()

void sksg::Node::invalidate ( bool  damage = true)
inherited

◆ isVisible()

bool sksg::RenderNode::isVisible ( ) const
inherited

◆ nodeAt()

const RenderNode* sksg::RenderNode::nodeAt ( const SkPoint &  point) const
inherited

◆ observeInval()

void sksg::Node::observeInval ( const sk_sp< Node > &  )
protectedinherited

◆ onNodeAt()

const RenderNode* sksg::EffectNode::onNodeAt ( const SkPoint &  ) const
overrideprotectedvirtual

Implements sksg::RenderNode.

Reimplemented in sksg::TransformEffect, sksg::BlenderEffect, sksg::ImageFilterEffect, sksg::OpacityEffect, and sksg::MaskEffect.

◆ onRender()

void sksg::EffectNode::onRender ( SkCanvas *  ,
const RenderContext *   
) const
overrideprotectedvirtual

Implements sksg::RenderNode.

Reimplemented in sksg::TransformEffect, sksg::BlenderEffect, sksg::ImageFilterEffect, sksg::MaskShaderEffect, sksg::ShaderEffect, sksg::OpacityEffect, and sksg::MaskEffect.

◆ onRevalidate()

SkRect sksg::EffectNode::onRevalidate ( InvalidationController *  ,
const SkMatrix &   
)
overrideprotectedvirtual

Implements sksg::Node.

Reimplemented in sksg::TransformEffect, sksg::ImageFilterEffect, sksg::ShaderEffect, sksg::OpacityEffect, and sksg::MaskEffect.

◆ ref()

void SkRefCntBase::ref ( ) const
inlineinherited

Increment the reference count.

Must be balanced by a call to unref().

◆ render()

void sksg::RenderNode::render ( SkCanvas *  ,
const RenderContext *  = nullptr 
) const
inherited

◆ revalidate()

const SkRect& sksg::Node::revalidate ( InvalidationController *  ,
const SkMatrix &   
)
inherited

◆ setVisible()

void sksg::RenderNode::setVisible ( bool  )
inherited

◆ unique()

bool SkRefCntBase::unique ( ) const
inlineinherited

May return true if the caller is the only owner.

Ensures that all previous owner's actions are complete.

◆ unobserveInval()

void sksg::Node::unobserveInval ( const sk_sp< Node > &  )
protectedinherited

◆ unref()

void SkRefCntBase::unref ( ) const
inlineinherited

Decrement the reference count.

If the reference count is 1 before the decrement, then delete the object. Note that if this is the case, then the object needs to have been allocated via new, and not on the stack.

Member Data Documentation

◆ fInvalObserver

Node* sksg::Node::fInvalObserver
inherited

◆ fInvalObserverArray

std::vector<Node*>* sksg::Node::fInvalObserverArray
inherited
The documentation for this class was generated from the following file: