aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/gpu/ops/GrSimpleMeshDrawOpHelper.h
blob: 903859c309294e2a23eec9844eb115f9103bb137 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
/*
 * Copyright 2017 Google Inc.
 *
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */

#ifndef GrSimpleMeshDrawOpHelper_DEFINED
#define GrSimpleMeshDrawOpHelper_DEFINED

#include "GrAppliedClip.h"
#include "GrOpFlushState.h"
#include "GrPipeline.h"
#include "GrProcessorSet.h"
#include "GrRect.h"
#include "GrUserStencilSettings.h"

/**
 * This class can be used to help implement simple mesh draw ops. It reduces the amount of
 * boilerplate code to type and also provides a mechanism for optionally allocating space for a
 * GrProcessorSet based on a GrPaint. It is intended to be used by ops that construct a single
 * GrPipeline for a uniform primitive color and a GrPaint.
 */
class GrSimpleMeshDrawOpHelper {
public:
    struct MakeArgs;

    /**
     * This can be used by a Op class to perform allocation and initialization such that a
     * GrProcessorSet (if required) is allocated at the same time as the Op instance. It requires
     * that Op implements a constructor of the form:
     *      Op(MakeArgs, GrColor, OpArgs...)
     * which is public or made accessible via 'friend'.
     */
    template <typename Op, typename... OpArgs>
    static std::unique_ptr<GrDrawOp> FactoryHelper(GrPaint&& paint, OpArgs... opArgs);

    enum class Flags : uint32_t {
        kNone = 0x0,
        kSnapVerticesToPixelCenters = 0x1,
    };
    GR_DECL_BITFIELD_CLASS_OPS_FRIENDS(Flags);

    GrSimpleMeshDrawOpHelper(const MakeArgs& args, GrAAType aaType, Flags flags = Flags::kNone)
            : fProcessors(args.fProcessorSet)
            , fPipelineFlags(args.fSRGBFlags)
            , fAAType((int)aaType)
            , fRequiresDstTexture(false)
            , fUsesLocalCoords(false)
            , fCompatibleWithAlphaAsCoveage(false) {
        SkDEBUGCODE(fDidAnalysis = false);
        if (GrAATypeIsHW(aaType)) {
            fPipelineFlags |= GrPipeline::kHWAntialias_Flag;
        }
        if (flags & Flags::kSnapVerticesToPixelCenters) {
            fPipelineFlags |= GrPipeline::kSnapVerticesToPixelCenters_Flag;
        }
    }

    ~GrSimpleMeshDrawOpHelper() {
        if (fProcessors) {
            fProcessors->~GrProcessorSet();
        }
    }

    GrSimpleMeshDrawOpHelper() = delete;
    GrSimpleMeshDrawOpHelper(const GrSimpleMeshDrawOpHelper&) = delete;
    GrSimpleMeshDrawOpHelper& operator=(const GrSimpleMeshDrawOpHelper&) = delete;

    GrDrawOp::FixedFunctionFlags fixedFunctionFlags() const {
        return GrAATypeIsHW((this->aaType())) ? GrDrawOp::FixedFunctionFlags::kUsesHWAA
                                              : GrDrawOp::FixedFunctionFlags::kNone;
    }

    bool isCompatible(const GrSimpleMeshDrawOpHelper& that, const GrCaps& caps,
                      const SkRect& aBounds, const SkRect& bBounds) const {
        if (SkToBool(fProcessors) != SkToBool(that.fProcessors)) {
            return false;
        }
        if (fProcessors) {
            if (*fProcessors != *that.fProcessors) {
                return false;
            }
            if (fRequiresDstTexture || (fProcessors->xferProcessor() &&
                                        fProcessors->xferProcessor()->xferBarrierType(caps))) {
                if (GrRectsTouchOrOverlap(aBounds, bBounds)) {
                    return false;
                }
            }
        }
        bool result = fPipelineFlags == that.fPipelineFlags && fAAType == that.fAAType;
        SkASSERT(!result || fCompatibleWithAlphaAsCoveage == that.fCompatibleWithAlphaAsCoveage);
        SkASSERT(!result || fUsesLocalCoords == that.fUsesLocalCoords);
        return result;
    }

    bool xpRequiresDstTexture(const GrCaps& caps, const GrAppliedClip* clip,
                              GrProcessorAnalysisCoverage geometryCoverage, GrColor* color) {
        SkDEBUGCODE(fDidAnalysis = true);
        GrProcessorSet::Analysis analysis;
        if (fProcessors) {
            GrProcessorAnalysisCoverage coverage = geometryCoverage;
            if (GrProcessorAnalysisCoverage::kNone == coverage) {
                coverage = clip->clipCoverageFragmentProcessor()
                                   ? GrProcessorAnalysisCoverage::kSingleChannel
                                   : GrProcessorAnalysisCoverage::kNone;
            }
            bool isMixedSamples = this->aaType() == GrAAType::kMixedSamples;
            analysis = fProcessors->finalize(*color, coverage, clip, isMixedSamples, caps, color);
        } else {
            analysis = GrProcessorSet::EmptySetAnalysis();
        }
        fRequiresDstTexture = analysis.requiresDstTexture();
        fUsesLocalCoords = analysis.usesLocalCoords();
        fCompatibleWithAlphaAsCoveage = analysis.isCompatibleWithCoverageAsAlpha();
        return analysis.requiresDstTexture();
    }

    bool usesLocalCoords() const {
        SkASSERT(fDidAnalysis);
        return fUsesLocalCoords;
    }

    bool compatibleWithAlphaAsCoverage() const { return fCompatibleWithAlphaAsCoveage; }

    GrPipeline* makePipeline(GrMeshDrawOp::Target* target) const {
        return target->allocPipeline(this->pipelineInitArgs(target));
    }

    struct MakeArgs {
    private:
        MakeArgs() = default;

        GrProcessorSet* fProcessorSet;
        uint32_t fSRGBFlags;

        friend class GrSimpleMeshDrawOpHelper;
    };

protected:
    GrAAType aaType() const { return static_cast<GrAAType>(fAAType); }
    uint32_t pipelineFlags() const { return fPipelineFlags; }
    const GrProcessorSet& processors() const {
        return fProcessors ? *fProcessors : GrProcessorSet::EmptySet();
    }

    GrPipeline::InitArgs pipelineInitArgs(GrMeshDrawOp::Target* target) const {
        GrPipeline::InitArgs args;
        args.fFlags = this->pipelineFlags();
        args.fProcessors = &this->processors();
        args.fRenderTarget = target->renderTarget();
        args.fAppliedClip = target->clip();
        args.fDstProxy = target->dstProxy();
        args.fCaps = &target->caps();
        args.fResourceProvider = target->resourceProvider();
        return args;
    }

private:
    GrProcessorSet* fProcessors;
    unsigned fPipelineFlags : 8;
    unsigned fAAType : 2;
    unsigned fRequiresDstTexture : 1;
    unsigned fUsesLocalCoords : 1;
    unsigned fCompatibleWithAlphaAsCoveage : 1;
    SkDEBUGCODE(unsigned fDidAnalysis : 1;)
};

/**
 * This class extends GrSimpleMeshDrawOpHelper to support an optional GrUserStencilSettings. This
 * uses private inheritance because it non-virtually overrides methods in the base class and should
 * never be used with a GrSimpleMeshDrawOpHelper pointer or reference.
 */
class GrSimpleMeshDrawOpHelperWithStencil : private GrSimpleMeshDrawOpHelper {
public:
    using MakeArgs = GrSimpleMeshDrawOpHelper::MakeArgs;
    using Flags = GrSimpleMeshDrawOpHelper::Flags;

    // using declarations can't be templated, so this is a pass through function instead.
    template <typename Op, typename... OpArgs>
    static std::unique_ptr<GrDrawOp> FactoryHelper(GrPaint&& paint, OpArgs... opArgs) {
        return GrSimpleMeshDrawOpHelper::FactoryHelper<Op, OpArgs...>(
                std::move(paint), std::forward<OpArgs>(opArgs)...);
    }

    GrSimpleMeshDrawOpHelperWithStencil(const MakeArgs& args, GrAAType aaType,
                                        const GrUserStencilSettings* stencilSettings,
                                        Flags flags = Flags::kNone)
            : INHERITED(args, aaType, flags)
            , fStencilSettings(stencilSettings ? stencilSettings
                                               : &GrUserStencilSettings::kUnused) {}

    GrDrawOp::FixedFunctionFlags fixedFunctionFlags() const {
        GrDrawOp::FixedFunctionFlags flags = INHERITED::fixedFunctionFlags();
        if (fStencilSettings != &GrUserStencilSettings::kUnused) {
            flags |= GrDrawOp::FixedFunctionFlags::kUsesStencil;
        }
        return flags;
    }

    using GrSimpleMeshDrawOpHelper::xpRequiresDstTexture;
    using GrSimpleMeshDrawOpHelper::usesLocalCoords;
    using GrSimpleMeshDrawOpHelper::compatibleWithAlphaAsCoverage;

    bool isCompatible(const GrSimpleMeshDrawOpHelperWithStencil& that, const GrCaps& caps,
                      const SkRect& aBounds, const SkRect& bBounds) const {
        return INHERITED::isCompatible(that, caps, aBounds, bBounds) &&
               fStencilSettings == that.fStencilSettings;
    }

    GrPipeline* makePipeline(GrMeshDrawOp::Target* target) const {
        auto args = INHERITED::pipelineInitArgs(target);
        args.fUserStencil = fStencilSettings;
        return target->allocPipeline(args);
    }

private:
    const GrUserStencilSettings* fStencilSettings;
    typedef GrSimpleMeshDrawOpHelper INHERITED;
};

template <typename Op, typename... OpArgs>
std::unique_ptr<GrDrawOp> GrSimpleMeshDrawOpHelper::FactoryHelper(GrPaint&& paint,
                                                                  OpArgs... opArgs) {
    MakeArgs makeArgs;
    makeArgs.fSRGBFlags = GrPipeline::SRGBFlagsFromPaint(paint);
    GrColor color = paint.getColor();
    if (paint.isTrivial()) {
        makeArgs.fProcessorSet = nullptr;
        return std::unique_ptr<GrDrawOp>(new Op(makeArgs, color, std::forward<OpArgs>(opArgs)...));
    } else {
        char* mem = (char*)GrOp::operator new(sizeof(Op) + sizeof(GrProcessorSet));
        char* setMem = mem + sizeof(Op);
        makeArgs.fProcessorSet = new (setMem) GrProcessorSet(std::move(paint));
        return std::unique_ptr<GrDrawOp>(
                new (mem) Op(makeArgs, color, std::forward<OpArgs>(opArgs)...));
    }
}

GR_MAKE_BITFIELD_CLASS_OPS(GrSimpleMeshDrawOpHelper::Flags)

#endif