3 * Copyright 2011 Google Inc.
5 * Use of this source code is governed by a BSD-style license that can be
6 * found in the LICENSE file.
10 #ifndef GrPaint_DEFINED
11 #define GrPaint_DEFINED
14 #include "GrProcessorStage.h"
16 #include "SkXfermode.h"
19 * The paint describes how color and coverage are computed at each pixel by GrContext draw
20 * functions and the how color is blended with the destination pixel.
22 * The paint allows installation of custom color and coverage stages. New types of stages are
23 * created by subclassing GrProcessor.
25 * The primitive color computation starts with the color specified by setColor(). This color is the
26 * input to the first color stage. Each color stage feeds its output to the next color stage. The
27 * final color stage's output color is input to the color filter specified by
28 * setXfermodeColorFilter which produces the final source color, S.
30 * Fractional pixel coverage follows a similar flow. The coverage is initially the value specified
31 * by setCoverage(). This is input to the first coverage stage. Coverage stages are chained
32 * together in the same manner as color stages. The output of the last stage is modulated by any
33 * fractional coverage produced by anti-aliasing. This last step produces the final coverage, C.
35 * setBlendFunc() specifies blending coefficients for S (described above) and D, the initial value
36 * of the destination pixel, labeled Bs and Bd respectively. The final value of the destination
37 * pixel is then D' = (1-C)*D + C*(Bd*D + Bs*S).
39 * Note that the coverage is applied after the blend. This is why they are computed as distinct
42 * TODO: Encapsulate setXfermodeColorFilter in a GrProcessor and remove from GrPaint.
46 GrPaint() { this->reset(); }
48 GrPaint(const GrPaint& paint) { *this = paint; }
53 * Sets the blending coefficients to use to blend the final primitive color with the
54 * destination color. Defaults to kOne for src and kZero for dst (i.e. src mode).
56 void setBlendFunc(GrBlendCoeff srcCoeff, GrBlendCoeff dstCoeff) {
57 fSrcBlendCoeff = srcCoeff;
58 fDstBlendCoeff = dstCoeff;
60 GrBlendCoeff getSrcBlendCoeff() const { return fSrcBlendCoeff; }
61 GrBlendCoeff getDstBlendCoeff() const { return fDstBlendCoeff; }
64 * The initial color of the drawn primitive. Defaults to solid white.
66 void setColor(GrColor color) { fColor = color; }
67 GrColor getColor() const { return fColor; }
70 * Applies fractional coverage to the entire drawn primitive. Defaults to 0xff.
72 void setCoverage(uint8_t coverage) { fCoverage = coverage; }
73 uint8_t getCoverage() const { return fCoverage; }
76 * Should primitives be anti-aliased or not. Defaults to false.
78 void setAntiAlias(bool aa) { fAntiAlias = aa; }
79 bool isAntiAlias() const { return fAntiAlias; }
82 * Should dithering be applied. Defaults to false.
84 void setDither(bool dither) { fDither = dither; }
85 bool isDither() const { return fDither; }
88 * Appends an additional color processor to the color computation.
90 const GrFragmentProcessor* addColorProcessor(const GrFragmentProcessor* fp) {
92 if (!fp->willUseInputColor()) {
95 SkNEW_APPEND_TO_TARRAY(&fColorStages, GrProcessorStage, (fp));
100 * Appends an additional coverage processor to the coverage computation.
102 const GrFragmentProcessor* addCoverageProcessor(const GrFragmentProcessor* fp) {
104 if (!fp->willUseInputColor()) {
105 fCoverageStages.reset();
107 SkNEW_APPEND_TO_TARRAY(&fCoverageStages, GrProcessorStage, (fp));
112 * Helpers for adding color or coverage effects that sample a texture. The matrix is applied
113 * to the src space position to compute texture coordinates.
115 void addColorTextureProcessor(GrTexture*, const SkMatrix&);
116 void addCoverageTextureProcessor(GrTexture*, const SkMatrix&);
117 void addColorTextureProcessor(GrTexture*, const SkMatrix&, const GrTextureParams&);
118 void addCoverageTextureProcessor(GrTexture*, const SkMatrix&, const GrTextureParams&);
120 int numColorStages() const { return fColorStages.count(); }
121 int numCoverageStages() const { return fCoverageStages.count(); }
122 int numTotalStages() const { return this->numColorStages() + this->numCoverageStages(); }
124 const GrFragmentStage& getColorStage(int s) const { return fColorStages[s]; }
125 const GrFragmentStage& getCoverageStage(int s) const { return fCoverageStages[s]; }
127 GrPaint& operator=(const GrPaint& paint) {
128 fSrcBlendCoeff = paint.fSrcBlendCoeff;
129 fDstBlendCoeff = paint.fDstBlendCoeff;
130 fAntiAlias = paint.fAntiAlias;
131 fDither = paint.fDither;
133 fColor = paint.fColor;
134 fCoverage = paint.fCoverage;
136 fColorStages = paint.fColorStages;
137 fCoverageStages = paint.fCoverageStages;
143 * Resets the paint to the defaults.
147 this->resetOptions();
149 this->resetCoverage();
154 * Determines whether the drawing with this paint is opaque with respect to both color blending
155 * and fractional coverage. It does not consider whether AA has been enabled on the paint or
156 * not. Depending upon whether multisampling or coverage-based AA is in use, AA may make the
157 * result only apply to the interior of primitives.
160 bool isOpaque() const;
163 * Returns true if isOpaque would return true and the paint represents a solid constant color
164 * draw. If the result is true, constantColor will be updated to contain the constant color.
166 bool isOpaqueAndConstantColor(GrColor* constantColor) const;
171 * Helper for isOpaque and isOpaqueAndConstantColor.
173 bool getOpaqueAndKnownColor(GrColor* solidColor, uint32_t* solidColorKnownComponents) const;
176 * Called when the source coord system from which geometry is rendered changes. It ensures that
177 * the local coordinates seen by effects remains unchanged. oldToNew gives the transformation
178 * from the previous coord system to the new coord system.
180 void localCoordChange(const SkMatrix& oldToNew) {
181 for (int i = 0; i < fColorStages.count(); ++i) {
182 fColorStages[i].localCoordChange(oldToNew);
184 for (int i = 0; i < fCoverageStages.count(); ++i) {
185 fCoverageStages[i].localCoordChange(oldToNew);
189 bool localCoordChangeInverse(const SkMatrix& newToOld) {
191 bool computed = false;
192 for (int i = 0; i < fColorStages.count(); ++i) {
193 if (!computed && !newToOld.invert(&oldToNew)) {
198 fColorStages[i].localCoordChange(oldToNew);
200 for (int i = 0; i < fCoverageStages.count(); ++i) {
201 if (!computed && !newToOld.invert(&oldToNew)) {
206 fCoverageStages[i].localCoordChange(oldToNew);
211 friend class GrContext; // To access above two functions
212 friend class GrStencilAndCoverTextContext; // To access above two functions
214 SkSTArray<4, GrFragmentStage> fColorStages;
215 SkSTArray<2, GrFragmentStage> fCoverageStages;
217 GrBlendCoeff fSrcBlendCoeff;
218 GrBlendCoeff fDstBlendCoeff;
226 fSrcBlendCoeff = kOne_GrBlendCoeff;
227 fDstBlendCoeff = kZero_GrBlendCoeff;
230 void resetOptions() {
236 fColor = GrColorPackRGBA(0xff, 0xff, 0xff, 0xff);
239 void resetCoverage() {
244 fColorStages.reset();
245 fCoverageStages.reset();