sksg::CustomRenderNode Class Reference

Clients outside SkSG looking to implement custom render nodes, should derive from this class instead of RenderNode. More...

#include <SkSGRenderNode.h>

Inheritance diagram for sksg::CustomRenderNode:

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
	CustomRenderNode (std::vector< sk_sp< RenderNode >> &&children)
	~CustomRenderNode () override
const std::vector< sk_sp< RenderNode > > &	children () const
bool	hasChildrenInval () const
virtual void	onRender (SkCanvas *, const RenderContext *) const =0
virtual const RenderNode *	onNodeAt (const SkPoint &p) const =0
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 > &)

Detailed Description

Clients outside SkSG looking to implement custom render nodes, should derive from this class instead of RenderNode.

It handles various book-keeping, and provides a controlled extension point.

Member Enumeration Documentation

InvalTraits

enum sksg::Node::InvalTraits

protectedinherited

Enumerator
kBubbleDamage_Trait
kOverrideDamage_Trait

Constructor & Destructor Documentation

CustomRenderNode()

sksg::CustomRenderNode::CustomRenderNode ( std::vector< sk_sp< RenderNode >> &&  children )

explicitprotected

~CustomRenderNode()

sksg::CustomRenderNode::~CustomRenderNode ( )

overrideprotected

Member Function Documentation

bounds()

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

inlineprotectedinherited

children()

const std::vector<sk_sp<RenderNode> >& sksg::CustomRenderNode::children ( ) const

inlineprotected

hasChildrenInval()

bool sksg::CustomRenderNode::hasChildrenInval ( ) const

protected

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()

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

protectedpure virtualinherited

Implemented in sksg::TransformEffect, sksg::BlenderEffect, sksg::ImageFilterEffect, sksg::OpacityEffect, sksg::MaskEffect, sksg::Image, sksg::Group, sksg::EffectNode, sksg::Draw, sksg::ClipEffect, and sksg::ColorFilter.

onRender()

virtual void sksg::RenderNode::onRender ( SkCanvas *  , const RenderContext *    ) const

protectedpure virtualinherited

Implemented in sksg::TransformEffect, sksg::BlenderEffect, sksg::ImageFilterEffect, sksg::MaskShaderEffect, sksg::ShaderEffect, sksg::OpacityEffect, sksg::MaskEffect, sksg::Image, sksg::Group, sksg::EffectNode, sksg::Draw, sksg::ExternalColorFilter, sksg::ClipEffect, and sksg::ColorFilter.

onRevalidate()

virtual SkRect sksg::Node::onRevalidate ( InvalidationController *  , const SkMatrix &  ctm  )

protectedpure virtualinherited

Implemented in sksg::TransformEffect, sksg::Matrix< T >, sksg::Text, sksg::ImageFilterEffect, sksg::ShaderEffect, sksg::RRect, sksg::Rect, sksg::Plane, sksg::Path, sksg::ShaderPaint, sksg::Color, sksg::OpacityEffect, sksg::Merge, sksg::MaskEffect, sksg::Image, sksg::Group, sksg::EffectNode, sksg::Draw, sksg::ClipEffect, sksg::ImageFilter, sksg::Shader, sksg::GeometryEffect, and sksg::ColorFilter.

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:

• /CHECKOUT/modules/sksg/include/SkSGRenderNode.h