joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2013 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 GrPrimitiveProcessor_DEFINED |
| 9 | #define GrPrimitiveProcessor_DEFINED |
| 10 | |
| 11 | #include "GrColor.h" |
| 12 | #include "GrProcessor.h" |
| 13 | #include "GrShaderVar.h" |
| 14 | |
| 15 | /* |
| 16 | * The GrPrimitiveProcessor represents some kind of geometric primitive. This includes the shape |
| 17 | * of the primitive and the inherent color of the primitive. The GrPrimitiveProcessor is |
| 18 | * responsible for providing a color and coverage input into the Ganesh rendering pipeline. Through |
| 19 | * optimization, Ganesh may decide a different color, no color, and / or no coverage are required |
| 20 | * from the GrPrimitiveProcessor, so the GrPrimitiveProcessor must be able to support this |
Brian Salomon | 09d994e | 2016-12-21 11:14:46 -0500 | [diff] [blame] | 21 | * functionality. |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 22 | * |
| 23 | * There are two feedback loops between the GrFragmentProcessors, the GrXferProcessor, and the |
Brian Salomon | cb30bb2 | 2017-02-12 09:28:54 -0500 | [diff] [blame] | 24 | * GrPrimitiveProcessor. These loops run on the CPU and to determine known properties of the final |
| 25 | * color and coverage inputs to the GrXferProcessor in order to perform optimizations that preserve |
| 26 | * correctness. The GrDrawOp seeds these loops with initial color and coverage, in its |
Brian Salomon | a811b12 | 2017-03-30 08:21:32 -0400 | [diff] [blame] | 27 | * getProcessorAnalysisInputs implementation. These seed values are processed by the |
Brian Salomon | 5298dc8 | 2017-02-22 11:52:03 -0500 | [diff] [blame] | 28 | * subsequent |
Brian Salomon | 92aee3d | 2016-12-21 09:20:25 -0500 | [diff] [blame] | 29 | * stages of the rendering pipeline and the output is then fed back into the GrDrawOp in |
| 30 | * the applyPipelineOptimizations call, where the op can use the information to inform decisions |
| 31 | * about GrPrimitiveProcessor creation. |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 32 | */ |
| 33 | |
egdaniel | e659a58 | 2015-11-13 09:55:43 -0800 | [diff] [blame] | 34 | class GrGLSLPrimitiveProcessor; |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 35 | |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 36 | /* |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 37 | * GrPrimitiveProcessor defines an interface which all subclasses must implement. All |
| 38 | * GrPrimitiveProcessors must proivide seed color and coverage for the Ganesh color / coverage |
| 39 | * pipelines, and they must provide some notion of equality |
| 40 | */ |
Brian Salomon | d61c9d9 | 2017-04-10 10:54:25 -0400 | [diff] [blame^] | 41 | class GrPrimitiveProcessor : public GrResourceIOProcessor, public GrProgramElement { |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 42 | public: |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 43 | // Only the GrGeometryProcessor subclass actually has a geo shader or vertex attributes, but |
| 44 | // we put these calls on the base class to prevent having to cast |
| 45 | virtual bool willUseGeoShader() const = 0; |
| 46 | |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 47 | struct Attribute { |
| 48 | Attribute() |
halcanary | 96fcdcc | 2015-08-27 07:41:13 -0700 | [diff] [blame] | 49 | : fName(nullptr) |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 50 | , fType(kFloat_GrVertexAttribType) |
| 51 | , fOffset(0) {} |
bsalomon | 6cb807b | 2016-08-17 11:33:39 -0700 | [diff] [blame] | 52 | Attribute(const char* name, GrVertexAttribType type, GrSLPrecision precision) |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 53 | : fName(name) |
| 54 | , fType(type) |
senorblanco | f2539d5 | 2015-05-20 14:03:42 -0700 | [diff] [blame] | 55 | , fOffset(SkAlign4(GrVertexAttribTypeSize(type))) |
| 56 | , fPrecision(precision) {} |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 57 | const char* fName; |
| 58 | GrVertexAttribType fType; |
| 59 | size_t fOffset; |
senorblanco | f2539d5 | 2015-05-20 14:03:42 -0700 | [diff] [blame] | 60 | GrSLPrecision fPrecision; |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 61 | }; |
| 62 | |
bsalomon | 7dbd45d | 2016-03-23 10:40:53 -0700 | [diff] [blame] | 63 | int numAttribs() const { return fAttribs.count(); } |
| 64 | const Attribute& getAttrib(int index) const { return fAttribs[index]; } |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 65 | |
| 66 | // Returns the vertex stride of the GP. A common use case is to request geometry from a |
Robert Phillips | f2361d2 | 2016-10-25 14:20:06 -0400 | [diff] [blame] | 67 | // GrOpList based off of the stride, and to populate this memory using an implicit array of |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 68 | // structs. In this case, it is best to assert the vertexstride == sizeof(VertexStruct). |
| 69 | size_t getVertexStride() const { return fVertexStride; } |
| 70 | |
| 71 | /** |
wangyix | a7f4c43 | 2015-08-20 07:25:02 -0700 | [diff] [blame] | 72 | * Computes a transformKey from an array of coord transforms. Will only look at the first |
| 73 | * <numCoords> transforms in the array. |
| 74 | * |
| 75 | * TODO: A better name for this function would be "compute" instead of "get". |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 76 | */ |
wangyix | a7f4c43 | 2015-08-20 07:25:02 -0700 | [diff] [blame] | 77 | uint32_t getTransformKey(const SkTArray<const GrCoordTransform*, true>& coords, |
| 78 | int numCoords) const; |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 79 | |
| 80 | /** |
| 81 | * Sets a unique key on the GrProcessorKeyBuilder that is directly associated with this geometry |
| 82 | * processor's GL backend implementation. |
wangyix | a7f4c43 | 2015-08-20 07:25:02 -0700 | [diff] [blame] | 83 | * |
| 84 | * TODO: A better name for this function would be "compute" instead of "get". |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 85 | */ |
Brian Salomon | 94efbf5 | 2016-11-29 13:43:05 -0500 | [diff] [blame] | 86 | virtual void getGLSLProcessorKey(const GrShaderCaps&, GrProcessorKeyBuilder*) const = 0; |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 87 | |
| 88 | |
| 89 | /** Returns a new instance of the appropriate *GL* implementation class |
| 90 | for the given GrProcessor; caller is responsible for deleting |
| 91 | the object. */ |
Brian Salomon | 94efbf5 | 2016-11-29 13:43:05 -0500 | [diff] [blame] | 92 | virtual GrGLSLPrimitiveProcessor* createGLSLInstance(const GrShaderCaps&) const = 0; |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 93 | |
ethannicholas | 2279325 | 2016-01-30 09:59:10 -0800 | [diff] [blame] | 94 | virtual bool isPathRendering() const { return false; } |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 95 | |
ethannicholas | 2279325 | 2016-01-30 09:59:10 -0800 | [diff] [blame] | 96 | /** |
| 97 | * If non-null, overrides the dest color returned by GrGLSLFragmentShaderBuilder::dstColor(). |
| 98 | */ |
| 99 | virtual const char* getDestColorOverride() const { return nullptr; } |
halcanary | 9d524f2 | 2016-03-29 09:03:52 -0700 | [diff] [blame] | 100 | |
ethannicholas | 28ef445 | 2016-03-25 09:26:03 -0700 | [diff] [blame] | 101 | virtual float getSampleShading() const { |
| 102 | return 0.0; |
| 103 | } |
| 104 | |
dvonbeck | 9b03e7b | 2016-08-01 11:01:56 -0700 | [diff] [blame] | 105 | /* Sub-class should override and return true if this primitive processor implements the distance |
| 106 | * vector field, a field of vectors to the nearest point in the edge of the shape. */ |
| 107 | virtual bool implementsDistanceVector() const { return false; } |
| 108 | |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 109 | protected: |
bsalomon | 7dbd45d | 2016-03-23 10:40:53 -0700 | [diff] [blame] | 110 | GrPrimitiveProcessor() : fVertexStride(0) {} |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 111 | |
bsalomon | 7dbd45d | 2016-03-23 10:40:53 -0700 | [diff] [blame] | 112 | enum { kPreallocAttribCnt = 8 }; |
| 113 | SkSTArray<kPreallocAttribCnt, Attribute> fAttribs; |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 114 | size_t fVertexStride; |
| 115 | |
| 116 | private: |
Brian Salomon | d61c9d9 | 2017-04-10 10:54:25 -0400 | [diff] [blame^] | 117 | void addPendingIOs() const override { GrResourceIOProcessor::addPendingIOs(); } |
| 118 | void removeRefs() const override { GrResourceIOProcessor::removeRefs(); } |
| 119 | void pendingIOComplete() const override { GrResourceIOProcessor::pendingIOComplete(); } |
Mike Klein | fc6c37b | 2016-09-27 09:34:10 -0400 | [diff] [blame] | 120 | void notifyRefCntIsZero() const final {} |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 121 | virtual bool hasExplicitLocalCoords() const = 0; |
| 122 | |
joshualitt | 8072caa | 2015-02-12 14:20:52 -0800 | [diff] [blame] | 123 | typedef GrProcessor INHERITED; |
| 124 | }; |
| 125 | |
| 126 | #endif |