#include <SkClipStack.h>

Public Types
enum class	DeviceSpaceType { kEmpty , kRect , kRRect , kPath , kShader , kLastType = kShader }

Public Member Functions
	Element ()

	Element (const Element &)

	Element (const SkRect &rect, const SkMatrix &m, SkClipOp op, bool doAA)

	Element (const SkRRect &rrect, const SkMatrix &m, SkClipOp op, bool doAA)

	Element (const SkPath &path, const SkMatrix &m, SkClipOp op, bool doAA)

	Element (sk_sp< SkShader > shader)

	Element (const SkRect &rect, bool doAA)

	~Element ()

bool	operator== (const Element &element) const

bool	operator!= (const Element &element) const
	Call to get the type of the clip element.

DeviceSpaceType	getDeviceSpaceType () const
	Call to get the save count associated with this clip element.

int	getSaveCount () const
	Call if getDeviceSpaceType() is kPath to get the path.

const SkPath &	getDeviceSpacePath () const
	Call if getDeviceSpaceType() is kRRect to get the round-rect.

const SkRRect &	getDeviceSpaceRRect () const
	Call if getDeviceSpaceType() is kRect to get the rect.

const SkRect &	getDeviceSpaceRect () const
	Call if getDeviceSpaceType() is kShader to get a reference to the clip shader.

sk_sp< SkShader >	refShader () const

const SkShader *	getShader () const

SkClipOp	getOp () const

bool	isReplaceOp () const
	Call to get the element as a path, regardless of its type.

void	asDeviceSpacePath (SkPath *path) const
	Call if getType() is not kPath to get the element as a round rect.

const SkRRect &	asDeviceSpaceRRect () const

bool	isAA () const
	Inverts the fill of the clip shape. Note that a kEmpty element remains kEmpty.

void	invertShapeFillType ()

uint32_t	getGenID () const

const SkRect &	getBounds () const

bool	contains (const SkRect &rect) const

bool	contains (const SkRRect &rrect) const

bool	isInverseFilled () const

Static Public Attributes
static const int	kTypeCnt = (int)DeviceSpaceType::kLastType + 1

Friends
class	SkClipStack

Detailed Description

An element of the clip stack. It represents a shape combined with the prevoius clip using a set operator. Each element can be antialiased or not.

Definition at line 49 of file SkClipStack.h.

Member Enumeration Documentation

◆ DeviceSpaceType

enum class SkClipStack::Element::DeviceSpaceType

strong

This indicates the shape type of the clip element in device space.

Enumerator
kEmpty	This element makes the clip empty (regardless of previous elements). This element combines a device space rect with the current clip.
kRect	This element combines a device space round-rect with the current clip.
kRRect	This element combines a device space path with the current clip.
kPath	This element does not have geometry, but applies a shader to the clip.
kShader
kLastType

Definition at line 52 of file SkClipStack.h.

                                   {
            //!< This element makes the clip empty (regardless of previous elements).
            kEmpty,
            //!< This element combines a device space rect with the current clip.
            kRect,
            //!< This element combines a device space round-rect with the current clip.
            kRRect,
            //!< This element combines a device space path with the current clip.
            kPath,
            //!< This element does not have geometry, but applies a shader to the clip
            kShader,
 
            kLastType = kShader
        };

Constructor & Destructor Documentation

◆ Element() [1/7]

SkClipStack::Element::Element ( )

inline

Definition at line 68 of file SkClipStack.h.

                  {
            this->initCommon(0, SkClipOp::kIntersect, false);
            this->setEmpty();
        }

◆ Element() [2/7]

SkClipStack::Element::Element ( const Element & that )

Definition at line 22 of file SkClipStack.cpp.

                                               {
    switch (that.getDeviceSpaceType()) {
        case DeviceSpaceType::kEmpty:
            fDeviceSpaceRRect.setEmpty();
            fDeviceSpacePath.reset();
            fShader.reset();
            break;
        case DeviceSpaceType::kRect:  // Rect uses rrect
        case DeviceSpaceType::kRRect:
            fDeviceSpacePath.reset();
            fShader.reset();
            fDeviceSpaceRRect = that.fDeviceSpaceRRect;
            break;
        case DeviceSpaceType::kPath:
            fShader.reset();
            fDeviceSpacePath.set(that.getDeviceSpacePath());
            break;
        case DeviceSpaceType::kShader:
            fDeviceSpacePath.reset();
            fShader = that.fShader;
            break;
    }
 
    fSaveCount = that.fSaveCount;
    fOp = that.fOp;
    fDeviceSpaceType = that.fDeviceSpaceType;
    fDoAA = that.fDoAA;
    fIsReplace = that.fIsReplace;
    fFiniteBoundType = that.fFiniteBoundType;
    fFiniteBound = that.fFiniteBound;
    fIsIntersectionOfRects = that.fIsIntersectionOfRects;
    fGenID = that.fGenID;
}

◆ Element() [3/7]

SkClipStack::Element::Element	(	const SkRect &	rect,
		const SkMatrix &	m,
		SkClipOp	op,
		bool	doAA
	)

inline

Definition at line 75 of file SkClipStack.h.

                                                                               {
            this->initRect(0, rect, m, op, doAA);
        }

◆ Element() [4/7]

SkClipStack::Element::Element	(	const SkRRect &	rrect,
		const SkMatrix &	m,
		SkClipOp	op,
		bool	doAA
	)

inline

Definition at line 79 of file SkClipStack.h.

                                                                                 {
            this->initRRect(0, rrect, m, op, doAA);
        }

◆ Element() [5/7]

SkClipStack::Element::Element	(	const SkPath &	path,
		const SkMatrix &	m,
		SkClipOp	op,
		bool	doAA
	)

inline

Definition at line 83 of file SkClipStack.h.

                                                                               {
            this->initPath(0, path, m, op, doAA);
        }

◆ Element() [6/7]

SkClipStack::Element::Element ( sk_sp< SkShader > shader )

inline

Definition at line 87 of file SkClipStack.h.

                                        {
            this->initShader(0, std::move(shader));
        }

◆ Element() [7/7]

SkClipStack::Element::Element	(	const SkRect &	rect,
		bool	doAA
	)

inline

Definition at line 91 of file SkClipStack.h.

                                               {
            this->initReplaceRect(0, rect, doAA);
        }

◆ ~Element()

SkClipStack::Element::~Element ( )

default

Member Function Documentation

◆ asDeviceSpacePath()

void SkClipStack::Element::asDeviceSpacePath ( SkPath * path ) const

Call if getType() is not kPath to get the element as a round rect.

Definition at line 255 of file SkClipStack.cpp.

                                                             {
    switch (fDeviceSpaceType) {
        case DeviceSpaceType::kEmpty:
            path->reset();
            break;
        case DeviceSpaceType::kRect:
            path->reset();
            path->addRect(this->getDeviceSpaceRect());
            break;
        case DeviceSpaceType::kRRect:
            path->reset();
            path->addRRect(fDeviceSpaceRRect);
            break;
        case DeviceSpaceType::kPath:
            *path = *fDeviceSpacePath;
            break;
        case DeviceSpaceType::kShader:
            path->reset();
            path->addRect(SkRectPriv::MakeLargeS32());
            break;
    }
    path->setIsVolatile(true);
}

◆ asDeviceSpaceRRect()

const SkRRect & SkClipStack::Element::asDeviceSpaceRRect ( ) const

inline

Definition at line 143 of file SkClipStack.h.

                                                  {
            SkASSERT(DeviceSpaceType::kPath != fDeviceSpaceType);
            return fDeviceSpaceRRect;
        }

◆ contains() [1/2]

bool SkClipStack::Element::contains ( const SkRect & rect ) const

Conservatively checks whether the clip shape contains the rect/rrect. (Whether the shape is inverse filled is not considered.)

Definition at line 106 of file SkClipStack.cpp.

                                                          {
    switch (fDeviceSpaceType) {
        case DeviceSpaceType::kRect:
            return this->getDeviceSpaceRect().contains(rect);
        case DeviceSpaceType::kRRect:
            return fDeviceSpaceRRect.contains(rect);
        case DeviceSpaceType::kPath:
            return fDeviceSpacePath->conservativelyContainsRect(rect);
        case DeviceSpaceType::kEmpty:
        case DeviceSpaceType::kShader:
            return false;
        default:
            SkDEBUGFAIL("Unexpected type.");
            return false;
    }
}

◆ contains() [2/2]

bool SkClipStack::Element::contains ( const SkRRect & rrect ) const

Definition at line 123 of file SkClipStack.cpp.

                                                            {
    switch (fDeviceSpaceType) {
        case DeviceSpaceType::kRect:
            return this->getDeviceSpaceRect().contains(rrect.getBounds());
        case DeviceSpaceType::kRRect:
            // We don't currently have a generalized rrect-rrect containment.
            return fDeviceSpaceRRect.contains(rrect.getBounds()) || rrect == fDeviceSpaceRRect;
        case DeviceSpaceType::kPath:
            return fDeviceSpacePath->conservativelyContainsRect(rrect.getBounds());
        case DeviceSpaceType::kEmpty:
        case DeviceSpaceType::kShader:
            return false;
        default:
            SkDEBUGFAIL("Unexpected type.");
            return false;
    }
}

◆ getBounds()

const SkRect & SkClipStack::Element::getBounds ( ) const

Gets the bounds of the clip element, either the rect or path bounds. (Whether the shape is inverse filled is not considered.)

Definition at line 84 of file SkClipStack.cpp.

                                                  {
    static const SkRect kEmpty = {0, 0, 0, 0};
    static const SkRect kInfinite = SkRectPriv::MakeLargeS32();
    switch (fDeviceSpaceType) {
        case DeviceSpaceType::kRect:  // fallthrough
        case DeviceSpaceType::kRRect:
            return fDeviceSpaceRRect.getBounds();
        case DeviceSpaceType::kPath:
            return fDeviceSpacePath->getBounds();
        case DeviceSpaceType::kShader:
            // Shaders have infinite bounds since any pixel could have clipped or full coverage
            // (which is different from wide-open, where every pixel has 1.0 coverage, or empty
            //  where every pixel has 0.0 coverage).
            return kInfinite;
        case DeviceSpaceType::kEmpty:
            return kEmpty;
        default:
            SkDEBUGFAIL("Unexpected type.");
            return kEmpty;
    }
}

◆ getDeviceSpacePath()

const SkPath & SkClipStack::Element::getDeviceSpacePath ( ) const

inline

Call if getDeviceSpaceType() is kRRect to get the round-rect.

Definition at line 107 of file SkClipStack.h.

◆ getDeviceSpaceRect()

const SkRect & SkClipStack::Element::getDeviceSpaceRect ( ) const

inline

Call if getDeviceSpaceType() is kShader to get a reference to the clip shader.

Definition at line 119 of file SkClipStack.h.

◆ getDeviceSpaceRRect()

const SkRRect & SkClipStack::Element::getDeviceSpaceRRect ( ) const

inline

Call if getDeviceSpaceType() is kRect to get the rect.

Definition at line 113 of file SkClipStack.h.

◆ getDeviceSpaceType()

DeviceSpaceType SkClipStack::Element::getDeviceSpaceType ( ) const

inline

Call to get the save count associated with this clip element.

Definition at line 101 of file SkClipStack.h.

◆ getGenID()

uint32_t SkClipStack::Element::getGenID ( ) const

inline

The GenID can be used by clip stack clients to cache representations of the clip. The ID corresponds to the set of clip elements up to and including this element within the stack not to the element itself. That is the same clip path in different stacks will have a different ID since the elements produce different clip result in the context of their stacks.

Definition at line 160 of file SkClipStack.h.

160{ SkASSERT(kInvalidGenID != fGenID); return fGenID; }

SkClipStack::kInvalidGenID

static const uint32_t kInvalidGenID

Definition SkClipStack.h:382

◆ getOp()

SkClipOp SkClipStack::Element::getOp ( ) const

inline

Definition at line 135 of file SkClipStack.h.

135{ return fOp; }

◆ getSaveCount()

int SkClipStack::Element::getSaveCount ( ) const

inline

Call if getDeviceSpaceType() is kPath to get the path.

Definition at line 104 of file SkClipStack.h.

◆ getShader()

const SkShader * SkClipStack::Element::getShader ( ) const

inline

Call if getDeviceSpaceType() is not kEmpty to get the set operation used to combine this element.

Definition at line 129 of file SkClipStack.h.

◆ invertShapeFillType()

void SkClipStack::Element::invertShapeFillType ( )

Definition at line 141 of file SkClipStack.cpp.

                                             {
    switch (fDeviceSpaceType) {
        case DeviceSpaceType::kRect:
            fDeviceSpacePath.init();
            fDeviceSpacePath->addRect(this->getDeviceSpaceRect());
            fDeviceSpacePath->setFillType(SkPathFillType::kInverseEvenOdd);
            fDeviceSpaceType = DeviceSpaceType::kPath;
            break;
        case DeviceSpaceType::kRRect:
            fDeviceSpacePath.init();
            fDeviceSpacePath->addRRect(fDeviceSpaceRRect);
            fDeviceSpacePath->setFillType(SkPathFillType::kInverseEvenOdd);
            fDeviceSpaceType = DeviceSpaceType::kPath;
            break;
        case DeviceSpaceType::kPath:
            fDeviceSpacePath->toggleInverseFillType();
            break;
        case DeviceSpaceType::kShader:
            fShader = as_SB(fShader)->makeInvertAlpha();
            break;
        case DeviceSpaceType::kEmpty:
            // Should this set to an empty, inverse filled path?
            break;
    }
}

◆ isAA()

bool SkClipStack::Element::isAA ( ) const

inline

Inverts the fill of the clip shape. Note that a kEmpty element remains kEmpty.

If getType() is not kEmpty this indicates whether the clip shape should be anti-aliased when it is rasterized.

Definition at line 150 of file SkClipStack.h.

◆ isInverseFilled()

bool SkClipStack::Element::isInverseFilled ( ) const

inline

Is the clip shape inverse filled.

Definition at line 178 of file SkClipStack.h.

                                     {
            return DeviceSpaceType::kPath == fDeviceSpaceType &&
                   fDeviceSpacePath->isInverseFillType();
        }

◆ isReplaceOp()

bool SkClipStack::Element::isReplaceOp ( ) const

inline

Call to get the element as a path, regardless of its type.

Definition at line 137 of file SkClipStack.h.

◆ operator!=()

bool SkClipStack::Element::operator!= ( const Element & element ) const

inline

Call to get the type of the clip element.

Definition at line 98 of file SkClipStack.h.

◆ operator==()

bool SkClipStack::Element::operator== ( const Element & element ) const

Definition at line 58 of file SkClipStack.cpp.

                                                                 {
    if (this == &element) {
        return true;
    }
    if (fOp != element.fOp || fDeviceSpaceType != element.fDeviceSpaceType ||
        fDoAA != element.fDoAA || fIsReplace != element.fIsReplace ||
        fSaveCount != element.fSaveCount) {
        return false;
    }
    switch (fDeviceSpaceType) {
        case DeviceSpaceType::kShader:
            return this->getShader() == element.getShader();
        case DeviceSpaceType::kPath:
            return this->getDeviceSpacePath() == element.getDeviceSpacePath();
        case DeviceSpaceType::kRRect:
            return fDeviceSpaceRRect == element.fDeviceSpaceRRect;
        case DeviceSpaceType::kRect:
            return this->getDeviceSpaceRect() == element.getDeviceSpaceRect();
        case DeviceSpaceType::kEmpty:
            return true;
        default:
            SkDEBUGFAIL("Unexpected type.");
            return false;
    }
}

◆ refShader()

sk_sp< SkShader > SkClipStack::Element::refShader ( ) const

inline

Definition at line 126 of file SkClipStack.h.

                                          {
            return fShader;
        }

Friends And Related Symbol Documentation

◆ SkClipStack

friend class SkClipStack

friend

Definition at line 192 of file SkClipStack.h.

Member Data Documentation

◆ kTypeCnt

const int SkClipStack::Element::kTypeCnt = (int)DeviceSpaceType::kLastType + 1

static

Definition at line 66 of file SkClipStack.h.

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

third_party/skia/src/core/SkClipStack.h
third_party/skia/src/core/SkClipStack.cpp

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ DeviceSpaceType

Constructor & Destructor Documentation

◆ Element() [1/7]

◆ Element() [2/7]

◆ Element() [3/7]

◆ Element() [4/7]

◆ Element() [5/7]

◆ Element() [6/7]

◆ Element() [7/7]

◆ ~Element()

Member Function Documentation

◆ asDeviceSpacePath()

◆ asDeviceSpaceRRect()

◆ contains() [1/2]

◆ contains() [2/2]

◆ getBounds()

◆ getDeviceSpacePath()

◆ getDeviceSpaceRect()

◆ getDeviceSpaceRRect()

◆ getDeviceSpaceType()

◆ getGenID()

◆ getOp()

◆ getSaveCount()

◆ getShader()

◆ invertShapeFillType()

◆ isAA()

◆ isInverseFilled()

◆ isReplaceOp()

◆ operator!=()

◆ operator==()

◆ refShader()

Friends And Related Symbol Documentation

◆ SkClipStack

Member Data Documentation

◆ kTypeCnt