bsalomon | 6251d17 | 2014-10-15 10:50:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2014 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 | |
| 8 | #ifndef GrFragmentProcessor_DEFINED |
| 9 | #define GrFragmentProcessor_DEFINED |
| 10 | |
| 11 | #include "GrProcessor.h" |
| 12 | |
| 13 | class GrCoordTransform; |
jvanverth | e9c0fc6 | 2015-04-29 11:18:05 -0700 | [diff] [blame] | 14 | class GrGLSLCaps; |
egdaniel | 64c4728 | 2015-11-13 06:54:19 -0800 | [diff] [blame] | 15 | class GrGLSLFragmentProcessor; |
bsalomon | c21b09e | 2015-08-28 18:46:56 -0700 | [diff] [blame] | 16 | class GrInvariantOutput; |
bsalomon | a624bf3 | 2016-09-20 09:12:47 -0700 | [diff] [blame] | 17 | class GrPipeline; |
joshualitt | eb2a676 | 2014-12-04 11:35:33 -0800 | [diff] [blame] | 18 | class GrProcessorKeyBuilder; |
bsalomon | 6251d17 | 2014-10-15 10:50:36 -0700 | [diff] [blame] | 19 | |
| 20 | /** Provides custom fragment shader code. Fragment processors receive an input color (vec4f) and |
| 21 | produce an output color. They may reference textures and uniforms. They may use |
| 22 | GrCoordTransforms to receive a transformation of the local coordinates that map from local space |
| 23 | to the fragment being processed. |
| 24 | */ |
| 25 | class GrFragmentProcessor : public GrProcessor { |
| 26 | public: |
bsalomon | 87ba62e | 2015-09-22 06:41:59 -0700 | [diff] [blame] | 27 | /** |
| 28 | * In many instances (e.g. SkShader::asFragmentProcessor() implementations) it is desirable to |
| 29 | * only consider the input color's alpha. However, there is a competing desire to have reusable |
| 30 | * GrFragmentProcessor subclasses that can be used in other scenarios where the entire input |
| 31 | * color is considered. This function exists to filter the input color and pass it to a FP. It |
| 32 | * does so by returning a parent FP that multiplies the passed in FPs output by the parent's |
| 33 | * input alpha. The passed in FP will not receive an input color. |
| 34 | */ |
bungeman | 06ca8ec | 2016-06-09 08:01:03 -0700 | [diff] [blame] | 35 | static sk_sp<GrFragmentProcessor> MulOutputByInputAlpha(sk_sp<GrFragmentProcessor>); |
bsalomon | f1b7a1d | 2015-09-28 06:26:28 -0700 | [diff] [blame] | 36 | |
| 37 | /** |
| 38 | * Similar to the above but it modulates the output r,g,b of the child processor by the input |
| 39 | * rgb and then multiplies all the components by the input alpha. This effectively modulates |
| 40 | * the child processor's premul color by a unpremul'ed input and produces a premul output |
| 41 | */ |
bungeman | 06ca8ec | 2016-06-09 08:01:03 -0700 | [diff] [blame] | 42 | static sk_sp<GrFragmentProcessor> MulOutputByInputUnpremulColor(sk_sp<GrFragmentProcessor>); |
bsalomon | f1b7a1d | 2015-09-28 06:26:28 -0700 | [diff] [blame] | 43 | |
| 44 | /** |
bsalomon | e25eea4 | 2015-09-29 06:38:55 -0700 | [diff] [blame] | 45 | * Returns a parent fragment processor that adopts the passed fragment processor as a child. |
| 46 | * The parent will ignore its input color and instead feed the passed in color as input to the |
| 47 | * child. |
bsalomon | f1b7a1d | 2015-09-28 06:26:28 -0700 | [diff] [blame] | 48 | */ |
brianosman | 4cea3b9 | 2016-09-08 09:33:50 -0700 | [diff] [blame] | 49 | static sk_sp<GrFragmentProcessor> OverrideInput(sk_sp<GrFragmentProcessor>, GrColor4f); |
bsalomon | 87ba62e | 2015-09-22 06:41:59 -0700 | [diff] [blame] | 50 | |
bsalomon | e25eea4 | 2015-09-29 06:38:55 -0700 | [diff] [blame] | 51 | /** |
dvonbeck | c526da9 | 2016-07-20 11:20:30 -0700 | [diff] [blame] | 52 | * Returns a fragment processor that premuls the input before calling the passed in fragment |
| 53 | * processor. |
| 54 | */ |
| 55 | static sk_sp<GrFragmentProcessor> PremulInput(sk_sp<GrFragmentProcessor>); |
| 56 | |
| 57 | /** |
bsalomon | e25eea4 | 2015-09-29 06:38:55 -0700 | [diff] [blame] | 58 | * Returns a fragment processor that runs the passed in array of fragment processors in a |
| 59 | * series. The original input is passed to the first, the first's output is passed to the |
| 60 | * second, etc. The output of the returned processor is the output of the last processor of the |
| 61 | * series. |
bungeman | 06ca8ec | 2016-06-09 08:01:03 -0700 | [diff] [blame] | 62 | * |
| 63 | * The array elements with be moved. |
bsalomon | e25eea4 | 2015-09-29 06:38:55 -0700 | [diff] [blame] | 64 | */ |
bungeman | 06ca8ec | 2016-06-09 08:01:03 -0700 | [diff] [blame] | 65 | static sk_sp<GrFragmentProcessor> RunInSeries(sk_sp<GrFragmentProcessor>*, int cnt); |
bsalomon | e25eea4 | 2015-09-29 06:38:55 -0700 | [diff] [blame] | 66 | |
bsalomon | 6251d17 | 2014-10-15 10:50:36 -0700 | [diff] [blame] | 67 | GrFragmentProcessor() |
| 68 | : INHERITED() |
dvonbeck | 9b03e7b | 2016-08-01 11:01:56 -0700 | [diff] [blame] | 69 | , fUsesDistanceVectorField(false) |
bsalomon | b58a2b4 | 2016-09-26 06:55:02 -0700 | [diff] [blame] | 70 | , fUsesLocalCoords(false) {} |
bsalomon | 6251d17 | 2014-10-15 10:50:36 -0700 | [diff] [blame] | 71 | |
bsalomon | ac856c9 | 2015-08-27 06:30:17 -0700 | [diff] [blame] | 72 | ~GrFragmentProcessor() override; |
| 73 | |
egdaniel | 57d3b03 | 2015-11-13 11:57:27 -0800 | [diff] [blame] | 74 | GrGLSLFragmentProcessor* createGLSLInstance() const; |
joshualitt | eb2a676 | 2014-12-04 11:35:33 -0800 | [diff] [blame] | 75 | |
egdaniel | 57d3b03 | 2015-11-13 11:57:27 -0800 | [diff] [blame] | 76 | void getGLSLProcessorKey(const GrGLSLCaps& caps, GrProcessorKeyBuilder* b) const { |
| 77 | this->onGetGLSLProcessorKey(caps, b); |
wangyix | 4b3050b | 2015-08-04 07:59:37 -0700 | [diff] [blame] | 78 | for (int i = 0; i < fChildProcessors.count(); ++i) { |
egdaniel | 57d3b03 | 2015-11-13 11:57:27 -0800 | [diff] [blame] | 79 | fChildProcessors[i]->getGLSLProcessorKey(caps, b); |
wangyix | 4b3050b | 2015-08-04 07:59:37 -0700 | [diff] [blame] | 80 | } |
| 81 | } |
| 82 | |
bsalomon | a624bf3 | 2016-09-20 09:12:47 -0700 | [diff] [blame] | 83 | int numCoordTransforms() const { return fCoordTransforms.count(); } |
bsalomon | 6251d17 | 2014-10-15 10:50:36 -0700 | [diff] [blame] | 84 | |
| 85 | /** Returns the coordinate transformation at index. index must be valid according to |
| 86 | numTransforms(). */ |
| 87 | const GrCoordTransform& coordTransform(int index) const { return *fCoordTransforms[index]; } |
| 88 | |
joshualitt | abb52a1 | 2015-01-13 15:02:10 -0800 | [diff] [blame] | 89 | const SkTArray<const GrCoordTransform*, true>& coordTransforms() const { |
| 90 | return fCoordTransforms; |
| 91 | } |
| 92 | |
wangyix | 4b3050b | 2015-08-04 07:59:37 -0700 | [diff] [blame] | 93 | int numChildProcessors() const { return fChildProcessors.count(); } |
| 94 | |
bsalomon | ac856c9 | 2015-08-27 06:30:17 -0700 | [diff] [blame] | 95 | const GrFragmentProcessor& childProcessor(int index) const { return *fChildProcessors[index]; } |
wangyix | 4b3050b | 2015-08-04 07:59:37 -0700 | [diff] [blame] | 96 | |
joshualitt | 290c09b | 2014-12-19 13:45:20 -0800 | [diff] [blame] | 97 | /** Do any of the coordtransforms for this processor require local coords? */ |
| 98 | bool usesLocalCoords() const { return fUsesLocalCoords; } |
| 99 | |
dvonbeck | 9b03e7b | 2016-08-01 11:01:56 -0700 | [diff] [blame] | 100 | /** Does this FP need a vector to the nearest edge? */ |
| 101 | bool usesDistanceVectorField() const { return fUsesDistanceVectorField; } |
| 102 | |
joshualitt | eb2a676 | 2014-12-04 11:35:33 -0800 | [diff] [blame] | 103 | /** Returns true if this and other processor conservatively draw identically. It can only return |
| 104 | true when the two processor are of the same subclass (i.e. they return the same object from |
bsalomon | 6251d17 | 2014-10-15 10:50:36 -0700 | [diff] [blame] | 105 | from getFactory()). |
| 106 | |
joshualitt | eb2a676 | 2014-12-04 11:35:33 -0800 | [diff] [blame] | 107 | A return value of true from isEqual() should not be used to test whether the processor would |
egdaniel | 57d3b03 | 2015-11-13 11:57:27 -0800 | [diff] [blame] | 108 | generate the same shader code. To test for identical code generation use getGLSLProcessorKey |
| 109 | */ |
bsalomon | 7312ff8 | 2016-09-12 08:55:38 -0700 | [diff] [blame] | 110 | bool isEqual(const GrFragmentProcessor& that) const; |
bsalomon | 6251d17 | 2014-10-15 10:50:36 -0700 | [diff] [blame] | 111 | |
joshualitt | 56995b5 | 2014-12-11 15:44:02 -0800 | [diff] [blame] | 112 | /** |
| 113 | * This function is used to perform optimizations. When called the invarientOuput param |
| 114 | * indicate whether the input components to this processor in the FS will have known values. |
| 115 | * In inout the validFlags member is a bitfield of GrColorComponentFlags. The isSingleComponent |
| 116 | * member indicates whether the input will be 1 or 4 bytes. The function updates the members of |
| 117 | * inout to indicate known values of its output. A component of the color member only has |
| 118 | * meaning if the corresponding bit in validFlags is set. |
| 119 | */ |
bsalomon | c21b09e | 2015-08-28 18:46:56 -0700 | [diff] [blame] | 120 | void computeInvariantOutput(GrInvariantOutput* inout) const { |
| 121 | this->onComputeInvariantOutput(inout); |
| 122 | } |
joshualitt | 56995b5 | 2014-12-11 15:44:02 -0800 | [diff] [blame] | 123 | |
bsalomon | a624bf3 | 2016-09-20 09:12:47 -0700 | [diff] [blame] | 124 | /** |
| 125 | * Pre-order traversal of a FP hierarchy, or of the forest of FPs in a GrPipeline. In the latter |
| 126 | * case the tree rooted at each FP in the GrPipeline is visited successively. |
bsalomon | b58a2b4 | 2016-09-26 06:55:02 -0700 | [diff] [blame] | 127 | */ |
bsalomon | a624bf3 | 2016-09-20 09:12:47 -0700 | [diff] [blame] | 128 | class Iter : public SkNoncopyable { |
| 129 | public: |
| 130 | explicit Iter(const GrFragmentProcessor* fp) { fFPStack.push_back(fp); } |
| 131 | explicit Iter(const GrPipeline& pipeline); |
| 132 | const GrFragmentProcessor* next(); |
| 133 | |
| 134 | private: |
| 135 | SkSTArray<4, const GrFragmentProcessor*, true> fFPStack; |
| 136 | }; |
| 137 | |
| 138 | /** |
bsalomon | b58a2b4 | 2016-09-26 06:55:02 -0700 | [diff] [blame] | 139 | * Iterates over all the Ts owned by a GrFragmentProcessor and its children or over all the Ts |
| 140 | * owned by the forest of GrFragmentProcessors in a GrPipeline. FPs are visited in the same |
| 141 | * order as Iter and each of an FP's Ts are visited in order. |
bsalomon | a624bf3 | 2016-09-20 09:12:47 -0700 | [diff] [blame] | 142 | */ |
bsalomon | b58a2b4 | 2016-09-26 06:55:02 -0700 | [diff] [blame] | 143 | template <typename T, typename BASE, |
| 144 | int (BASE::*COUNT)() const, |
| 145 | const T& (BASE::*GET)(int) const> |
| 146 | class FPItemIter : public SkNoncopyable { |
bsalomon | a624bf3 | 2016-09-20 09:12:47 -0700 | [diff] [blame] | 147 | public: |
bsalomon | b58a2b4 | 2016-09-26 06:55:02 -0700 | [diff] [blame] | 148 | explicit FPItemIter(const GrFragmentProcessor* fp) |
| 149 | : fCurrFP(nullptr) |
| 150 | , fCTIdx(0) |
| 151 | , fFPIter(fp) { |
| 152 | fCurrFP = fFPIter.next(); |
| 153 | } |
| 154 | explicit FPItemIter(const GrPipeline& pipeline) |
bsalomon | a624bf3 | 2016-09-20 09:12:47 -0700 | [diff] [blame] | 155 | : fCurrFP(nullptr) |
| 156 | , fCTIdx(0) |
| 157 | , fFPIter(pipeline) { |
| 158 | fCurrFP = fFPIter.next(); |
| 159 | } |
bsalomon | b58a2b4 | 2016-09-26 06:55:02 -0700 | [diff] [blame] | 160 | |
| 161 | const T* next() { |
| 162 | if (!fCurrFP) { |
| 163 | return nullptr; |
| 164 | } |
| 165 | while (fCTIdx == (fCurrFP->*COUNT)()) { |
| 166 | fCTIdx = 0; |
| 167 | fCurrFP = fFPIter.next(); |
| 168 | if (!fCurrFP) { |
| 169 | return nullptr; |
| 170 | } |
| 171 | } |
| 172 | return &(fCurrFP->*GET)(fCTIdx++); |
| 173 | } |
bsalomon | a624bf3 | 2016-09-20 09:12:47 -0700 | [diff] [blame] | 174 | |
| 175 | private: |
| 176 | const GrFragmentProcessor* fCurrFP; |
| 177 | int fCTIdx; |
| 178 | GrFragmentProcessor::Iter fFPIter; |
| 179 | }; |
| 180 | |
bsalomon | b58a2b4 | 2016-09-26 06:55:02 -0700 | [diff] [blame] | 181 | using CoordTransformIter = FPItemIter<GrCoordTransform, |
| 182 | GrFragmentProcessor, |
| 183 | &GrFragmentProcessor::numCoordTransforms, |
| 184 | &GrFragmentProcessor::coordTransform>; |
| 185 | |
Brian Salomon | 0bbecb2 | 2016-11-17 11:38:22 -0500 | [diff] [blame^] | 186 | using TextureAccessIter = FPItemIter<TextureSampler, |
bsalomon | b58a2b4 | 2016-09-26 06:55:02 -0700 | [diff] [blame] | 187 | GrProcessor, |
Brian Salomon | 0bbecb2 | 2016-11-17 11:38:22 -0500 | [diff] [blame^] | 188 | &GrProcessor::numTextureSamplers, |
| 189 | &GrProcessor::textureSampler>; |
bsalomon | b58a2b4 | 2016-09-26 06:55:02 -0700 | [diff] [blame] | 190 | |
bsalomon | 6251d17 | 2014-10-15 10:50:36 -0700 | [diff] [blame] | 191 | protected: |
| 192 | /** |
| 193 | * Fragment Processor subclasses call this from their constructor to register coordinate |
bsalomon | de258cd | 2014-10-15 19:06:21 -0700 | [diff] [blame] | 194 | * transformations. Coord transforms provide a mechanism for a processor to receive coordinates |
| 195 | * in their FS code. The matrix expresses a transformation from local space. For a given |
| 196 | * fragment the matrix will be applied to the local coordinate that maps to the fragment. |
| 197 | * |
| 198 | * When the transformation has perspective, the transformed coordinates will have |
mtklein | 790d74f | 2015-08-19 11:05:39 -0700 | [diff] [blame] | 199 | * 3 components. Otherwise they'll have 2. |
bsalomon | de258cd | 2014-10-15 19:06:21 -0700 | [diff] [blame] | 200 | * |
| 201 | * This must only be called from the constructor because GrProcessors are immutable. The |
| 202 | * processor subclass manages the lifetime of the transformations (this function only stores a |
mtklein | 790d74f | 2015-08-19 11:05:39 -0700 | [diff] [blame] | 203 | * pointer). The GrCoordTransform is typically a member field of the GrProcessor subclass. |
bsalomon | de258cd | 2014-10-15 19:06:21 -0700 | [diff] [blame] | 204 | * |
| 205 | * A processor subclass that has multiple methods of construction should always add its coord |
| 206 | * transforms in a consistent order. The non-virtual implementation of isEqual() automatically |
| 207 | * compares transforms and will assume they line up across the two processor instances. |
bsalomon | 6251d17 | 2014-10-15 10:50:36 -0700 | [diff] [blame] | 208 | */ |
| 209 | void addCoordTransform(const GrCoordTransform*); |
| 210 | |
| 211 | /** |
wangyix | 58d890b | 2015-08-12 09:40:47 -0700 | [diff] [blame] | 212 | * FragmentProcessor subclasses call this from their constructor to register any child |
wangyix | 93ab254 | 2015-08-19 08:23:12 -0700 | [diff] [blame] | 213 | * FragmentProcessors they have. This must be called AFTER all texture accesses and coord |
| 214 | * transforms have been added. |
wangyix | 4b3050b | 2015-08-04 07:59:37 -0700 | [diff] [blame] | 215 | * This is for processors whose shader code will be composed of nested processors whose output |
| 216 | * colors will be combined somehow to produce its output color. Registering these child |
wangyix | 58d890b | 2015-08-12 09:40:47 -0700 | [diff] [blame] | 217 | * processors will allow the ProgramBuilder to automatically handle their transformed coords and |
| 218 | * texture accesses and mangle their uniform and output color names. |
wangyix | 4b3050b | 2015-08-04 07:59:37 -0700 | [diff] [blame] | 219 | */ |
bungeman | 06ca8ec | 2016-06-09 08:01:03 -0700 | [diff] [blame] | 220 | int registerChildProcessor(sk_sp<GrFragmentProcessor> child); |
wangyix | 4b3050b | 2015-08-04 07:59:37 -0700 | [diff] [blame] | 221 | |
| 222 | /** |
joshualitt | 56995b5 | 2014-12-11 15:44:02 -0800 | [diff] [blame] | 223 | * Subclass implements this to support getConstantColorComponents(...). |
wangyix | 54017d7 | 2015-08-18 07:39:33 -0700 | [diff] [blame] | 224 | * |
| 225 | * Note: it's up to the subclass implementation to do any recursive call to compute the child |
| 226 | * procs' output invariants; computeInvariantOutput will not be recursive. |
joshualitt | 56995b5 | 2014-12-11 15:44:02 -0800 | [diff] [blame] | 227 | */ |
| 228 | virtual void onComputeInvariantOutput(GrInvariantOutput* inout) const = 0; |
| 229 | |
dvonbeck | 9b03e7b | 2016-08-01 11:01:56 -0700 | [diff] [blame] | 230 | /* Sub-classes should set this to true in their constructors if they need access to a distance |
| 231 | * vector field to the nearest edge |
| 232 | */ |
| 233 | bool fUsesDistanceVectorField; |
| 234 | |
bsalomon | 6251d17 | 2014-10-15 10:50:36 -0700 | [diff] [blame] | 235 | private: |
bsalomon | 4204800 | 2015-08-27 16:43:48 -0700 | [diff] [blame] | 236 | void notifyRefCntIsZero() const final; |
| 237 | |
wangyix | b1daa86 | 2015-08-18 11:29:31 -0700 | [diff] [blame] | 238 | /** Returns a new instance of the appropriate *GL* implementation class |
| 239 | for the given GrFragmentProcessor; caller is responsible for deleting |
| 240 | the object. */ |
egdaniel | 57d3b03 | 2015-11-13 11:57:27 -0800 | [diff] [blame] | 241 | virtual GrGLSLFragmentProcessor* onCreateGLSLInstance() const = 0; |
wangyix | b1daa86 | 2015-08-18 11:29:31 -0700 | [diff] [blame] | 242 | |
wangyix | 4b3050b | 2015-08-04 07:59:37 -0700 | [diff] [blame] | 243 | /** Implemented using GLFragmentProcessor::GenKey as described in this class's comment. */ |
egdaniel | 57d3b03 | 2015-11-13 11:57:27 -0800 | [diff] [blame] | 244 | virtual void onGetGLSLProcessorKey(const GrGLSLCaps& caps, |
| 245 | GrProcessorKeyBuilder* b) const = 0; |
wangyix | 4b3050b | 2015-08-04 07:59:37 -0700 | [diff] [blame] | 246 | |
bsalomon | de258cd | 2014-10-15 19:06:21 -0700 | [diff] [blame] | 247 | /** |
| 248 | * Subclass implements this to support isEqual(). It will only be called if it is known that |
| 249 | * the two processors are of the same subclass (i.e. they return the same object from |
| 250 | * getFactory()). The processor subclass should not compare its coord transforms as that will |
| 251 | * be performed automatically in the non-virtual isEqual(). |
| 252 | */ |
| 253 | virtual bool onIsEqual(const GrFragmentProcessor&) const = 0; |
| 254 | |
| 255 | bool hasSameTransforms(const GrFragmentProcessor&) const; |
bsalomon | 6251d17 | 2014-10-15 10:50:36 -0700 | [diff] [blame] | 256 | |
bungeman | 06ca8ec | 2016-06-09 08:01:03 -0700 | [diff] [blame] | 257 | bool fUsesLocalCoords; |
wangyix | 58d890b | 2015-08-12 09:40:47 -0700 | [diff] [blame] | 258 | |
bsalomon | a624bf3 | 2016-09-20 09:12:47 -0700 | [diff] [blame] | 259 | SkSTArray<4, const GrCoordTransform*, true> fCoordTransforms; |
| 260 | |
wangyix | 58d890b | 2015-08-12 09:40:47 -0700 | [diff] [blame] | 261 | /** |
bungeman | 06ca8ec | 2016-06-09 08:01:03 -0700 | [diff] [blame] | 262 | * This is not SkSTArray<1, sk_sp<GrFragmentProcessor>> because this class holds strong |
| 263 | * references until notifyRefCntIsZero and then it holds pending executions. |
| 264 | */ |
| 265 | SkSTArray<1, GrFragmentProcessor*, true> fChildProcessors; |
bsalomon | 6251d17 | 2014-10-15 10:50:36 -0700 | [diff] [blame] | 266 | |
| 267 | typedef GrProcessor INHERITED; |
| 268 | }; |
| 269 | |
bsalomon | 6251d17 | 2014-10-15 10:50:36 -0700 | [diff] [blame] | 270 | #endif |