Skia
2D Graphics Library
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | List of all members
sksg::MaskEffect Class Referencefinal

Concrete Effect node, applying a mask to its descendants. More...

#include <SkSGMaskEffect.h>

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

Public Types

enum class  Mode : uint32_t { kAlphaNormal , kAlphaInvert , kLumaNormal , kLumaInvert }
 

Public Member Functions

 ~MaskEffect () override
 
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...
 

Static Public Member Functions

static sk_sp< MaskEffect > Make (sk_sp< RenderNode > child, sk_sp< RenderNode > mask, Mode mode=Mode::kAlphaNormal)
 

Protected Types

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

Protected Member Functions

 MaskEffect (sk_sp< RenderNode >, sk_sp< RenderNode > mask, Mode)
 
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

Concrete Effect node, applying a mask to its descendants.

Member Enumeration Documentation

◆ InvalTraits

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

◆ Mode

enum sksg::MaskEffect::Mode : uint32_t
strong
Enumerator
kAlphaNormal 
kAlphaInvert 
kLumaNormal 
kLumaInvert 

Constructor & Destructor Documentation

◆ ~MaskEffect()

sksg::MaskEffect::~MaskEffect ( )
override

◆ MaskEffect()

sksg::MaskEffect::MaskEffect ( sk_sp< RenderNode >  ,
sk_sp< RenderNode >  mask,
Mode   
)
protected

Member Function Documentation

◆ bounds()

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

◆ getChild()

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

◆ hasInval()

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

◆ invalidate()

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

◆ isVisible()

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

◆ Make()

static sk_sp<MaskEffect> sksg::MaskEffect::Make ( sk_sp< RenderNode >  child,
sk_sp< RenderNode >  mask,
Mode  mode = Mode::kAlphaNormal 
)
inlinestatic

◆ 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::MaskEffect::onNodeAt ( const SkPoint &  ) const
overrideprotectedvirtual

Reimplemented from sksg::EffectNode.

◆ onRender()

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

Reimplemented from sksg::EffectNode.

◆ onRevalidate()

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

Reimplemented from sksg::EffectNode.

◆ 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: