blob: 326c6742b8af4aea6f98d204d65b62ece05d4981 [file] [log] [blame]
tomhudson@google.com168e6342012-04-18 17:49:20 +00001/*
2 * Copyright 2012 Google Inc.
3 *
4 * Use of this source code is governed by a BSD-style license that can be
5 * found in the LICENSE file.
6 */
7
joshualittb0a8a372014-09-23 09:50:21 -07008#ifndef GrProcessor_DEFINED
9#define GrProcessor_DEFINED
tomhudson@google.com168e6342012-04-18 17:49:20 +000010
Mike Kleinc0bd9f92019-04-23 12:05:21 -050011#include "include/core/SkMath.h"
12#include "include/core/SkString.h"
Greg Danielf91aeb22019-06-18 09:58:02 -040013#include "src/gpu/GrColor.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050014#include "src/gpu/GrGpuBuffer.h"
15#include "src/gpu/GrProcessorUnitTest.h"
Brian Salomon201cdbb2019-08-14 17:00:30 -040016#include "src/gpu/GrSamplerState.h"
Mike Kleinc0bd9f92019-04-23 12:05:21 -050017#include "src/gpu/GrShaderVar.h"
18#include "src/gpu/GrSurfaceProxyPriv.h"
Greg Danielf91aeb22019-06-18 09:58:02 -040019#include "src/gpu/GrTextureProxy.h"
tomhudson@google.com07eecdc2012-04-20 18:35:38 +000020
tomhudson@google.com168e6342012-04-18 17:49:20 +000021class GrContext;
Brian Osman32342f02017-03-04 08:12:46 -050022class GrResourceProvider;
bsalomon95740982014-09-04 13:12:37 -070023
joshualitteb2a6762014-12-04 11:35:33 -080024/**
25 * Used by processors to build their keys. It incorporates each per-processor key into a larger
26 * shader key.
27 */
28class GrProcessorKeyBuilder {
29public:
30 GrProcessorKeyBuilder(SkTArray<unsigned char, true>* data) : fData(data), fCount(0) {
31 SkASSERT(0 == fData->count() % sizeof(uint32_t));
32 }
33
34 void add32(uint32_t v) {
35 ++fCount;
36 fData->push_back_n(4, reinterpret_cast<uint8_t*>(&v));
37 }
38
39 /** Inserts count uint32_ts into the key. The returned pointer is only valid until the next
40 add*() call. */
41 uint32_t* SK_WARN_UNUSED_RESULT add32n(int count) {
42 SkASSERT(count > 0);
43 fCount += count;
44 return reinterpret_cast<uint32_t*>(fData->push_back_n(4 * count));
45 }
46
47 size_t size() const { return sizeof(uint32_t) * fCount; }
48
49private:
50 SkTArray<uint8_t, true>* fData; // unowned ptr to the larger key.
51 int fCount; // number of uint32_ts added to fData by the processor.
52};
53
bsalomon98b33eb2014-10-15 11:05:26 -070054/** Provides custom shader code to the Ganesh shading pipeline. GrProcessor objects *must* be
55 immutable: after being constructed, their fields may not change.
bsalomon@google.com0ac6af42013-01-16 15:16:18 +000056
joshualittb0a8a372014-09-23 09:50:21 -070057 Dynamically allocated GrProcessors are managed by a per-thread memory pool. The ref count of an
mdempsky38f1f6f2015-08-27 12:57:01 -070058 processor must reach 0 before the thread terminates and the pool is destroyed.
bsalomon98b33eb2014-10-15 11:05:26 -070059 */
Brian Salomond61c9d92017-04-10 10:54:25 -040060class GrProcessor {
tomhudson@google.com168e6342012-04-18 17:49:20 +000061public:
Ethan Nicholasabff9562017-10-09 10:54:08 -040062 enum ClassID {
Ethan Nicholasabff9562017-10-09 10:54:08 -040063 kBigKeyProcessor_ClassID,
64 kBlockInputFragmentProcessor_ClassID,
Brian Salomon62e4f3d2018-04-20 13:54:11 -040065 kButtCapStrokedCircleGeometryProcessor_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -040066 kCircleGeometryProcessor_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -040067 kCircularRRectEffect_ClassID,
Chris Dalton49d14e92018-07-27 12:38:35 -060068 kClockwiseTestProcessor_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -040069 kColorTableEffect_ClassID,
70 kComposeOneFragmentProcessor_ClassID,
71 kComposeTwoFragmentProcessor_ClassID,
72 kCoverageSetOpXP_ClassID,
Chris Dalton09a7bb22018-08-31 19:53:15 +080073 kCubicStrokeProcessor_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -040074 kCustomXP_ClassID,
75 kDashingCircleEffect_ClassID,
76 kDashingLineEffect_ClassID,
77 kDefaultGeoProc_ClassID,
78 kDIEllipseGeometryProcessor_ClassID,
79 kDisableColorXP_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -040080 kEllipseGeometryProcessor_ClassID,
81 kEllipticalRRectEffect_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -040082 kGP_ClassID,
Brian Osman387eaff2018-07-20 14:50:44 -040083 kVertexColorSpaceBenchGP_ClassID,
Ethan Nicholas8dca18a2017-11-15 15:33:33 -050084 kGrAARectEffect_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -040085 kGrAlphaThresholdFragmentProcessor_ClassID,
86 kGrBicubicEffect_ClassID,
87 kGrBitmapTextGeoProc_ClassID,
88 kGrBlurredEdgeFragmentProcessor_ClassID,
Chris Dalton383a2ef2018-01-08 17:21:41 -050089 kGrCCClipProcessor_ClassID,
Chris Dalton383a2ef2018-01-08 17:21:41 -050090 kGrCCPathProcessor_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -040091 kGrCircleBlurFragmentProcessor_ClassID,
92 kGrCircleEffect_ClassID,
Michael Ludwig4f94ef62018-09-12 15:22:16 -040093 kGrClampedGradientEffect_ClassID,
Brian Salomond6f3f182019-05-31 09:24:40 -040094 kGrColorMatrixFragmentProcessor_ClassID,
Brian Osmanc4f93ca2017-10-17 17:15:52 -040095 kGrColorSpaceXformEffect_ClassID,
Ethan Nicholasff4fb332019-04-09 16:28:19 -040096 kGrComposeLerpEffect_ClassID,
97 kGrComposeLerpRedEffect_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -040098 kGrConfigConversionEffect_ClassID,
99 kGrConicEffect_ClassID,
100 kGrConstColorProcessor_ClassID,
101 kGrConvexPolyEffect_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -0400102 kGrDeviceSpaceTextureDecalFragmentProcessor_ClassID,
103 kGrDiffuseLightingEffect_ClassID,
104 kGrDisplacementMapEffect_ClassID,
105 kGrDistanceFieldA8TextGeoProc_ClassID,
106 kGrDistanceFieldLCDTextGeoProc_ClassID,
107 kGrDistanceFieldPathGeoProc_ClassID,
Michael Ludwig0495f7a2018-09-12 15:23:33 -0400108 kGrDualIntervalGradientColorizer_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -0400109 kGrEllipseEffect_ClassID,
Chris Dalton82eb9e72019-03-21 14:26:39 -0600110 kGrFillRRectOp_Processor_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -0400111 kGrGaussianConvolutionFragmentProcessor_ClassID,
Chris Dalton2c5e0112019-03-29 13:14:18 -0500112 kGrGSCoverageProcessor_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -0400113 kGrImprovedPerlinNoiseEffect_ClassID,
Michael Ludwig4f94ef62018-09-12 15:22:16 -0400114 kGrLinearGradientLayout_ClassID,
Ethan Nicholas14efcbf2017-11-07 09:23:38 -0500115 kGrLumaColorFilterEffect_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -0400116 kGrMagnifierEffect_ClassID,
117 kGrMatrixConvolutionEffect_ClassID,
118 kGrMeshTestProcessor_ClassID,
119 kGrMorphologyEffect_ClassID,
Florin Malita6041d312019-03-05 15:03:20 +0000120 kGrMixerEffect_ClassID,
Brian Salomonc0d79e52019-04-10 15:02:11 -0400121 kGrOverrideInputFragmentProcessor_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -0400122 kGrPathProcessor_ClassID,
123 kGrPerlinNoise2Effect_ClassID,
124 kGrPipelineDynamicStateTestProcessor_ClassID,
Ethan Nicholasbe0a0422017-11-17 13:44:05 -0500125 kGrPremulInputFragmentProcessor_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -0400126 kGrQuadEffect_ClassID,
Michael Ludwig4089df82018-09-12 15:22:37 -0400127 kGrRadialGradientLayout_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -0400128 kGrRectBlurEffect_ClassID,
129 kGrRRectBlurEffect_ClassID,
130 kGrRRectShadowGeoProc_ClassID,
131 kGrSimpleTextureEffect_ClassID,
Michael Ludwig4f94ef62018-09-12 15:22:16 -0400132 kGrSingleIntervalGradientColorizer_ClassID,
Ethan Nicholas00543112018-07-31 09:44:36 -0400133 kGrSkSLFP_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -0400134 kGrSpecularLightingEffect_ClassID,
135 kGrSRGBEffect_ClassID,
Chris Daltonc3318f02019-07-19 14:20:53 -0600136 kGrSampleMaskProcessor_ClassID,
Brian Salomonf19f9ca2019-09-18 15:54:26 -0400137 kGrSaturateProcessor_ClassID,
Michael Ludwig24d438b2018-09-12 15:22:50 -0400138 kGrSweepGradientLayout_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -0400139 kGrTextureDomainEffect_ClassID,
Michael Ludwiga7914d32018-09-14 09:47:21 -0400140 kGrTextureGradientColorizer_ClassID,
Michael Ludwig4f94ef62018-09-12 15:22:16 -0400141 kGrTiledGradientEffect_ClassID,
Michael Ludwig8f685082018-09-12 15:23:01 -0400142 kGrTwoPointConicalGradientLayout_ClassID,
Michael Ludwig72535fb2018-09-28 11:53:32 -0400143 kGrUnrolledBinaryGradientColorizer_ClassID,
Chris Dalton2c5e0112019-03-29 13:14:18 -0500144 kGrVSCoverageProcessor_ClassID,
Ethan Nicholas7461a4a2017-12-21 14:18:01 -0500145 kGrYUVtoRGBEffect_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -0400146 kHighContrastFilterEffect_ClassID,
Brian Salomon2a943df2018-05-04 13:43:19 -0400147 kLatticeGP_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -0400148 kPDLCDXferProcessor_ClassID,
149 kPorterDuffXferProcessor_ClassID,
150 kPremulFragmentProcessor_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -0400151 kQuadEdgeEffect_ClassID,
Michael Ludwig69858532018-11-28 15:34:34 -0500152 kQuadPerEdgeAAGeometryProcessor_ClassID,
Chris Daltond7291ba2019-03-07 14:17:03 -0700153 kSampleLocationsTestProcessor_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -0400154 kSeriesFragmentProcessor_ClassID,
155 kShaderPDXferProcessor_ClassID,
Chris Daltonc3318f02019-07-19 14:20:53 -0600156 kStencilResolveProcessor_ClassID,
Chris Dalton09212192018-11-13 15:07:24 -0500157 kFwidthSquircleTestProcessor_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -0400158 kSwizzleFragmentProcessor_ClassID,
159 kTestFP_ClassID,
Robert Phillipsa8cdbd72018-07-17 12:30:40 -0400160 kFlatNormalsFP_ClassID,
161 kMappedNormalsFP_ClassID,
162 kLightingFP_ClassID,
Chris Dalton09a7bb22018-08-31 19:53:15 +0800163 kLinearStrokeProcessor_ClassID,
Ethan Nicholasabff9562017-10-09 10:54:08 -0400164 };
165
Brian Salomonab015ef2017-04-04 10:15:51 -0400166 virtual ~GrProcessor() = default;
tomhudson@google.com168e6342012-04-18 17:49:20 +0000167
Brian Salomonb014cca2016-11-18 11:39:15 -0500168 /** Human-meaningful string to identify this prcoessor; may be embedded in generated shader
169 code. */
joshualitteb2a6762014-12-04 11:35:33 -0800170 virtual const char* name() const = 0;
bsalomon@google.com289efe02012-05-21 20:57:59 +0000171
Brian Salomonb014cca2016-11-18 11:39:15 -0500172 /** Human-readable dump of all information */
Brian Osman9a390ac2018-11-12 09:47:48 -0500173#ifdef SK_DEBUG
robertphillipse004bfc2015-11-16 09:06:59 -0800174 virtual SkString dumpInfo() const {
175 SkString str;
176 str.appendf("Missing data");
177 return str;
178 }
Brian Osman9a390ac2018-11-12 09:47:48 -0500179#else
180 SkString dumpInfo() const { return SkString("<Processor information unavailable>"); }
181#endif
robertphillipse004bfc2015-11-16 09:06:59 -0800182
Chris Daltond7291ba2019-03-07 14:17:03 -0700183 /**
184 * Custom shader features provided by the framework. These require special handling when
185 * preparing shaders, so a processor must call setWillUseCustomFeature() from its constructor if
186 * it intends to use one.
187 */
188 enum class CustomFeatures {
189 kNone = 0,
190 kSampleLocations = 1 << 0,
191 };
192
193 GR_DECL_BITFIELD_CLASS_OPS_FRIENDS(CustomFeatures);
194
195 CustomFeatures requestedFeatures() const { return fRequestedFeatures; }
196
tomhudson@google.comdcba4c22012-07-24 21:36:16 +0000197 void* operator new(size_t size);
198 void operator delete(void* target);
199
bsalomon@google.comd42aca32013-04-23 15:37:27 +0000200 void* operator new(size_t size, void* placement) {
201 return ::operator new(size, placement);
202 }
203 void operator delete(void* target, void* placement) {
204 ::operator delete(target, placement);
205 }
206
Brian Salomonb014cca2016-11-18 11:39:15 -0500207 /** Helper for down-casting to a GrProcessor subclass */
joshualitt49586be2014-09-16 08:21:41 -0700208 template <typename T> const T& cast() const { return *static_cast<const T*>(this); }
209
Ethan Nicholasabff9562017-10-09 10:54:08 -0400210 ClassID classID() const { return fClassID; }
joshualitteb2a6762014-12-04 11:35:33 -0800211
bsalomon@google.com50db75c2013-01-11 13:54:30 +0000212protected:
Chris Dalton535ba8d2018-02-20 09:51:59 -0700213 GrProcessor(ClassID classID) : fClassID(classID) {}
Brian Salomond61c9d92017-04-10 10:54:25 -0400214 GrProcessor(const GrProcessor&) = delete;
215 GrProcessor& operator=(const GrProcessor&) = delete;
216
Chris Daltond7291ba2019-03-07 14:17:03 -0700217 void setWillUseCustomFeature(CustomFeatures feature) { fRequestedFeatures |= feature; }
Chris Daltonc3318f02019-07-19 14:20:53 -0600218 void resetCustomFeatures() { fRequestedFeatures = CustomFeatures::kNone; }
Chris Daltond7291ba2019-03-07 14:17:03 -0700219
220 const ClassID fClassID;
221 CustomFeatures fRequestedFeatures = CustomFeatures::kNone;
tomhudson@google.com168e6342012-04-18 17:49:20 +0000222};
223
Chris Daltond7291ba2019-03-07 14:17:03 -0700224GR_MAKE_BITFIELD_CLASS_OPS(GrProcessor::CustomFeatures);
225
tomhudson@google.com168e6342012-04-18 17:49:20 +0000226#endif