GrPipeline Class Reference

#include <GrPipeline.h>

Classes
struct	InitArgs

Public Member Functions
bool	isScissorTestEnabled () const
const GrWindowRectsState &	getWindowRectsState () const
bool	usesConservativeRaster () const
bool	isWireframe () const
bool	snapVerticesToPixelCenters () const
bool	hasStencilClip () const
GrXferBarrierType	xferBarrierType (const GrCaps &) const
void	genKey (skgpu::KeyBuilder *, const GrCaps &) const
const skgpu::Swizzle &	writeSwizzle () const
void	visitProxies (const GrVisitProxyFunc &) const
void	setDstTextureUniforms (const GrGLSLProgramDataManager &pdm, GrGLSLBuiltinUniformHandles *fBuiltinUniformHandles) const
GrFragmentProcessors
int	numFragmentProcessors () const
int	numColorFragmentProcessors () const
bool	isColorFragmentProcessor (int idx) const
bool	isCoverageFragmentProcessor (int idx) const
bool	usesLocalCoords () const
void	visitTextureEffects (const std::function< void(const GrTextureEffect &)> &) const
const GrXferProcessor &	getXferProcessor () const
bool	usesDstTexture () const
bool	usesDstInputAttachment () const
const GrSurfaceProxyView &	dstProxyView () const
SkIPoint	dstTextureOffset () const
GrDstSampleFlags	dstSampleFlags () const
GrTexture *	peekDstTexture () const
const GrFragmentProcessor &	getFragmentProcessor (int idx) const

Friends
bool	operator& (Flags, InputFlags)

Creation
enum class	InputFlags : uint8_t { kNone = 0 , kConservativeRaster = (1 << 1) , kWireframe = (1 << 2) , kSnapVerticesToPixelCenters = (1 << 3) }
	GrPipeline (GrScissorTest scissor, SkBlendMode blend, const skgpu::Swizzle &writeSwizzle, InputFlags flags=InputFlags::kNone)
	GrPipeline (GrScissorTest, sk_sp< const GrXferProcessor >, const skgpu::Swizzle &writeSwizzle, InputFlags=InputFlags::kNone)
	GrPipeline (const InitArgs &args, sk_sp< const GrXferProcessor >, const GrAppliedHardClip &)
	GrPipeline (const InitArgs &, GrProcessorSet &&, GrAppliedClip &&)
	GrPipeline (const GrPipeline &)=delete
GrPipeline &	operator= (const GrPipeline &)=delete

Detailed Description

This immutable object contains information needed to build a shader program and set API state for a draw. It is used along with a GrGeometryProcessor and a source of geometric data to draw.

Definition at line 36 of file GrPipeline.h.

Member Enumeration Documentation

InputFlags

enum class GrPipeline::InputFlags : uint8_t

strong

Enumerator
kNone
kConservativeRaster	Cause every pixel to be rasterized that is touched by the triangle anywhere (not just at pixel center). Additionally, if using MSAA, the sample mask will always have 100% coverage. NOTE: The primitive type must be a triangle type.
kWireframe	Draws triangles as outlines.
kSnapVerticesToPixelCenters	Modifies the vertex shader so that vertices will be positioned at pixel centers.

Definition at line 43 of file GrPipeline.h.

                          : uint8_t {
        kNone = 0,
        /**
         * Cause every pixel to be rasterized that is touched by the triangle anywhere (not just at
         * pixel center). Additionally, if using MSAA, the sample mask will always have 100%
         * coverage.
         * NOTE: The primitive type must be a triangle type.
         */
        kConservativeRaster = (1 << 1),
        /**
         * Draws triangles as outlines.
         */
        kWireframe = (1 << 2),
        /**
         * Modifies the vertex shader so that vertices will be positioned at pixel centers.
         */
        kSnapVerticesToPixelCenters = (1 << 3),  // This value must be last. (See kLastInputFlag.)
    };

Constructor & Destructor Documentation

GrPipeline() [1/5]

GrPipeline::GrPipeline ( GrScissorTest  scissor, SkBlendMode  blend, const skgpu::Swizzle &  writeSwizzle, InputFlags  flags = InputFlags::kNone  )

inline

Creates a simple pipeline with default settings and no processors. The provided blend mode must be "Porter Duff" (<= kLastCoeffMode). If using GrScissorTest::kEnabled, the caller must specify a scissor rectangle through the DynamicState struct.

Definition at line 74 of file GrPipeline.h.

            : GrPipeline(scissor,
                         GrPorterDuffXPFactory::MakeNoCoverageXP(blend),
                         writeSwizzle,
                         flags) {}

GrPipeline() [2/5]

GrPipeline::GrPipeline	(	GrScissorTest	scissorTest,
		sk_sp< const GrXferProcessor >	xp,
		const skgpu::Swizzle &	writeSwizzle,
		InputFlags	inputFlags = InputFlags::kNone
	)

Definition at line 66 of file GrPipeline.cpp.

        : fWindowRectsState()
        , fFlags((Flags)inputFlags)
        , fXferProcessor(std::move(xp))
        , fWriteSwizzle(writeSwizzle) {
    if (GrScissorTest::kEnabled == scissorTest) {
        fFlags |= Flags::kScissorTestEnabled;
    }
}

GrPipeline() [3/5]

GrPipeline::GrPipeline	(	const InitArgs &	args,
		sk_sp< const GrXferProcessor >	xferProcessor,
		const GrAppliedHardClip &	hardClip
	)

Definition at line 18 of file GrPipeline.cpp.

        : fDstProxy(args.fDstProxyView)
        , fWindowRectsState(hardClip.windowRectsState())
        , fXferProcessor(std::move(xferProcessor))
        , fWriteSwizzle(args.fWriteSwizzle) {
    fFlags = (Flags)args.fInputFlags;
    if (hardClip.hasStencilClip()) {
        fFlags |= Flags::kHasStencilClip;
    }
    if (hardClip.scissorState().enabled()) {
        fFlags |= Flags::kScissorTestEnabled;
    }
    // If we have any special dst sample flags we better also have a dst proxy
    SkASSERT(this->dstSampleFlags() == GrDstSampleFlags::kNone || this->dstProxyView());
}

GrPipeline() [4/5]

GrPipeline::GrPipeline	(	const InitArgs &	args,
		GrProcessorSet &&	processors,
		GrAppliedClip &&	appliedClip
	)

Definition at line 36 of file GrPipeline.cpp.

        : GrPipeline(args, processors.refXferProcessor(), appliedClip.hardClip()) {
    SkASSERT(processors.isFinalized());
    // Copy GrFragmentProcessors from GrProcessorSet to Pipeline
    fNumColorProcessors = processors.hasColorFragmentProcessor() ? 1 : 0;
    int numTotalProcessors = fNumColorProcessors +
                             (processors.hasCoverageFragmentProcessor() ? 1 : 0) +
                             (appliedClip.hasCoverageFragmentProcessor() ? 1 : 0);
    fFragmentProcessors.reset(numTotalProcessors);
 
    int currFPIdx = 0;
    if (processors.hasColorFragmentProcessor()) {
        fFragmentProcessors[currFPIdx++] = processors.detachColorFragmentProcessor();
    }
    if (processors.hasCoverageFragmentProcessor()) {
        fFragmentProcessors[currFPIdx++] = processors.detachCoverageFragmentProcessor();
    }
    if (appliedClip.hasCoverageFragmentProcessor()) {
        fFragmentProcessors[currFPIdx++] = appliedClip.detachCoverageFragmentProcessor();
    }
}

GrPipeline() [5/5]

GrPipeline::GrPipeline ( const GrPipeline &  )

delete

Member Function Documentation

dstProxyView()

const GrSurfaceProxyView & GrPipeline::dstProxyView ( ) const

inline

This returns the GrSurfaceProxyView for the texture used to access the dst color. If the GrXferProcessor does not use the dst color then the proxy on the GrSurfaceProxyView will be nullptr.

Definition at line 138 of file GrPipeline.h.

{ return fDstProxy.proxyView(); }

dstSampleFlags()

GrDstSampleFlags GrPipeline::dstSampleFlags ( ) const

inline

Definition at line 142 of file GrPipeline.h.

{ return fDstProxy.dstSampleFlags(); }

dstTextureOffset()

SkIPoint GrPipeline::dstTextureOffset ( ) const

inline

Definition at line 140 of file GrPipeline.h.

{ return fDstProxy.offset(); }

genKey()

void GrPipeline::genKey	(	skgpu::KeyBuilder *	b,
		const GrCaps &	caps
	)		const

Definition at line 79 of file GrPipeline.cpp.

                                                                    {
    // kSnapVerticesToPixelCenters is implemented in a shader.
    InputFlags ignoredFlags = InputFlags::kSnapVerticesToPixelCenters;
    b->add32((uint32_t)fFlags & ~(uint32_t)ignoredFlags, "flags");
 
    const skgpu::BlendInfo& blendInfo = this->getXferProcessor().getBlendInfo();
 
    static constexpr uint32_t kBlendCoeffSize = 5;
    static constexpr uint32_t kBlendEquationSize = 5;
    static_assert(static_cast<int>(skgpu::BlendCoeff::kLast) < (1 << kBlendCoeffSize));
    static_assert(static_cast<int>(skgpu::BlendEquation::kLast) < (1 << kBlendEquationSize));
 
    b->addBool(blendInfo.fWritesColor, "writesColor");
    b->addBits(kBlendCoeffSize, static_cast<int>(blendInfo.fSrcBlend), "srcBlend");
    b->addBits(kBlendCoeffSize, static_cast<int>(blendInfo.fDstBlend), "dstBlend");
    b->addBits(kBlendEquationSize, static_cast<int>(blendInfo.fEquation), "equation");
    b->addBool(this->usesDstInputAttachment(), "inputAttach");
}

getFragmentProcessor()

const GrFragmentProcessor & GrPipeline::getFragmentProcessor ( int  idx ) const

inline

Definition at line 157 of file GrPipeline.h.

                                                                   {
        return *fFragmentProcessors[idx];
    }

getWindowRectsState()

const GrWindowRectsState & GrPipeline::getWindowRectsState ( ) const

inline

Definition at line 167 of file GrPipeline.h.

{ return fWindowRectsState; }

getXferProcessor()

const GrXferProcessor & GrPipeline::getXferProcessor ( ) const

inline

Definition at line 116 of file GrPipeline.h.

                                                    {
        if (fXferProcessor) {
            return *fXferProcessor;
        } else {
            // A null xp member means the common src-over case. GrXferProcessor's ref'ing
            // mechanism is not thread safe so we do not hold a ref on this global.
            return GrPorterDuffXPFactory::SimpleSrcOverXP();
        }
    }

hasStencilClip()

bool GrPipeline::hasStencilClip ( ) const

inline

Definition at line 174 of file GrPipeline.h.

                                {
        return SkToBool(fFlags & Flags::kHasStencilClip);
    }

isColorFragmentProcessor()

bool GrPipeline::isColorFragmentProcessor ( int  idx ) const

inline

Definition at line 101 of file GrPipeline.h.

{ return idx < fNumColorProcessors; }

isCoverageFragmentProcessor()

bool GrPipeline::isCoverageFragmentProcessor ( int  idx ) const

inline

Definition at line 102 of file GrPipeline.h.

{ return idx >= fNumColorProcessors; }

isScissorTestEnabled()

bool GrPipeline::isScissorTestEnabled ( ) const

inline

Definition at line 163 of file GrPipeline.h.

                                      {
        return SkToBool(fFlags & Flags::kScissorTestEnabled);
    }

isWireframe()

bool GrPipeline::isWireframe ( ) const

inline

Definition at line 170 of file GrPipeline.h.

{ return fFlags & InputFlags::kWireframe; }

numColorFragmentProcessors()

int GrPipeline::numColorFragmentProcessors ( ) const

inline

Definition at line 100 of file GrPipeline.h.

{ return fNumColorProcessors; }

numFragmentProcessors()

int GrPipeline::numFragmentProcessors ( ) const

inline

Definition at line 99 of file GrPipeline.h.

{ return fFragmentProcessors.count(); }

operator=()

GrPipeline & GrPipeline::operator= ( const GrPipeline &  )

delete

peekDstTexture()

GrTexture * GrPipeline::peekDstTexture ( ) const

inline

If this GrXferProcessor uses a texture to access the dst color, returns that texture.

Definition at line 145 of file GrPipeline.h.

                                      {
        if (!this->usesDstTexture()) {
            return nullptr;
        }
 
        if (GrTextureProxy* dstProxy = this->dstProxyView().asTextureProxy()) {
            return dstProxy->peekTexture();
        }
 
        return nullptr;
    }

setDstTextureUniforms()

void GrPipeline::setDstTextureUniforms	(	const GrGLSLProgramDataManager &	pdm,
		GrGLSLBuiltinUniformHandles *	fBuiltinUniformHandles
	)		const

Definition at line 115 of file GrPipeline.cpp.

                                                                                                  {
    GrTexture* dstTexture = this->peekDstTexture();
 
    if (dstTexture) {
        if (fBuiltinUniformHandles->fDstTextureCoordsUni.isValid()) {
            float scaleX = 1.f;
            float scaleY = 1.f;
            if (dstTexture->textureType() == GrTextureType::kRectangle) {
                // When we have a rectangle texture, we use the scaleX component to store the height
                // in case we need to flip the coords when using a bottom left origin.
                scaleX = dstTexture->height();
            } else {
                scaleX /= dstTexture->width();
                scaleY /= dstTexture->height();
            }
            pdm.set4f(fBuiltinUniformHandles->fDstTextureCoordsUni,
                      static_cast<float>(this->dstTextureOffset().fX),
                      static_cast<float>(this->dstTextureOffset().fY),
                      scaleX,
                      scaleY);
        }
    } else {
        SkASSERT(!fBuiltinUniformHandles->fDstTextureCoordsUni.isValid());
    }
}

snapVerticesToPixelCenters()

bool GrPipeline::snapVerticesToPixelCenters ( ) const

inline

Definition at line 171 of file GrPipeline.h.

                                            {
        return fFlags & InputFlags::kSnapVerticesToPixelCenters;
    }

usesConservativeRaster()

bool GrPipeline::usesConservativeRaster ( ) const

inline

Definition at line 169 of file GrPipeline.h.

{ return fFlags & InputFlags::kConservativeRaster; }

usesDstInputAttachment()

bool GrPipeline::usesDstInputAttachment ( ) const

inline

Definition at line 129 of file GrPipeline.h.

                                        {
        return this->dstSampleFlags() & GrDstSampleFlags::kAsInputAttachment;
    }

usesDstTexture()

bool GrPipeline::usesDstTexture ( ) const

inline

Definition at line 128 of file GrPipeline.h.

{ return this->dstProxyView() && !this->usesDstInputAttachment(); }

usesLocalCoords()

bool GrPipeline::usesLocalCoords ( ) const

inline

Definition at line 104 of file GrPipeline.h.

                                 {
        // The sample coords for the top level FPs are implicitly the GP's local coords.
        for (const auto& fp : fFragmentProcessors) {
            if (fp->usesSampleCoords()) {
                return true;
            }
        }
        return false;
    }

visitProxies()

void GrPipeline::visitProxies

(

const GrVisitProxyFunc &

func

)

const

Definition at line 105 of file GrPipeline.cpp.

                                                                {
    // This iteration includes any clip coverage FPs
    for (auto& fp : fFragmentProcessors) {
        fp->visitProxies(func);
    }
    if (this->usesDstTexture()) {
        func(this->dstProxyView().proxy(), skgpu::Mipmapped::kNo);
    }
}

visitTextureEffects()

void GrPipeline::visitTextureEffects

(

const std::function< void(const GrTextureEffect &)> &

func

)

const

Definition at line 98 of file GrPipeline.cpp.

                                                                     {
    for (auto& fp : fFragmentProcessors) {
        fp->visitTextureEffects(func);
    }
}

writeSwizzle()

const skgpu::Swizzle & GrPipeline::writeSwizzle ( ) const

inline

Definition at line 197 of file GrPipeline.h.

{ return fWriteSwizzle; }

xferBarrierType()

GrXferBarrierType GrPipeline::xferBarrierType

(

const GrCaps &

caps

)

const

Definition at line 59 of file GrPipeline.cpp.

                                                                      {
    if (this->dstSampleFlags() & GrDstSampleFlags::kRequiresTextureBarrier) {
        return kTexture_GrXferBarrierType;
    }
    return this->getXferProcessor().xferBarrierType(caps);
}

Friends And Related Symbol Documentation

operator&

bool operator& ( GrPipeline::Flags  flags, GrPipeline::InputFlags  inputFlag  )

friend

Definition at line 237 of file GrPipeline.h.

                                                                             {
    return (flags & (GrPipeline::Flags)inputFlag);
}

---

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

• third_party/skia/src/gpu/ganesh/GrPipeline.h
• third_party/skia/src/gpu/ganesh/GrPipeline.cpp