CustomXP Class Reference

Inheritance diagram for CustomXP:

Public Member Functions
	CustomXP (SkBlendMode mode, skgpu::BlendEquation hwBlendEquation)
	CustomXP (SkBlendMode mode, GrProcessorAnalysisCoverage coverage)
const char *	name () const override
std::unique_ptr< ProgramImpl >	makeProgramImpl () const override
GrXferBarrierType	xferBarrierType (const GrCaps &) const override
Public Member Functions inherited from GrXferProcessor
void	addToKey (const GrShaderCaps &, skgpu::KeyBuilder *, const GrSurfaceOrigin *originIfDstTexture, bool usesInputAttachmentForDstRead) const
skgpu::BlendInfo	getBlendInfo () const
bool	willReadDstColor () const
bool	hasSecondaryOutput () const
bool	isLCD () const
bool	isEqual (const GrXferProcessor &that) const
Public Member Functions inherited from GrProcessor
virtual	~GrProcessor ()=default
void *	operator new (size_t size)
void *	operator new (size_t object_size, size_t footer_size)
void	operator delete (void *target)
void *	operator new (size_t size, void *placement)
void	operator delete (void *target, void *placement)
template<typename T >
const T &	cast () const
ClassID	classID () const
Public Member Functions inherited from GrNonAtomicRef< GrXferProcessor >
	GrNonAtomicRef ()
bool	unique () const
int	refCnt () const
void	ref () const
void	unref () const
Public Member Functions inherited from SkNoncopyable
	SkNoncopyable ()=default
	SkNoncopyable (SkNoncopyable &&)=default
SkNoncopyable &	operator= (SkNoncopyable &&)=default

Private Member Functions
void	onAddToKey (const GrShaderCaps &, skgpu::KeyBuilder *) const override
void	onGetBlendInfo (skgpu::BlendInfo *) const override
bool	onIsEqual (const GrXferProcessor &xpBase) const override

Additional Inherited Members
Public Types inherited from GrProcessor
enum	ClassID {   kNull_ClassID , kAttributeTestProcessor_ClassID , kBigKeyProcessor_ClassID , kBlendFragmentProcessor_ClassID ,   kBlockInputFragmentProcessor_ClassID , kButtCapStrokedCircleGeometryProcessor_ClassID , kCircleGeometryProcessor_ClassID , kCircularRRectEffect_ClassID ,   kClockwiseTestProcessor_ClassID , kColorTableEffect_ClassID , kCoverageSetOpXP_ClassID , kCustomXP_ClassID ,   kDashingCircleEffect_ClassID , kDashingLineEffect_ClassID , kDefaultGeoProc_ClassID , kDeviceSpace_ClassID ,   kDIEllipseGeometryProcessor_ClassID , kDisableColorXP_ClassID , kDrawAtlasPathShader_ClassID , kEllipseGeometryProcessor_ClassID ,   kEllipticalRRectEffect_ClassID , kFwidthSquircleTestProcessor_ClassID , kGP_ClassID , kGrBicubicEffect_ClassID ,   kGrBitmapTextGeoProc_ClassID , kGrColorSpaceXformEffect_ClassID , kGrConicEffect_ClassID , kGrConvexPolyEffect_ClassID ,   kGrDiffuseLightingEffect_ClassID , kGrDisplacementMapEffect_ClassID , kGrDistanceFieldA8TextGeoProc_ClassID , kGrDistanceFieldLCDTextGeoProc_ClassID ,   kGrDistanceFieldPathGeoProc_ClassID , kGrFillRRectOp_Processor_ClassID , kGrGaussianConvolutionFragmentProcessor_ClassID , kGrMatrixConvolutionEffect_ClassID ,   kGrMatrixEffect_ClassID , kGrMeshTestProcessor_ClassID , kGrMorphologyEffect_ClassID , kGrPerlinNoise2Effect_ClassID ,   kGrPipelineDynamicStateTestProcessor_ClassID , kGrQuadEffect_ClassID , kGrRRectShadowGeoProc_ClassID , kGrSkSLFP_ClassID ,   kGrSpecularLightingEffect_ClassID , kGrTextureEffect_ClassID , kGrUnrolledBinaryGradientColorizer_ClassID , kGrYUVtoRGBEffect_ClassID ,   kHighPrecisionFragmentProcessor_ClassID , kLatticeGP_ClassID , kPDLCDXferProcessor_ClassID , kPorterDuffXferProcessor_ClassID ,   kPremulFragmentProcessor_ClassID , kQuadEdgeEffect_ClassID , kQuadPerEdgeAAGeometryProcessor_ClassID , kSeriesFragmentProcessor_ClassID ,   kShaderPDXferProcessor_ClassID , kSurfaceColorProcessor_ClassID , kSwizzleFragmentProcessor_ClassID , kTessellate_BoundingBoxShader_ClassID ,   kTessellate_GrModulateAtlasCoverageEffect_ClassID , kTessellate_GrStrokeTessellationShader_ClassID , kTessellate_HullShader_ClassID , kTessellate_MiddleOutShader_ClassID ,   kTessellate_SimpleTriangleShader_ClassID , kTessellationTestTriShader_ClassID , kTestFP_ClassID , kTestRectOp_ClassID ,   kVertexColorSpaceBenchGP_ClassID , kVerticesGP_ClassID }
Protected Member Functions inherited from GrXferProcessor
	GrXferProcessor (ClassID classID)
	GrXferProcessor (ClassID classID, bool willReadDstColor, GrProcessorAnalysisCoverage)
Protected Member Functions inherited from GrProcessor
	GrProcessor (ClassID classID)
	GrProcessor (const GrProcessor &)=delete
GrProcessor &	operator= (const GrProcessor &)=delete
Protected Attributes inherited from GrProcessor
const ClassID	fClassID

Detailed Description

Definition at line 82 of file GrCustomXfermode.cpp.

Constructor & Destructor Documentation

CustomXP() [1/2]

CustomXP::CustomXP ( SkBlendMode  mode, skgpu::BlendEquation  hwBlendEquation  )

inline

Definition at line 84 of file GrCustomXfermode.cpp.

        : INHERITED(kCustomXP_ClassID)
        , fMode(mode)
        , fHWBlendEquation(hwBlendEquation) {}

CustomXP() [2/2]

CustomXP::CustomXP ( SkBlendMode  mode, GrProcessorAnalysisCoverage  coverage  )

inline

Definition at line 89 of file GrCustomXfermode.cpp.

            : INHERITED(kCustomXP_ClassID, /*willReadDstColor=*/true, coverage)
            , fMode(mode)
            , fHWBlendEquation(skgpu::BlendEquation::kIllegal) {
    }

Member Function Documentation

makeProgramImpl()

std::unique_ptr< GrXferProcessor::ProgramImpl > CustomXP::makeProgramImpl ( ) const

overridevirtual

Returns a new instance of the appropriate GL implementation class for the given GrXferProcessor; caller is responsible for deleting the object.

Implements GrXferProcessor.

Definition at line 127 of file GrCustomXfermode.cpp.

                                                                          {
    SkASSERT(this->willReadDstColor() != this->hasHWBlendEquation());
 
    class Impl : public ProgramImpl {
    private:
        void emitOutputsForBlendState(const EmitArgs& args) override {
            const CustomXP& xp = args.fXP.cast<CustomXP>();
            SkASSERT(xp.hasHWBlendEquation());
 
            GrGLSLXPFragmentBuilder* fragBuilder = args.fXPFragBuilder;
            fragBuilder->enableAdvancedBlendEquationIfNeeded(xp.fHWBlendEquation);
 
            // Apply coverage by multiplying it into the src color before blending. This will "just
            // work" automatically. (See analysisProperties())
            fragBuilder->codeAppendf("%s = %s * %s;",
                                     args.fOutputPrimary,
                                     args.fInputCoverage,
                                     args.fInputColor);
        }
 
        void emitBlendCodeForDstRead(GrGLSLXPFragmentBuilder* fragBuilder,
                                     GrGLSLUniformHandler* uniformHandler,
                                     const char* srcColor,
                                     const char* srcCoverage,
                                     const char* dstColor,
                                     const char* outColor,
                                     const char* outColorSecondary,
                                     const GrXferProcessor& proc) override {
            const CustomXP& xp = proc.cast<CustomXP>();
            SkASSERT(!xp.hasHWBlendEquation());
 
            std::string blendExpr = GrGLSLBlend::BlendExpression(
                    &xp, uniformHandler, &fBlendUniform, srcColor, dstColor, xp.fMode);
            fragBuilder->codeAppendf("%s = %s;", outColor, blendExpr.c_str());
 
            // Apply coverage.
            DefaultCoverageModulation(fragBuilder,
                                      srcCoverage,
                                      dstColor,
                                      outColor,
                                      outColorSecondary,
                                      xp);
        }
 
        void onSetData(const GrGLSLProgramDataManager& pdman,
                       const GrXferProcessor& proc) override {
            if (fBlendUniform.isValid()) {
                const CustomXP& xp = proc.cast<CustomXP>();
                GrGLSLBlend::SetBlendModeUniformData(pdman, fBlendUniform, xp.fMode);
            }
        }
 
        GrGLSLUniformHandler::UniformHandle fBlendUniform;
    };
 
    return std::make_unique<Impl>();
}

name()

const char * CustomXP::name ( ) const

inlineoverridevirtual

Human-meaningful string to identify this processor; may be embedded in generated shader code and must be a legal SkSL identifier prefix.

Implements GrProcessor.

Definition at line 95 of file GrCustomXfermode.cpp.

{ return "Custom Xfermode"; }

onAddToKey()

void CustomXP::onAddToKey ( const GrShaderCaps &  , skgpu::KeyBuilder *    ) const

overrideprivatevirtual

Adds a key on the skgpu::KeyBuilder that reflects any variety in the code that may be emitted by the xfer processor subclass.

Implements GrXferProcessor.

Definition at line 116 of file GrCustomXfermode.cpp.

                                                                            {
    if (this->hasHWBlendEquation()) {
        SkASSERT(caps.fAdvBlendEqInteraction > 0);  // 0 will mean !xp.hasHWBlendEquation().
        b->addBool(true, "has hardware blend equation");
        b->add32(caps.fAdvBlendEqInteraction);
    } else {
        b->addBool(false, "has hardware blend equation");
        b->add32(GrGLSLBlend::BlendKey(fMode));
    }
}

onGetBlendInfo()

void CustomXP::onGetBlendInfo ( skgpu::BlendInfo *  ) const

overrideprivatevirtual

If we are not performing a dst read, retrieves the fixed-function blend state required by the subclass. When using dst reads, the base class controls the fixed-function blend state and this method will not be called. The BlendInfo struct comes initialized to "no blending".

Reimplemented from GrXferProcessor.

Definition at line 197 of file GrCustomXfermode.cpp.

                                                             {
    if (this->hasHWBlendEquation()) {
        blendInfo->fEquation = fHWBlendEquation;
    }
}

onIsEqual()

bool CustomXP::onIsEqual ( const GrXferProcessor &  xpBase ) const

overrideprivatevirtual

Implements GrXferProcessor.

Definition at line 185 of file GrCustomXfermode.cpp.

                                                           {
    const CustomXP& s = other.cast<CustomXP>();
    return fMode == s.fMode && fHWBlendEquation == s.fHWBlendEquation;
}

xferBarrierType()

GrXferBarrierType CustomXP::xferBarrierType ( const GrCaps &  caps ) const

overridevirtual

Returns the barrier type, if any, that this XP will require. Note that the possibility that a kTexture type barrier is required is handled by the GrPipeline and need not be considered by subclass overrides of this function.

Reimplemented from GrXferProcessor.

Definition at line 190 of file GrCustomXfermode.cpp.

                                                                    {
    if (this->hasHWBlendEquation() && !caps.advancedCoherentBlendEquationSupport()) {
        return kBlend_GrXferBarrierType;
    }
    return kNone_GrXferBarrierType;
}

---

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

• third_party/skia/src/gpu/ganesh/effects/GrCustomXfermode.cpp