OLD | NEW |
1 /* | 1 /* |
2 * Copyright 2006 The Android Open Source Project | 2 * Copyright 2006 The Android Open Source Project |
3 * | 3 * |
4 * Use of this source code is governed by a BSD-style license that can be | 4 * Use of this source code is governed by a BSD-style license that can be |
5 * found in the LICENSE file. | 5 * found in the LICENSE file. |
6 */ | 6 */ |
7 | 7 |
8 #ifndef SkGradientShader_DEFINED | 8 #ifndef SkGradientShader_DEFINED |
9 #define SkGradientShader_DEFINED | 9 #define SkGradientShader_DEFINED |
10 | 10 |
11 #include "SkShader.h" | 11 #include "SkShader.h" |
12 | 12 |
13 class SkUnitMapper; | |
14 | |
15 /** \class SkGradientShader | 13 /** \class SkGradientShader |
16 | 14 |
17 SkGradientShader hosts factories for creating subclasses of SkShader that | 15 SkGradientShader hosts factories for creating subclasses of SkShader that |
18 render linear and radial gradients. | 16 render linear and radial gradients. |
19 */ | 17 */ |
20 class SK_API SkGradientShader { | 18 class SK_API SkGradientShader { |
21 public: | 19 public: |
22 enum Flags { | 20 enum Flags { |
23 /** By default gradients will interpolate their colors in unpremul space | 21 /** By default gradients will interpolate their colors in unpremul space |
24 * and then premultiply each of the results. By setting this flag, the | 22 * and then premultiply each of the results. By setting this flag, the |
(...skipping 11 matching lines...) Expand all Loading... |
36 It is an error for count to be < 2. | 34 It is an error for count to be < 2. |
37 @param pts The start and end points for the gradient. | 35 @param pts The start and end points for the gradient. |
38 @param colors The array[count] of colors, to be distributed between th
e two points | 36 @param colors The array[count] of colors, to be distributed between th
e two points |
39 @param pos May be NULL. array[count] of SkScalars, or NULL, of the
relative position of | 37 @param pos May be NULL. array[count] of SkScalars, or NULL, of the
relative position of |
40 each corresponding color in the colors array. If this is
NULL, | 38 each corresponding color in the colors array. If this is
NULL, |
41 the the colors are distributed evenly between the start
and end point. | 39 the the colors are distributed evenly between the start
and end point. |
42 If this is not null, the values must begin with 0, end w
ith 1.0, and | 40 If this is not null, the values must begin with 0, end w
ith 1.0, and |
43 intermediate values must be strictly increasing. | 41 intermediate values must be strictly increasing. |
44 @param count Must be >=2. The number of colors (and pos if not NULL)
entries. | 42 @param count Must be >=2. The number of colors (and pos if not NULL)
entries. |
45 @param mode The tiling mode | 43 @param mode The tiling mode |
46 @param mapper May be NULL. Callback to modify the spread of the colors
. | |
47 */ | 44 */ |
48 static SkShader* CreateLinear(const SkPoint pts[2], | 45 static SkShader* CreateLinear(const SkPoint pts[2], |
49 const SkColor colors[], const SkScalar pos[],
int count, | 46 const SkColor colors[], const SkScalar pos[],
int count, |
50 SkShader::TileMode mode, | 47 SkShader::TileMode mode, |
51 SkUnitMapper* mapper = NULL, | 48 uint32_t flags, const SkMatrix* localMatrix); |
52 uint32_t flags = 0, | |
53 const SkMatrix* localMatrix = NULL); | |
54 | 49 |
55 static SkShader* CreateLinear(const SkPoint pts[2], | 50 static SkShader* CreateLinear(const SkPoint pts[2], |
56 const SkColor colors[], const SkScalar pos[],
int count, | 51 const SkColor colors[], const SkScalar pos[],
int count, |
57 SkShader::TileMode mode, | 52 SkShader::TileMode mode) { |
58 uint32_t flags, | 53 return CreateLinear(pts, colors, pos, count, mode, 0, NULL); |
59 const SkMatrix* localMatrix) { | |
60 return CreateLinear(pts, colors, pos, count, mode, NULL, flags, localMat
rix); | |
61 } | 54 } |
62 | 55 |
63 /** Returns a shader that generates a radial gradient given the center and r
adius. | 56 /** Returns a shader that generates a radial gradient given the center and r
adius. |
64 <p /> | 57 <p /> |
65 CreateRadial returns a shader with a reference count of 1. | 58 CreateRadial returns a shader with a reference count of 1. |
66 The caller should decrement the shader's reference count when done with
the shader. | 59 The caller should decrement the shader's reference count when done with
the shader. |
67 It is an error for colorCount to be < 2, or for radius to be <= 0. | 60 It is an error for colorCount to be < 2, or for radius to be <= 0. |
68 @param center The center of the circle for this gradient | 61 @param center The center of the circle for this gradient |
69 @param radius Must be positive. The radius of the circle for this grad
ient | 62 @param radius Must be positive. The radius of the circle for this grad
ient |
70 @param colors The array[count] of colors, to be distributed between th
e center and edge of the circle | 63 @param colors The array[count] of colors, to be distributed between th
e center and edge of the circle |
71 @param pos May be NULL. The array[count] of SkScalars, or NULL, of
the relative position of | 64 @param pos May be NULL. The array[count] of SkScalars, or NULL, of
the relative position of |
72 each corresponding color in the colors array. If this is
NULL, | 65 each corresponding color in the colors array. If this is
NULL, |
73 the the colors are distributed evenly between the center
and edge of the circle. | 66 the the colors are distributed evenly between the center
and edge of the circle. |
74 If this is not null, the values must begin with 0, end w
ith 1.0, and | 67 If this is not null, the values must begin with 0, end w
ith 1.0, and |
75 intermediate values must be strictly increasing. | 68 intermediate values must be strictly increasing. |
76 @param count Must be >= 2. The number of colors (and pos if not NULL)
entries | 69 @param count Must be >= 2. The number of colors (and pos if not NULL)
entries |
77 @param mode The tiling mode | 70 @param mode The tiling mode |
78 @param mapper May be NULL. Callback to modify the spread of the colors
. | |
79 */ | 71 */ |
80 static SkShader* CreateRadial(const SkPoint& center, SkScalar radius, | 72 static SkShader* CreateRadial(const SkPoint& center, SkScalar radius, |
81 const SkColor colors[], const SkScalar pos[],
int count, | 73 const SkColor colors[], const SkScalar pos[],
int count, |
82 SkShader::TileMode mode, | 74 SkShader::TileMode mode, |
83 SkUnitMapper* mapper = NULL, | 75 uint32_t flags, const SkMatrix* localMatrix); |
84 uint32_t flags = 0, | |
85 const SkMatrix* localMatrix = NULL); | |
86 | 76 |
87 static SkShader* CreateRadial(const SkPoint& center, SkScalar radius, | 77 static SkShader* CreateRadial(const SkPoint& center, SkScalar radius, |
88 const SkColor colors[], const SkScalar pos[],
int count, | 78 const SkColor colors[], const SkScalar pos[],
int count, |
89 SkShader::TileMode mode, | 79 SkShader::TileMode mode) { |
90 uint32_t flags, | 80 return CreateRadial(center, radius, colors, pos, count, mode, 0, NULL); |
91 const SkMatrix* localMatrix) { | |
92 return CreateRadial(center, radius, colors, pos, count, mode, NULL, flag
s, localMatrix); | |
93 } | 81 } |
94 | 82 |
95 /** Returns a shader that generates a radial gradient given the start positi
on, start radius, end position and end radius. | 83 /** Returns a shader that generates a radial gradient given the start positi
on, start radius, end position and end radius. |
96 <p /> | 84 <p /> |
97 CreateTwoPointRadial returns a shader with a reference count of 1. | 85 CreateTwoPointRadial returns a shader with a reference count of 1. |
98 The caller should decrement the shader's reference count when done with
the shader. | 86 The caller should decrement the shader's reference count when done with
the shader. |
99 It is an error for colorCount to be < 2, for startRadius or endRadius to
be < 0, or for | 87 It is an error for colorCount to be < 2, for startRadius or endRadius to
be < 0, or for |
100 startRadius to be equal to endRadius. | 88 startRadius to be equal to endRadius. |
101 @param start The center of the start circle for this gradient | 89 @param start The center of the start circle for this gradient |
102 @param startRadius Must be positive. The radius of the start circle f
or this gradient. | 90 @param startRadius Must be positive. The radius of the start circle f
or this gradient. |
103 @param end The center of the end circle for this gradient | 91 @param end The center of the end circle for this gradient |
104 @param endRadius Must be positive. The radius of the end circle for th
is gradient. | 92 @param endRadius Must be positive. The radius of the end circle for th
is gradient. |
105 @param colors The array[count] of colors, to be distributed between th
e center and edge of the circle | 93 @param colors The array[count] of colors, to be distributed between th
e center and edge of the circle |
106 @param pos May be NULL. The array[count] of SkScalars, or NULL, of
the relative position of | 94 @param pos May be NULL. The array[count] of SkScalars, or NULL, of
the relative position of |
107 each corresponding color in the colors array. If this is
NULL, | 95 each corresponding color in the colors array. If this is
NULL, |
108 the the colors are distributed evenly between the center
and edge of the circle. | 96 the the colors are distributed evenly between the center
and edge of the circle. |
109 If this is not null, the values must begin with 0, end w
ith 1.0, and | 97 If this is not null, the values must begin with 0, end w
ith 1.0, and |
110 intermediate values must be strictly increasing. | 98 intermediate values must be strictly increasing. |
111 @param count Must be >= 2. The number of colors (and pos if not NULL)
entries | 99 @param count Must be >= 2. The number of colors (and pos if not NULL)
entries |
112 @param mode The tiling mode | 100 @param mode The tiling mode |
113 @param mapper May be NULL. Callback to modify the spread of the colors
. | |
114 */ | 101 */ |
115 static SkShader* CreateTwoPointRadial(const SkPoint& start, | 102 static SkShader* CreateTwoPointRadial(const SkPoint& start, SkScalar startRa
dius, |
116 SkScalar startRadius, | 103 const SkPoint& end, SkScalar endRadius
, |
117 const SkPoint& end, | 104 const SkColor colors[], const SkScalar
pos[], int count, |
118 SkScalar endRadius, | |
119 const SkColor colors[], | |
120 const SkScalar pos[], int count, | |
121 SkShader::TileMode mode, | 105 SkShader::TileMode mode, |
122 SkUnitMapper* mapper = NULL, | 106 uint32_t flags, const SkMatrix* localM
atrix); |
123 uint32_t flags = 0, | |
124 const SkMatrix* localMatrix = NULL); | |
125 | 107 |
126 static SkShader* CreateTwoPointRadial(const SkPoint& start, | 108 static SkShader* CreateTwoPointRadial(const SkPoint& start, SkScalar startRa
dius, |
127 SkScalar startRadius, | 109 const SkPoint& end, SkScalar endRadius
, |
128 const SkPoint& end, | 110 const SkColor colors[], const SkScalar
pos[], int count, |
129 SkScalar endRadius, | 111 SkShader::TileMode mode) { |
130 const SkColor colors[], | |
131 const SkScalar pos[], int count, | |
132 SkShader::TileMode mode, | |
133 uint32_t flags, | |
134 const SkMatrix* localMatrix) { | |
135 return CreateTwoPointRadial(start, startRadius, end, endRadius, colors,
pos, count, mode, | 112 return CreateTwoPointRadial(start, startRadius, end, endRadius, colors,
pos, count, mode, |
136 NULL, flags, localMatrix); | 113 0, NULL); |
137 } | 114 } |
138 | 115 |
139 /** | 116 /** |
140 * Returns a shader that generates a conical gradient given two circles, or | 117 * Returns a shader that generates a conical gradient given two circles, or |
141 * returns NULL if the inputs are invalid. The gradient interprets the | 118 * returns NULL if the inputs are invalid. The gradient interprets the |
142 * two circles according to the following HTML spec. | 119 * two circles according to the following HTML spec. |
143 * http://dev.w3.org/html5/2dcontext/#dom-context-2d-createradialgradient | 120 * http://dev.w3.org/html5/2dcontext/#dom-context-2d-createradialgradient |
144 */ | 121 */ |
145 static SkShader* CreateTwoPointConical(const SkPoint& start, | 122 static SkShader* CreateTwoPointConical(const SkPoint& start, SkScalar startR
adius, |
146 SkScalar startRadius, | 123 const SkPoint& end, SkScalar endRadiu
s, |
147 const SkPoint& end, | 124 const SkColor colors[], const SkScala
r pos[], int count, |
148 SkScalar endRadius, | |
149 const SkColor colors[], | |
150 const SkScalar pos[], int count, | |
151 SkShader::TileMode mode, | 125 SkShader::TileMode mode, |
152 SkUnitMapper* mapper = NULL, | 126 uint32_t flags, const SkMatrix* local
Matrix); |
153 uint32_t flags = 0, | |
154 const SkMatrix* localMatrix = NULL); | |
155 | 127 |
156 static SkShader* CreateTwoPointConical(const SkPoint& start, | 128 static SkShader* CreateTwoPointConical(const SkPoint& start, SkScalar startR
adius, |
157 SkScalar startRadius, | 129 const SkPoint& end, SkScalar endRadiu
s, |
158 const SkPoint& end, | 130 const SkColor colors[], const SkScala
r pos[], int count, |
159 SkScalar endRadius, | 131 SkShader::TileMode mode) { |
160 const SkColor colors[], | |
161 const SkScalar pos[], int count, | |
162 SkShader::TileMode mode, | |
163 uint32_t flags, | |
164 const SkMatrix* localMatrix) { | |
165 return CreateTwoPointConical(start, startRadius, end, endRadius, colors,
pos, count, mode, | 132 return CreateTwoPointConical(start, startRadius, end, endRadius, colors,
pos, count, mode, |
166 NULL, flags, localMatrix); | 133 0, NULL); |
167 } | 134 } |
168 | 135 |
169 /** Returns a shader that generates a sweep gradient given a center. | 136 /** Returns a shader that generates a sweep gradient given a center. |
170 <p /> | 137 <p /> |
171 CreateSweep returns a shader with a reference count of 1. | 138 CreateSweep returns a shader with a reference count of 1. |
172 The caller should decrement the shader's reference count when done with
the shader. | 139 The caller should decrement the shader's reference count when done with
the shader. |
173 It is an error for colorCount to be < 2. | 140 It is an error for colorCount to be < 2. |
174 @param cx The X coordinate of the center of the sweep | 141 @param cx The X coordinate of the center of the sweep |
175 @param cx The Y coordinate of the center of the sweep | 142 @param cx The Y coordinate of the center of the sweep |
176 @param colors The array[count] of colors, to be distributed around the
center. | 143 @param colors The array[count] of colors, to be distributed around the
center. |
177 @param pos May be NULL. The array[count] of SkScalars, or NULL, of
the relative position of | 144 @param pos May be NULL. The array[count] of SkScalars, or NULL, of
the relative position of |
178 each corresponding color in the colors array. If this is
NULL, | 145 each corresponding color in the colors array. If this is
NULL, |
179 the the colors are distributed evenly between the center
and edge of the circle. | 146 the the colors are distributed evenly between the center
and edge of the circle. |
180 If this is not null, the values must begin with 0, end w
ith 1.0, and | 147 If this is not null, the values must begin with 0, end w
ith 1.0, and |
181 intermediate values must be strictly increasing. | 148 intermediate values must be strictly increasing. |
182 @param count Must be >= 2. The number of colors (and pos if not NULL)
entries | 149 @param count Must be >= 2. The number of colors (and pos if not NULL)
entries |
183 @param mapper May be NULL. Callback to modify the spread of the colors
. | |
184 */ | 150 */ |
185 static SkShader* CreateSweep(SkScalar cx, SkScalar cy, | 151 static SkShader* CreateSweep(SkScalar cx, SkScalar cy, |
186 const SkColor colors[], const SkScalar pos[], | 152 const SkColor colors[], const SkScalar pos[], i
nt count, |
187 int count, SkUnitMapper* mapper = NULL, | 153 uint32_t flags, const SkMatrix* localMatrix); |
188 uint32_t flags = 0, | |
189 const SkMatrix* localMatrix = NULL); | |
190 | 154 |
191 static SkShader* CreateSweep(SkScalar cx, SkScalar cy, | 155 static SkShader* CreateSweep(SkScalar cx, SkScalar cy, |
192 const SkColor colors[], const SkScalar pos[], i
nt count, | 156 const SkColor colors[], const SkScalar pos[], i
nt count) { |
193 uint32_t flags, const SkMatrix* localMatrix) { | 157 return CreateSweep(cx, cy, colors, pos, count, 0, NULL); |
194 return CreateSweep(cx, cy, colors, pos, count, NULL, flags, localMatrix)
; | |
195 } | 158 } |
196 | 159 |
197 SK_DECLARE_FLATTENABLE_REGISTRAR_GROUP() | 160 SK_DECLARE_FLATTENABLE_REGISTRAR_GROUP() |
198 }; | 161 }; |
199 | 162 |
200 #endif | 163 #endif |
OLD | NEW |