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