GrUserStencilSettings Struct Reference

#include <GrUserStencilSettings.h>

Classes
struct	Attrs
struct	Init
struct	InitSeparate

Public Types
typedef GrTStencilFaceSettings< GrUserStencilTest, GrUserStencilOp >	Face

Public Member Functions
template<uint16_t Ref, GrUserStencilTest Test, uint16_t TestMask, GrUserStencilOp PassOp, GrUserStencilOp FailOp, uint16_t WriteMask, typename Attrs = Attrs<Test, PassOp, FailOp>>
constexpr	GrUserStencilSettings (const Init< Ref, Test, TestMask, PassOp, FailOp, WriteMask > &)
template<uint16_t CWRef, uint16_t CCWRef, GrUserStencilTest CWTest, GrUserStencilTest CCWTest, uint16_t CWTestMask, uint16_t CCWTestMask, GrUserStencilOp CWPassOp, GrUserStencilOp CCWPassOp, GrUserStencilOp CWFailOp, GrUserStencilOp CCWFailOp, uint16_t CWWriteMask, uint16_t CCWWriteMask, typename CWAttrs = Attrs<CWTest, CWPassOp, CWFailOp>, typename CCWAttrs = Attrs<CCWTest, CCWPassOp, CCWFailOp>>
constexpr	GrUserStencilSettings (const InitSeparate< CWRef, CCWRef, CWTest, CCWTest, CWTestMask, CCWTestMask, CWPassOp, CCWPassOp, CWFailOp, CCWFailOp, CWWriteMask, CCWWriteMask > &)
	GrUserStencilSettings ()=delete
	GrUserStencilSettings (const GrUserStencilSettings &)=delete
uint16_t	flags (bool hasStencilClip) const
bool	isDisabled (bool hasStencilClip) const
bool	testAlwaysPasses (bool hasStencilClip) const
bool	isTwoSided (bool hasStencilClip) const
bool	usesWrapOp (bool hasStencilClip) const
bool	isUnused () const

Static Public Member Functions
template<uint16_t Ref, GrUserStencilTest Test, uint16_t TestMask, GrUserStencilOp PassOp, GrUserStencilOp FailOp, uint16_t WriteMask>
static constexpr Init< Ref, Test, TestMask, PassOp, FailOp, WriteMask >	StaticInit ()
template<uint16_t CWRef, uint16_t CCWRef, GrUserStencilTest CWTest, GrUserStencilTest CCWTest, uint16_t CWTestMask, uint16_t CCWTestMask, GrUserStencilOp CWPassOp, GrUserStencilOp CCWPassOp, GrUserStencilOp CWFailOp, GrUserStencilOp CCWFailOp, uint16_t CWWriteMask, uint16_t CCWWriteMask>
static constexpr InitSeparate< CWRef, CCWRef, CWTest, CCWTest, CWTestMask, CCWTestMask, CWPassOp, CCWPassOp, CWFailOp, CCWFailOp, CWWriteMask, CCWWriteMask >	StaticInitSeparate ()

Public Attributes
const uint16_t	fCWFlags [2]
const Face	fCWFace
const uint16_t	fCCWFlags [2]
const Face	fCCWFace

Static Public Attributes
static const GrUserStencilSettings &	kUnused = gUnused

Detailed Description

This struct is a compile-time constant representation of user stencil settings. It describes in abstract terms how a draw will use the stencil buffer. It gets ODR-used at runtime to define a draw's stencil settings, and is later translated into concrete settings when the pipeline is finalized.

Definition at line 112 of file GrUserStencilSettings.h.

Member Typedef Documentation

Face

typedef GrTStencilFaceSettings<GrUserStencilTest, GrUserStencilOp> GrUserStencilSettings::Face

Definition at line 113 of file GrUserStencilSettings.h.

Constructor & Destructor Documentation

GrUserStencilSettings() [1/4]

template<uint16_t Ref, GrUserStencilTest Test, uint16_t TestMask, GrUserStencilOp PassOp, GrUserStencilOp FailOp, uint16_t WriteMask, typename Attrs = Attrs<Test, PassOp, FailOp>>

constexpr GrUserStencilSettings::GrUserStencilSettings ( const Init< Ref, Test, TestMask, PassOp, FailOp, WriteMask > &  )

inlineexplicitconstexpr

Definition at line 152 of file GrUserStencilSettings.h.

        : fCWFlags{(uint16_t)(Attrs::Flags(false) | kSingleSided_StencilFlag),
                      (uint16_t)(Attrs::Flags(true) | kSingleSided_StencilFlag)}
        , fCWFace{Ref, Test, Attrs::EffectiveTestMask(TestMask), PassOp, FailOp,
                 Attrs::EffectiveWriteMask(WriteMask)}
        , fCCWFlags{(uint16_t)(Attrs::Flags(false) | kSingleSided_StencilFlag),
                     (uint16_t)(Attrs::Flags(true) | kSingleSided_StencilFlag)}
        , fCCWFace{Ref, Test, Attrs::EffectiveTestMask(TestMask), PassOp, FailOp,
                Attrs::EffectiveWriteMask(WriteMask)} {
    }

GrUserStencilSettings() [2/4]

template<uint16_t CWRef, uint16_t CCWRef, GrUserStencilTest CWTest, GrUserStencilTest CCWTest, uint16_t CWTestMask, uint16_t CCWTestMask, GrUserStencilOp CWPassOp, GrUserStencilOp CCWPassOp, GrUserStencilOp CWFailOp, GrUserStencilOp CCWFailOp, uint16_t CWWriteMask, uint16_t CCWWriteMask, typename CWAttrs = Attrs<CWTest, CWPassOp, CWFailOp>, typename CCWAttrs = Attrs<CCWTest, CCWPassOp, CCWFailOp>>

constexpr GrUserStencilSettings::GrUserStencilSettings ( const InitSeparate< CWRef, CCWRef, CWTest, CCWTest, CWTestMask, CCWTestMask, CWPassOp, CCWPassOp, CWFailOp, CCWFailOp, CWWriteMask, CCWWriteMask > &  )

inlineexplicitconstexpr

Definition at line 172 of file GrUserStencilSettings.h.

        : fCWFlags{CWAttrs::Flags(false), CWAttrs::Flags(true)}
        , fCWFace{CWRef, CWTest, CWAttrs::EffectiveTestMask(CWTestMask), CWPassOp, CWFailOp,
                 CWAttrs::EffectiveWriteMask(CWWriteMask)}
        , fCCWFlags{CCWAttrs::Flags(false), CCWAttrs::Flags(true)}
        , fCCWFace{CCWRef, CCWTest, CCWAttrs::EffectiveTestMask(CCWTestMask), CCWPassOp, CCWFailOp,
                CCWAttrs::EffectiveWriteMask(CCWWriteMask)} {}

GrUserStencilSettings() [3/4]

GrUserStencilSettings::GrUserStencilSettings ( )

delete

GrUserStencilSettings() [4/4]

GrUserStencilSettings::GrUserStencilSettings ( const GrUserStencilSettings &  )

delete

Member Function Documentation

flags()

uint16_t GrUserStencilSettings::flags ( bool  hasStencilClip ) const

inline

Definition at line 187 of file GrUserStencilSettings.h.

                                              {
        return fCWFlags[hasStencilClip] & fCCWFlags[hasStencilClip];
    }

isDisabled()

bool GrUserStencilSettings::isDisabled ( bool  hasStencilClip ) const

inline

Definition at line 190 of file GrUserStencilSettings.h.

                                               {
        return this->flags(hasStencilClip) & kDisabled_StencilFlag;
    }

isTwoSided()

bool GrUserStencilSettings::isTwoSided ( bool  hasStencilClip ) const

inline

Definition at line 196 of file GrUserStencilSettings.h.

                                               {
        return !(this->flags(hasStencilClip) & kSingleSided_StencilFlag);
    }

isUnused()

bool GrUserStencilSettings::isUnused ( ) const

inline

Definition at line 210 of file GrUserStencilSettings.h.

{ return this == &kUnused; }

StaticInit()

template<uint16_t Ref, GrUserStencilTest Test, uint16_t TestMask, GrUserStencilOp PassOp, GrUserStencilOp FailOp, uint16_t WriteMask>

static constexpr Init< Ref, Test, TestMask, PassOp, FailOp, WriteMask > GrUserStencilSettings::StaticInit ( )

inlinestaticconstexpr

Definition at line 130 of file GrUserStencilSettings.h.

                                                                                       {
        return Init<Ref, Test, TestMask, PassOp, FailOp, WriteMask>();
    }

StaticInitSeparate()

template<uint16_t CWRef, uint16_t CCWRef, GrUserStencilTest CWTest, GrUserStencilTest CCWTest, uint16_t CWTestMask, uint16_t CCWTestMask, GrUserStencilOp CWPassOp, GrUserStencilOp CCWPassOp, GrUserStencilOp CWFailOp, GrUserStencilOp CCWFailOp, uint16_t CWWriteMask, uint16_t CCWWriteMask>

static constexpr InitSeparate< CWRef, CCWRef, CWTest, CCWTest, CWTestMask, CCWTestMask, CWPassOp, CCWPassOp, CWFailOp, CCWFailOp, CWWriteMask, CCWWriteMask > GrUserStencilSettings::StaticInitSeparate ( )

inlinestaticconstexpr

Definition at line 142 of file GrUserStencilSettings.h.

                                                                     {
        return InitSeparate<CWRef, CCWRef, CWTest, CCWTest, CWTestMask, CCWTestMask,
                            CWPassOp, CCWPassOp, CWFailOp, CCWFailOp, CWWriteMask, CCWWriteMask>();
    }

testAlwaysPasses()

bool GrUserStencilSettings::testAlwaysPasses ( bool  hasStencilClip ) const

inline

Definition at line 193 of file GrUserStencilSettings.h.

                                                     {
        return this->flags(hasStencilClip) & kTestAlwaysPasses_StencilFlag;
    }

usesWrapOp()

bool GrUserStencilSettings::usesWrapOp ( bool  hasStencilClip ) const

inline

Definition at line 199 of file GrUserStencilSettings.h.

                                               {
        return !(this->flags(hasStencilClip) & kNoWrapOps_StencilFlag);
    }

Member Data Documentation

fCCWFace

const Face GrUserStencilSettings::fCCWFace

Definition at line 206 of file GrUserStencilSettings.h.

fCCWFlags

const uint16_t GrUserStencilSettings::fCCWFlags[2]

Definition at line 205 of file GrUserStencilSettings.h.

fCWFace

const Face GrUserStencilSettings::fCWFace

Definition at line 204 of file GrUserStencilSettings.h.

fCWFlags

const uint16_t GrUserStencilSettings::fCWFlags[2]

Definition at line 203 of file GrUserStencilSettings.h.

kUnused

const GrUserStencilSettings & GrUserStencilSettings::kUnused = gUnused

static

Definition at line 208 of file GrUserStencilSettings.h.

---

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

• third_party/skia/src/gpu/ganesh/GrUserStencilSettings.h
• third_party/skia/src/gpu/ganesh/GrStencilSettings.cpp