blob: f4e6919c2bb861d20a9610677a16a747e6d2f63b [file] [log] [blame]
Romain Guye4d01122010-06-16 18:44:05 -07001/*
2 * Copyright (C) 2010 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Romain Guy5b3b3522010-10-27 18:57:51 -070017#ifndef ANDROID_HWUI_OPENGL_RENDERER_H
18#define ANDROID_HWUI_OPENGL_RENDERER_H
Romain Guy9d5316e2010-06-24 19:30:36 -070019
20#include <GLES2/gl2.h>
21#include <GLES2/gl2ext.h>
Romain Guy85bf02f2010-06-22 13:11:24 -070022
Romain Guyce0537b2010-06-29 21:05:21 -070023#include <SkBitmap.h>
Romain Guyf6a11b82010-06-23 17:47:49 -070024#include <SkMatrix.h>
Romain Guyce0537b2010-06-29 21:05:21 -070025#include <SkPaint.h>
Romain Guy079ba2c2010-07-16 14:12:24 -070026#include <SkRegion.h>
Romain Guyd27977d2010-07-14 19:18:51 -070027#include <SkShader.h>
Romain Guy85bf02f2010-06-22 13:11:24 -070028#include <SkXfermode.h>
Romain Guye4d01122010-06-16 18:44:05 -070029
Chet Haasedaf98e92011-01-10 14:10:36 -080030#include <utils/Functor.h>
Romain Guybb9524b2010-06-22 18:56:38 -070031#include <utils/RefBase.h>
Romain Guyba6be8a2012-04-23 18:22:09 -070032#include <utils/SortedVector.h>
Romain Guy86942302010-09-12 13:02:16 -070033#include <utils/Vector.h>
Romain Guybb9524b2010-06-22 18:56:38 -070034
Romain Guy79537452011-10-12 13:48:51 -070035#include <cutils/compiler.h>
36
Romain Guyc15008e2010-11-10 11:59:15 -080037#include "Debug.h"
Romain Guy51769a62010-07-23 00:28:00 -070038#include "Extensions.h"
Romain Guyf6a11b82010-06-23 17:47:49 -070039#include "Matrix.h"
Romain Guy5cbbce52010-06-27 22:59:20 -070040#include "Program.h"
Romain Guybb9524b2010-06-22 18:56:38 -070041#include "Rect.h"
Romain Guy5cbbce52010-06-27 22:59:20 -070042#include "Snapshot.h"
Romain Guyf7f93552010-07-08 19:17:03 -070043#include "Vertex.h"
Romain Guy06f96e22010-07-30 19:18:16 -070044#include "SkiaShader.h"
Romain Guydb1938e2010-08-02 18:50:22 -070045#include "SkiaColorFilter.h"
Romain Guyfb8b7632010-08-23 21:05:08 -070046#include "Caches.h"
Romain Guybb9524b2010-06-22 18:56:38 -070047
Romain Guye4d01122010-06-16 18:44:05 -070048namespace android {
Romain Guy9d5316e2010-06-24 19:30:36 -070049namespace uirenderer {
Romain Guye4d01122010-06-16 18:44:05 -070050
Romain Guyf6a11b82010-06-23 17:47:49 -070051///////////////////////////////////////////////////////////////////////////////
Romain Guyf6a11b82010-06-23 17:47:49 -070052// Renderer
53///////////////////////////////////////////////////////////////////////////////
54
Romain Guy0fe478e2010-11-08 12:08:41 -080055class DisplayList;
Romain Guyb051e892010-09-28 19:09:36 -070056
Romain Guy5cbbce52010-06-27 22:59:20 -070057/**
58 * OpenGL renderer used to draw accelerated 2D graphics. The API is a
59 * simplified version of Skia's Canvas API.
60 */
Romain Guy85bf02f2010-06-22 13:11:24 -070061class OpenGLRenderer {
Romain Guye4d01122010-06-16 18:44:05 -070062public:
Romain Guy79537452011-10-12 13:48:51 -070063 ANDROID_API OpenGLRenderer();
Romain Guye2d345e2010-09-24 18:39:22 -070064 virtual ~OpenGLRenderer();
Romain Guye4d01122010-06-16 18:44:05 -070065
Romain Guy17112ad2012-08-07 11:24:39 -070066 /**
67 * Indicates whether this renderer executes drawing commands immediately.
68 * If this method returns true, the drawing commands will be executed
69 * later.
70 */
Romain Guy49c5fc02012-05-15 11:10:01 -070071 virtual bool isDeferred();
72
Romain Guy17112ad2012-08-07 11:24:39 -070073 /**
74 * Sets the dimension of the underlying drawing surface. This method must
75 * be called at least once every time the drawing surface changes size.
76 *
77 * @param width The width in pixels of the underlysing surface
78 * @param height The height in pixels of the underlysing surface
79 */
Romain Guyb051e892010-09-28 19:09:36 -070080 virtual void setViewport(int width, int height);
Romain Guye2d345e2010-09-24 18:39:22 -070081
Romain Guy17112ad2012-08-07 11:24:39 -070082 /**
83 * Prepares the renderer to draw a frame. This method must be invoked
84 * at the beginning of each frame. When this method is invoked, the
85 * entire drawing surface is assumed to be redrawn.
86 *
87 * @param opaque If true, the target surface is considered opaque
88 * and will not be cleared. If false, the target surface
89 * will be cleared
90 */
Chet Haase44b2fe32012-06-06 19:03:58 -070091 ANDROID_API int prepare(bool opaque);
Romain Guye2d345e2010-09-24 18:39:22 -070092
Romain Guy17112ad2012-08-07 11:24:39 -070093 /**
94 * Prepares the renderer to draw a frame. This method must be invoked
95 * at the beginning of each frame. Only the specified rectangle of the
96 * frame is assumed to be dirty. A clip will automatically be set to
97 * the specified rectangle.
98 *
99 * @param left The left coordinate of the dirty rectangle
100 * @param top The top coordinate of the dirty rectangle
101 * @param right The right coordinate of the dirty rectangle
102 * @param bottom The bottom coordinate of the dirty rectangle
103 * @param opaque If true, the target surface is considered opaque
104 * and will not be cleared. If false, the target surface
105 * will be cleared in the specified dirty rectangle
106 */
107 virtual int prepareDirty(float left, float top, float right, float bottom, bool opaque);
108
109 /**
110 * Indicates the end of a frame. This method must be invoked whenever
111 * the caller is done rendering a frame.
112 */
113 virtual void finish();
Romain Guy6c319ca2011-01-11 14:29:25 -0800114
Romain Guy8f3b8e32012-03-27 16:33:45 -0700115 ANDROID_API status_t invokeFunctors(Rect& dirty);
Romain Guyba6be8a2012-04-23 18:22:09 -0700116 ANDROID_API void detachFunctor(Functor* functor);
117 ANDROID_API void attachFunctor(Functor* functor);
Romain Guy8f3b8e32012-03-27 16:33:45 -0700118 virtual status_t callDrawGLFunction(Functor* functor, Rect& dirty);
Romain Guy08ae3172010-06-21 19:35:50 -0700119
Romain Guy79537452011-10-12 13:48:51 -0700120 ANDROID_API int getSaveCount() const;
Romain Guy4aa90572010-09-26 18:40:37 -0700121 virtual int save(int flags);
122 virtual void restore();
123 virtual void restoreToCount(int saveCount);
Romain Guybb9524b2010-06-22 18:56:38 -0700124
Romain Guye2d345e2010-09-24 18:39:22 -0700125 virtual int saveLayer(float left, float top, float right, float bottom,
Chet Haase5c13d892010-10-08 08:37:55 -0700126 SkPaint* p, int flags);
Romain Guye2d345e2010-09-24 18:39:22 -0700127 virtual int saveLayerAlpha(float left, float top, float right, float bottom,
128 int alpha, int flags);
Romain Guybd6b79b2010-06-26 00:13:53 -0700129
Romain Guy4aa90572010-09-26 18:40:37 -0700130 virtual void translate(float dx, float dy);
131 virtual void rotate(float degrees);
132 virtual void scale(float sx, float sy);
Romain Guy807daf72011-01-18 11:19:19 -0800133 virtual void skew(float sx, float sy);
Romain Guyf6a11b82010-06-23 17:47:49 -0700134
Romain Guy79537452011-10-12 13:48:51 -0700135 ANDROID_API void getMatrix(SkMatrix* matrix);
Romain Guy4aa90572010-09-26 18:40:37 -0700136 virtual void setMatrix(SkMatrix* matrix);
137 virtual void concatMatrix(SkMatrix* matrix);
Romain Guyf6a11b82010-06-23 17:47:49 -0700138
Romain Guy79537452011-10-12 13:48:51 -0700139 ANDROID_API const Rect& getClipBounds();
140 ANDROID_API bool quickReject(float left, float top, float right, float bottom);
Romain Guy8a4ac612012-07-17 17:32:48 -0700141 bool quickRejectNoScissor(float left, float top, float right, float bottom);
Romain Guy4aa90572010-09-26 18:40:37 -0700142 virtual bool clipRect(float left, float top, float right, float bottom, SkRegion::Op op);
Chet Haasea23eed82012-04-12 15:19:04 -0700143 virtual Rect* getClipRect();
Romain Guybb9524b2010-06-22 18:56:38 -0700144
Chet Haase1271e2c2012-04-20 09:54:27 -0700145 virtual status_t drawDisplayList(DisplayList* displayList, Rect& dirty, int32_t flags,
146 uint32_t level = 0);
Chet Haaseed30fd82011-04-22 16:18:45 -0700147 virtual void outputDisplayList(DisplayList* displayList, uint32_t level = 0);
Chet Haase48659092012-05-31 15:21:51 -0700148 virtual status_t drawLayer(Layer* layer, float x, float y, SkPaint* paint);
149 virtual status_t drawBitmap(SkBitmap* bitmap, float left, float top, SkPaint* paint);
150 virtual status_t drawBitmap(SkBitmap* bitmap, SkMatrix* matrix, SkPaint* paint);
151 virtual status_t drawBitmap(SkBitmap* bitmap, float srcLeft, float srcTop,
Romain Guye2d345e2010-09-24 18:39:22 -0700152 float srcRight, float srcBottom, float dstLeft, float dstTop,
Chet Haase5c13d892010-10-08 08:37:55 -0700153 float dstRight, float dstBottom, SkPaint* paint);
Chet Haase48659092012-05-31 15:21:51 -0700154 virtual status_t drawBitmapData(SkBitmap* bitmap, float left, float top, SkPaint* paint);
155 virtual status_t drawBitmapMesh(SkBitmap* bitmap, int meshWidth, int meshHeight,
Romain Guy5a7b4662011-01-20 19:09:30 -0800156 float* vertices, int* colors, SkPaint* paint);
Chet Haase48659092012-05-31 15:21:51 -0700157 virtual status_t drawPatch(SkBitmap* bitmap, const int32_t* xDivs, const int32_t* yDivs,
Romain Guy4bb94202010-10-12 15:59:26 -0700158 const uint32_t* colors, uint32_t width, uint32_t height, int8_t numColors,
Chet Haase5c13d892010-10-08 08:37:55 -0700159 float left, float top, float right, float bottom, SkPaint* paint);
Romain Guybe6f9dc2012-07-16 12:41:17 -0700160 status_t drawPatch(SkBitmap* bitmap, const int32_t* xDivs, const int32_t* yDivs,
161 const uint32_t* colors, uint32_t width, uint32_t height, int8_t numColors,
162 float left, float top, float right, float bottom, int alpha, SkXfermode::Mode mode);
Chet Haase48659092012-05-31 15:21:51 -0700163 virtual status_t drawColor(int color, SkXfermode::Mode mode);
164 virtual status_t drawRect(float left, float top, float right, float bottom, SkPaint* paint);
165 virtual status_t drawRoundRect(float left, float top, float right, float bottom,
Romain Guy01d58e42011-01-19 21:54:02 -0800166 float rx, float ry, SkPaint* paint);
Chet Haase48659092012-05-31 15:21:51 -0700167 virtual status_t drawCircle(float x, float y, float radius, SkPaint* paint);
168 virtual status_t drawOval(float left, float top, float right, float bottom, SkPaint* paint);
169 virtual status_t drawArc(float left, float top, float right, float bottom,
Romain Guy8b2f5262011-01-23 16:15:02 -0800170 float startAngle, float sweepAngle, bool useCenter, SkPaint* paint);
Chet Haase48659092012-05-31 15:21:51 -0700171 virtual status_t drawPath(SkPath* path, SkPaint* paint);
172 virtual status_t drawLines(float* points, int count, SkPaint* paint);
173 virtual status_t drawPoints(float* points, int count, SkPaint* paint);
Chet Haase48659092012-05-31 15:21:51 -0700174 virtual status_t drawTextOnPath(const char* text, int bytesCount, int count, SkPath* path,
Romain Guy325740f2012-02-24 16:48:34 -0800175 float hOffset, float vOffset, SkPaint* paint);
Chet Haase48659092012-05-31 15:21:51 -0700176 virtual status_t drawPosText(const char* text, int bytesCount, int count,
Romain Guy325740f2012-02-24 16:48:34 -0800177 const float* positions, SkPaint* paint);
Romain Guyc2525952012-07-27 16:41:22 -0700178 virtual status_t drawText(const char* text, int bytesCount, int count, float x, float y,
Raph Levien996e57c2012-07-23 15:22:52 -0700179 const float* positions, SkPaint* paint, float length = -1.0f);
Romain Guy08ae3172010-06-21 19:35:50 -0700180
Romain Guy4aa90572010-09-26 18:40:37 -0700181 virtual void resetShader();
182 virtual void setupShader(SkiaShader* shader);
Romain Guyd27977d2010-07-14 19:18:51 -0700183
Romain Guy4aa90572010-09-26 18:40:37 -0700184 virtual void resetColorFilter();
185 virtual void setupColorFilter(SkiaColorFilter* filter);
Romain Guydb1938e2010-08-02 18:50:22 -0700186
Romain Guy4aa90572010-09-26 18:40:37 -0700187 virtual void resetShadow();
188 virtual void setupShadow(float radius, float dx, float dy, int color);
Romain Guy1e45aae2010-08-13 19:39:53 -0700189
Romain Guy5ff9df62012-01-23 17:09:05 -0800190 virtual void resetPaintFilter();
191 virtual void setupPaintFilter(int clearBits, int setBits);
192
193 SkPaint* filterPaint(SkPaint* paint);
194
Romain Guy17112ad2012-08-07 11:24:39 -0700195 /**
196 * Returns the desired size for the stencil buffer. If the returned value
197 * is 0, then no stencil buffer is required.
198 */
Romain Guy530041d2012-01-25 18:56:29 -0800199 ANDROID_API static uint32_t getStencilSize();
200
Romain Guy17112ad2012-08-07 11:24:39 -0700201 /**
202 * Sets the alpha on the current snapshot. This alpha value will be modulated
203 * with other alpha values when drawing primitives.
204 */
205 void setAlpha(float alpha) {
206 mSnapshot->alpha = alpha;
207 }
208
209 /**
210 * Inserts a named group marker in the stream of GL commands. This marker
211 * can be used by tools to group commands into logical groups. A call to
212 * this method must always be followed later on by a call to endMark().
213 */
Romain Guy13631f32012-01-30 17:41:55 -0800214 void startMark(const char* name) const;
Romain Guy17112ad2012-08-07 11:24:39 -0700215
216 /**
217 * Closes the last group marker opened by startMark().
218 */
Romain Guy13631f32012-01-30 17:41:55 -0800219 void endMark() const;
220
Romain Guye2d345e2010-09-24 18:39:22 -0700221protected:
Romain Guy17112ad2012-08-07 11:24:39 -0700222
223 /**
224 * This method must be invoked before handing control over to a draw functor.
225 * See callDrawGLFunction() for instance.
226 *
227 * This command must not be recorded inside display lists.
228 */
229 void interrupt();
230
231 /**
232 * This method must be invoked after getting control back from a draw functor.
233 *
234 * This command must not be recorded inside display lists.
235 */
236 void resume();
237
Romain Guye2d345e2010-09-24 18:39:22 -0700238 /**
239 * Compose the layer defined in the current snapshot with the layer
240 * defined by the previous snapshot.
241 *
242 * The current snapshot *must* be a layer (flag kFlagIsLayer set.)
243 *
244 * @param curent The current snapshot containing the layer to compose
245 * @param previous The previous snapshot to compose the current layer with
246 */
247 virtual void composeLayer(sp<Snapshot> current, sp<Snapshot> previous);
Romain Guy694b5192010-07-21 21:33:20 -0700248
Romain Guyada830f2011-01-13 12:13:20 -0800249 /**
Romain Guyf219da52011-01-16 12:54:25 -0800250 * Marks the specified region as dirty at the specified bounds.
Romain Guyada830f2011-01-13 12:13:20 -0800251 */
Romain Guyf219da52011-01-16 12:54:25 -0800252 void dirtyLayerUnchecked(Rect& bounds, Region* region);
Romain Guyada830f2011-01-13 12:13:20 -0800253
254 /**
Romain Guyf219da52011-01-16 12:54:25 -0800255 * Returns the current snapshot.
Romain Guyada830f2011-01-13 12:13:20 -0800256 */
Romain Guyf219da52011-01-16 12:54:25 -0800257 sp<Snapshot> getSnapshot() {
258 return mSnapshot;
259 }
Romain Guyada830f2011-01-13 12:13:20 -0800260
Romain Guy42f3a4b2011-01-19 13:42:26 -0800261 /**
262 * Returns the region of the current layer.
263 */
Romain Guyf219da52011-01-16 12:54:25 -0800264 virtual Region* getRegion() {
265 return mSnapshot->region;
266 }
267
Romain Guy42f3a4b2011-01-19 13:42:26 -0800268 /**
269 * Indicates whether rendering is currently targeted at a layer.
270 */
Romain Guyf219da52011-01-16 12:54:25 -0800271 virtual bool hasLayer() {
272 return (mSnapshot->flags & Snapshot::kFlagFboTarget) && mSnapshot->region;
273 }
Romain Guy1bd1bad2011-01-14 20:07:20 -0800274
Romain Guy42f3a4b2011-01-19 13:42:26 -0800275 /**
276 * Returns the name of the FBO this renderer is rendering into.
277 */
278 virtual GLint getTargetFbo() {
279 return 0;
280 }
281
Romain Guy77a81162011-06-14 16:45:55 -0700282 /**
283 * Renders the specified layer as a textured quad.
284 *
285 * @param layer The layer to render
286 * @param rect The bounds of the layer
287 */
288 void drawTextureLayer(Layer* layer, const Rect& rect);
289
Romain Guybe6f9dc2012-07-16 12:41:17 -0700290 /**
291 * Gets the alpha and xfermode out of a paint object. If the paint is null
292 * alpha will be 255 and the xfermode will be SRC_OVER.
293 *
294 * @param paint The paint to extract values from
295 * @param alpha Where to store the resulting alpha
296 * @param mode Where to store the resulting xfermode
297 */
298 inline void getAlphaAndMode(SkPaint* paint, int* alpha, SkXfermode::Mode* mode);
299
300 /**
301 * Gets the alpha and xfermode out of a paint object. If the paint is null
302 * alpha will be 255 and the xfermode will be SRC_OVER. This method does
303 * not multiply the paint's alpha by the current snapshot's alpha.
304 *
305 * @param paint The paint to extract values from
306 * @param alpha Where to store the resulting alpha
307 * @param mode Where to store the resulting xfermode
308 */
309 static inline void getAlphaAndModeDirect(SkPaint* paint, int* alpha, SkXfermode::Mode* mode) {
310 if (paint) {
311 *mode = getXfermode(paint->getXfermode());
312
313 // Skia draws using the color's alpha channel if < 255
314 // Otherwise, it uses the paint's alpha
315 int color = paint->getColor();
316 *alpha = (color >> 24) & 0xFF;
317 if (*alpha == 255) {
318 *alpha = paint->getAlpha();
319 }
320 } else {
321 *mode = SkXfermode::kSrcOver_Mode;
322 *alpha = 255;
323 }
324 }
325
326 /**
327 * Safely retrieves the mode from the specified xfermode. If the specified
328 * xfermode is null, the mode is assumed to be SkXfermode::kSrcOver_Mode.
329 */
330 static inline SkXfermode::Mode getXfermode(SkXfermode* mode) {
331 SkXfermode::Mode resultMode;
332 if (!SkXfermode::AsMode(mode, &resultMode)) {
333 resultMode = SkXfermode::kSrcOver_Mode;
334 }
335 return resultMode;
336 }
337
Romain Guy85bf02f2010-06-22 13:11:24 -0700338private:
Romain Guy5cbbce52010-06-27 22:59:20 -0700339 /**
Romain Guyddf74372012-05-22 14:07:07 -0700340 * Ensures the state of the renderer is the same as the state of
341 * the GL context.
342 */
343 void syncState();
344
345 /**
Romain Guy5cbbce52010-06-27 22:59:20 -0700346 * Saves the current state of the renderer as a new snapshot.
347 * The new snapshot is saved in mSnapshot and the previous snapshot
348 * is linked from mSnapshot->previous.
349 *
Romain Guy8aef54f2010-09-01 15:13:49 -0700350 * @param flags The save flags; see SkCanvas for more information
351 *
Romain Guy5cbbce52010-06-27 22:59:20 -0700352 * @return The new save count. This value can be passed to #restoreToCount()
353 */
Romain Guy8aef54f2010-09-01 15:13:49 -0700354 int saveSnapshot(int flags);
Romain Guy5cbbce52010-06-27 22:59:20 -0700355
356 /**
357 * Restores the current snapshot; mSnapshot becomes mSnapshot->previous.
358 *
Romain Guy2542d192010-08-18 11:47:12 -0700359 * @return True if the clip was modified.
Romain Guy5cbbce52010-06-27 22:59:20 -0700360 */
Romain Guybb9524b2010-06-22 18:56:38 -0700361 bool restoreSnapshot();
362
Romain Guy5cbbce52010-06-27 22:59:20 -0700363 /**
364 * Sets the clipping rectangle using glScissor. The clip is defined by
365 * the current snapshot's clipRect member.
366 */
Romain Guybb9524b2010-06-22 18:56:38 -0700367 void setScissorFromClip();
368
Romain Guy5cbbce52010-06-27 22:59:20 -0700369 /**
Romain Guyd55a8612010-06-28 17:42:46 -0700370 * Creates a new layer stored in the specified snapshot.
371 *
372 * @param snapshot The snapshot associated with the new layer
373 * @param left The left coordinate of the layer
374 * @param top The top coordinate of the layer
375 * @param right The right coordinate of the layer
376 * @param bottom The bottom coordinate of the layer
377 * @param alpha The translucency of the layer
378 * @param mode The blending mode of the layer
379 * @param flags The layer save flags
Romain Guyeb993562010-10-05 18:14:38 -0700380 * @param previousFbo The name of the current framebuffer
Romain Guyd55a8612010-06-28 17:42:46 -0700381 *
382 * @return True if the layer was successfully created, false otherwise
383 */
384 bool createLayer(sp<Snapshot> snapshot, float left, float top, float right, float bottom,
Romain Guyeb993562010-10-05 18:14:38 -0700385 int alpha, SkXfermode::Mode mode, int flags, GLuint previousFbo);
Romain Guyd55a8612010-06-28 17:42:46 -0700386
387 /**
Romain Guy5b3b3522010-10-27 18:57:51 -0700388 * Creates a new layer stored in the specified snapshot as an FBO.
389 *
390 * @param layer The layer to store as an FBO
391 * @param snapshot The snapshot associated with the new layer
392 * @param bounds The bounds of the layer
393 * @param previousFbo The name of the current framebuffer
394 */
395 bool createFboLayer(Layer* layer, Rect& bounds, sp<Snapshot> snapshot,
396 GLuint previousFbo);
397
398 /**
399 * Compose the specified layer as a region.
400 *
401 * @param layer The layer to compose
402 * @param rect The layer's bounds
403 */
404 void composeLayerRegion(Layer* layer, const Rect& rect);
405
406 /**
407 * Compose the specified layer as a simple rectangle.
408 *
409 * @param layer The layer to compose
410 * @param rect The layer's bounds
411 * @param swap If true, the source and destination are swapped
412 */
413 void composeLayerRect(Layer* layer, const Rect& rect, bool swap = false);
414
Romain Guy54be1cd2011-06-13 19:04:27 -0700415 /**
416 * Clears all the regions corresponding to the current list of layers.
417 * This method MUST be invoked before any drawing operation.
418 */
419 void clearLayerRegions();
420
421 /**
Romain Guyf219da52011-01-16 12:54:25 -0800422 * Mark the layer as dirty at the specified coordinates. The coordinates
423 * are transformed with the supplied matrix.
424 */
425 void dirtyLayer(const float left, const float top,
426 const float right, const float bottom, const mat4 transform);
427
428 /**
429 * Mark the layer as dirty at the specified coordinates.
430 */
431 void dirtyLayer(const float left, const float top,
432 const float right, const float bottom);
433
434 /**
Romain Guy5cbbce52010-06-27 22:59:20 -0700435 * Draws a colored rectangle with the specified color. The specified coordinates
436 * are transformed by the current snapshot's transform matrix.
437 *
438 * @param left The left coordinate of the rectangle
439 * @param top The top coordinate of the rectangle
440 * @param right The right coordinate of the rectangle
441 * @param bottom The bottom coordinate of the rectangle
442 * @param color The rectangle's ARGB color, defined as a packed 32 bits word
Romain Guy026c5e162010-06-28 17:12:22 -0700443 * @param mode The Skia xfermode to use
Romain Guy3d58c032010-07-14 16:34:53 -0700444 * @param ignoreTransform True if the current transform should be ignored
Romain Guy5b3b3522010-10-27 18:57:51 -0700445 * @param ignoreBlending True if the blending is set by the caller
Romain Guy5cbbce52010-06-27 22:59:20 -0700446 */
Romain Guy026c5e162010-06-28 17:12:22 -0700447 void drawColorRect(float left, float top, float right, float bottom,
Romain Guy1c740bc2010-09-13 18:00:09 -0700448 int color, SkXfermode::Mode mode, bool ignoreTransform = false);
Romain Guy5cbbce52010-06-27 22:59:20 -0700449
Romain Guy54be1cd2011-06-13 19:04:27 -0700450 /**
451 * Draws the shape represented by the specified path texture.
452 * This method invokes drawPathTexture() but takes into account
453 * the extra left/top offset and the texture offset to correctly
454 * position the final shape.
455 *
456 * @param left The left coordinate of the shape to render
457 * @param top The top coordinate of the shape to render
458 * @param texture The texture reprsenting the shape
459 * @param paint The paint to draw the shape with
460 */
Chet Haase48659092012-05-31 15:21:51 -0700461 status_t drawShape(float left, float top, const PathTexture* texture, SkPaint* paint);
Romain Guy54be1cd2011-06-13 19:04:27 -0700462
463 /**
464 * Renders the rect defined by the specified bounds as a shape.
465 * This will render the rect using a path texture, which is used to render
466 * rects with stroke effects.
467 *
468 * @param left The left coordinate of the rect to draw
469 * @param top The top coordinate of the rect to draw
470 * @param right The right coordinate of the rect to draw
471 * @param bottom The bottom coordinate of the rect to draw
472 * @param p The paint to draw the rect with
473 */
Chet Haase48659092012-05-31 15:21:51 -0700474 status_t drawRectAsShape(float left, float top, float right, float bottom, SkPaint* p);
Romain Guyc1cd9ba32011-01-23 14:18:41 -0800475
Romain Guy54be1cd2011-06-13 19:04:27 -0700476 /**
477 * Draws the specified texture as an alpha bitmap. Alpha bitmaps obey
478 * different compositing rules.
479 *
480 * @param texture The texture to draw with
481 * @param left The x coordinate of the bitmap
482 * @param top The y coordinate of the bitmap
483 * @param paint The paint to render with
484 */
Romain Guya168d732011-03-18 16:50:13 -0700485 void drawAlphaBitmap(Texture* texture, float left, float top, SkPaint* paint);
486
Romain Guy54be1cd2011-06-13 19:04:27 -0700487 /**
488 * Renders the rect defined by the specified bounds as an anti-aliased rect.
489 *
490 * @param left The left coordinate of the rect to draw
491 * @param top The top coordinate of the rect to draw
492 * @param right The right coordinate of the rect to draw
493 * @param bottom The bottom coordinate of the rect to draw
494 * @param color The color of the rect
495 * @param mode The blending mode to draw the rect
496 */
Chet Haase858aa932011-05-12 09:06:00 -0700497 void drawAARect(float left, float top, float right, float bottom,
498 int color, SkXfermode::Mode mode);
499
Romain Guy5cbbce52010-06-27 22:59:20 -0700500 /**
501 * Draws a textured rectangle with the specified texture. The specified coordinates
502 * are transformed by the current snapshot's transform matrix.
503 *
504 * @param left The left coordinate of the rectangle
505 * @param top The top coordinate of the rectangle
506 * @param right The right coordinate of the rectangle
507 * @param bottom The bottom coordinate of the rectangle
508 * @param texture The texture name to map onto the rectangle
509 * @param alpha An additional translucency parameter, between 0.0f and 1.0f
Romain Guyd55a8612010-06-28 17:42:46 -0700510 * @param mode The blending mode
Romain Guyc1396e92010-06-30 17:56:19 -0700511 * @param blend True if the texture contains an alpha channel
Romain Guy5cbbce52010-06-27 22:59:20 -0700512 */
Romain Guybd6b79b2010-06-26 00:13:53 -0700513 void drawTextureRect(float left, float top, float right, float bottom, GLuint texture,
Romain Guya9794742010-07-13 11:37:54 -0700514 float alpha, SkXfermode::Mode mode, bool blend);
Romain Guyc7d53492010-06-25 13:41:57 -0700515
Romain Guy026c5e162010-06-28 17:12:22 -0700516 /**
Romain Guy82ba8142010-07-09 13:25:56 -0700517 * Draws a textured rectangle with the specified texture. The specified coordinates
518 * are transformed by the current snapshot's transform matrix.
519 *
520 * @param left The left coordinate of the rectangle
521 * @param top The top coordinate of the rectangle
522 * @param right The right coordinate of the rectangle
523 * @param bottom The bottom coordinate of the rectangle
524 * @param texture The texture to use
525 * @param paint The paint containing the alpha, blending mode, etc.
Romain Guy82ba8142010-07-09 13:25:56 -0700526 */
Romain Guya9794742010-07-13 11:37:54 -0700527 void drawTextureRect(float left, float top, float right, float bottom,
Romain Guy8164c2d2010-10-25 18:03:28 -0700528 Texture* texture, SkPaint* paint);
Romain Guy82ba8142010-07-09 13:25:56 -0700529
530 /**
Romain Guy03750a02010-10-18 14:06:08 -0700531 * Draws a textured mesh with the specified texture. If the indices are omitted,
532 * the mesh is drawn as a simple quad. The mesh pointers become offsets when a
533 * VBO is bound.
Romain Guy82ba8142010-07-09 13:25:56 -0700534 *
535 * @param left The left coordinate of the rectangle
536 * @param top The top coordinate of the rectangle
537 * @param right The right coordinate of the rectangle
538 * @param bottom The bottom coordinate of the rectangle
539 * @param texture The texture name to map onto the rectangle
540 * @param alpha An additional translucency parameter, between 0.0f and 1.0f
541 * @param mode The blending mode
542 * @param blend True if the texture contains an alpha channel
Romain Guy82ba8142010-07-09 13:25:56 -0700543 * @param vertices The vertices that define the mesh
544 * @param texCoords The texture coordinates of each vertex
Romain Guy82ba8142010-07-09 13:25:56 -0700545 * @param elementsCount The number of elements in the mesh, required by indices
Romain Guyf607bdc2010-09-10 19:20:06 -0700546 * @param swapSrcDst Whether or not the src and dst blending operations should be swapped
547 * @param ignoreTransform True if the current transform should be ignored
Romain Guy03750a02010-10-18 14:06:08 -0700548 * @param vbo The VBO used to draw the mesh
Romain Guy5b3b3522010-10-27 18:57:51 -0700549 * @param ignoreScale True if the model view matrix should not be scaled
550 * @param dirty True if calling this method should dirty the current layer
Romain Guyf7f93552010-07-08 19:17:03 -0700551 */
552 void drawTextureMesh(float left, float top, float right, float bottom, GLuint texture,
Romain Guya9794742010-07-13 11:37:54 -0700553 float alpha, SkXfermode::Mode mode, bool blend,
Romain Guy6820ac82010-09-15 18:11:50 -0700554 GLvoid* vertices, GLvoid* texCoords, GLenum drawMode, GLsizei elementsCount,
Romain Guy5b3b3522010-10-27 18:57:51 -0700555 bool swapSrcDst = false, bool ignoreTransform = false, GLuint vbo = 0,
556 bool ignoreScale = false, bool dirty = true);
Romain Guyf7f93552010-07-08 19:17:03 -0700557
558 /**
Romain Guy0a417492010-08-16 20:26:20 -0700559 * Draws text underline and strike-through if needed.
560 *
561 * @param text The text to decor
562 * @param bytesCount The number of bytes in the text
563 * @param length The length in pixels of the text, can be <= 0.0f to force a measurement
564 * @param x The x coordinate where the text will be drawn
565 * @param y The y coordinate where the text will be drawn
566 * @param paint The paint to draw the text with
567 */
568 void drawTextDecorations(const char* text, int bytesCount, float length,
569 float x, float y, SkPaint* paint);
Romain Guy1e45aae2010-08-13 19:39:53 -0700570
Raph Levien416a8472012-07-19 22:48:17 -0700571 /**
572 * Draws shadow layer on text (with optional positions).
573 *
574 * @param paint The paint to draw the shadow with
575 * @param text The text to draw
576 * @param bytesCount The number of bytes in the text
577 * @param count The number of glyphs in the text
578 * @param positions The x, y positions of individual glyphs (or NULL)
579 * @param fontRenderer The font renderer object
580 * @param alpha The alpha value for drawing the shadow
581 * @param mode The xfermode for drawing the shadow
582 * @param x The x coordinate where the shadow will be drawn
583 * @param y The y coordinate where the shadow will be drawn
584 */
585 void drawTextShadow(SkPaint* paint, const char* text, int bytesCount, int count,
586 const float* positions, FontRenderer& fontRenderer, int alpha, SkXfermode::Mode mode,
587 float x, float y);
588
Romain Guy54be1cd2011-06-13 19:04:27 -0700589 /**
590 * Draws a path texture. Path textures are alpha8 bitmaps that need special
591 * compositing to apply colors/filters/etc.
592 *
593 * @param texture The texture to render
594 * @param x The x coordinate where the texture will be drawn
595 * @param y The y coordinate where the texture will be drawn
596 * @param paint The paint to draw the texture with
597 */
Raph Levien416a8472012-07-19 22:48:17 -0700598 void drawPathTexture(const PathTexture* texture, float x, float y, SkPaint* paint);
Romain Guy01d58e42011-01-19 21:54:02 -0800599
Romain Guy1e45aae2010-08-13 19:39:53 -0700600 /**
Romain Guyac670c02010-07-27 17:39:27 -0700601 * Resets the texture coordinates stored in mMeshVertices. Setting the values
Romain Guy026c5e162010-06-28 17:12:22 -0700602 * back to default is achieved by calling:
603 *
Romain Guy8ba548f2010-06-30 19:21:21 -0700604 * resetDrawTextureTexCoords(0.0f, 0.0f, 1.0f, 1.0f);
Romain Guy026c5e162010-06-28 17:12:22 -0700605 *
606 * @param u1 The left coordinate of the texture
607 * @param v1 The bottom coordinate of the texture
608 * @param u2 The right coordinate of the texture
609 * @param v2 The top coordinate of the texture
610 */
611 void resetDrawTextureTexCoords(float u1, float v1, float u2, float v2);
612
Romain Guy8ba548f2010-06-30 19:21:21 -0700613 /**
Romain Guy746b7402010-10-26 16:27:31 -0700614 * Binds the specified texture. The texture unit must have been selected
615 * prior to calling this method.
Romain Guya1db5742010-07-20 13:09:13 -0700616 */
Romain Guy746b7402010-10-26 16:27:31 -0700617 inline void bindTexture(GLuint texture) {
618 glBindTexture(GL_TEXTURE_2D, texture);
619 }
620
621 /**
Romain Guyaa6c24c2011-04-28 18:40:04 -0700622 * Binds the specified EGLImage texture. The texture unit must have been selected
623 * prior to calling this method.
624 */
625 inline void bindExternalTexture(GLuint texture) {
626 glBindTexture(GL_TEXTURE_EXTERNAL_OES, texture);
627 }
628
629 /**
Romain Guy82ba8142010-07-09 13:25:56 -0700630 * Enable or disable blending as necessary. This function sets the appropriate
631 * blend function based on the specified xfermode.
632 */
Romain Guyf607bdc2010-09-10 19:20:06 -0700633 inline void chooseBlending(bool blend, SkXfermode::Mode mode, ProgramDescription& description,
634 bool swapSrcDst = false);
Romain Guya5aed0d2010-09-09 14:42:43 -0700635
Romain Guyf607bdc2010-09-10 19:20:06 -0700636 /**
Romain Guyd27977d2010-07-14 19:18:51 -0700637 * Use the specified program with the current GL context. If the program is already
638 * in use, it will not be bound again. If it is not in use, the current program is
639 * marked unused and the specified program becomes used and becomes the new
640 * current program.
Romain Guy6926c722010-07-12 20:20:03 -0700641 *
Romain Guyd27977d2010-07-14 19:18:51 -0700642 * @param program The program to use
643 *
644 * @return true If the specified program was already in use, false otherwise.
Romain Guy260e1022010-07-12 14:41:06 -0700645 */
Romain Guy889f8d12010-07-29 14:37:42 -0700646 inline bool useProgram(Program* program);
Romain Guy260e1022010-07-12 14:41:06 -0700647
Romain Guy746b7402010-10-26 16:27:31 -0700648 /**
649 * Invoked before any drawing operation. This sets required state.
650 */
Romain Guy54be1cd2011-06-13 19:04:27 -0700651 void setupDraw(bool clear = true);
Romain Guy17112ad2012-08-07 11:24:39 -0700652
Romain Guy70ca14e2010-12-13 18:24:33 -0800653 /**
654 * Various methods to setup OpenGL rendering.
655 */
656 void setupDrawWithTexture(bool isAlpha8 = false);
Romain Guyaa6c24c2011-04-28 18:40:04 -0700657 void setupDrawWithExternalTexture();
Romain Guy15bc6432011-12-13 13:11:32 -0800658 void setupDrawNoTexture();
Chet Haase5b0200b2011-04-13 17:58:08 -0700659 void setupDrawAALine();
Romain Guyed6fcb02011-03-21 13:11:28 -0700660 void setupDrawPoint(float pointSize);
Romain Guy70ca14e2010-12-13 18:24:33 -0800661 void setupDrawColor(int color);
Romain Guy8d0d4782010-12-14 20:13:35 -0800662 void setupDrawColor(int color, int alpha);
Romain Guy70ca14e2010-12-13 18:24:33 -0800663 void setupDrawColor(float r, float g, float b, float a);
Romain Guy86568192010-12-14 15:55:39 -0800664 void setupDrawAlpha8Color(int color, int alpha);
Romain Guy41210632012-07-16 17:04:24 -0700665 void setupDrawTextGamma(const SkPaint* paint);
Romain Guy70ca14e2010-12-13 18:24:33 -0800666 void setupDrawShader();
667 void setupDrawColorFilter();
668 void setupDrawBlending(SkXfermode::Mode mode = SkXfermode::kSrcOver_Mode,
669 bool swapSrcDst = false);
670 void setupDrawBlending(bool blend = true, SkXfermode::Mode mode = SkXfermode::kSrcOver_Mode,
671 bool swapSrcDst = false);
672 void setupDrawProgram();
673 void setupDrawDirtyRegionsDisabled();
Chet Haase8a5cc922011-04-26 07:28:09 -0700674 void setupDrawModelViewIdentity(bool offset = false);
Romain Guy70ca14e2010-12-13 18:24:33 -0800675 void setupDrawModelView(float left, float top, float right, float bottom,
676 bool ignoreTransform = false, bool ignoreModelView = false);
677 void setupDrawModelViewTranslate(float left, float top, float right, float bottom,
678 bool ignoreTransform = false);
Romain Guyed6fcb02011-03-21 13:11:28 -0700679 void setupDrawPointUniforms();
Romain Guy70ca14e2010-12-13 18:24:33 -0800680 void setupDrawColorUniforms();
Romain Guy86568192010-12-14 15:55:39 -0800681 void setupDrawPureColorUniforms();
Romain Guy8d0d4782010-12-14 20:13:35 -0800682 void setupDrawShaderIdentityUniforms();
Romain Guy70ca14e2010-12-13 18:24:33 -0800683 void setupDrawShaderUniforms(bool ignoreTransform = false);
684 void setupDrawColorFilterUniforms();
685 void setupDrawSimpleMesh();
686 void setupDrawTexture(GLuint texture);
Romain Guyaa6c24c2011-04-28 18:40:04 -0700687 void setupDrawExternalTexture(GLuint texture);
Romain Guy8f0095c2011-05-02 17:24:22 -0700688 void setupDrawTextureTransform();
689 void setupDrawTextureTransformUniforms(mat4& transform);
Romain Guy41210632012-07-16 17:04:24 -0700690 void setupDrawTextGammaUniforms();
Romain Guy8d0d4782010-12-14 20:13:35 -0800691 void setupDrawMesh(GLvoid* vertices, GLvoid* texCoords = NULL, GLuint vbo = 0);
Romain Guy15bc6432011-12-13 13:11:32 -0800692 void setupDrawMeshIndices(GLvoid* vertices, GLvoid* texCoords);
Chet Haase5b0200b2011-04-13 17:58:08 -0700693 void setupDrawVertices(GLvoid* vertices);
Chet Haase99585ad2011-05-02 15:00:16 -0700694 void setupDrawAALine(GLvoid* vertices, GLvoid* distanceCoords, GLvoid* lengthCoords,
Romain Guy7b631422012-04-04 11:38:54 -0700695 float strokeWidth, int& widthSlot, int& lengthSlot);
696 void finishDrawAALine(const int widthSlot, const int lengthSlot);
Romain Guy70ca14e2010-12-13 18:24:33 -0800697 void finishDrawTexture();
Romain Guyf09ef512011-05-27 11:43:46 -0700698 void accountForClear(SkXfermode::Mode mode);
Romain Guy746b7402010-10-26 16:27:31 -0700699
Romain Guy17112ad2012-08-07 11:24:39 -0700700 /**
701 * Renders the specified region as a series of rectangles. This method
702 * is used for debugging only.
703 */
Romain Guy3a3133d2011-02-01 22:59:58 -0800704 void drawRegionRects(const Region& region);
705
Romain Guy746b7402010-10-26 16:27:31 -0700706 /**
707 * Should be invoked every time the glScissor is modified.
708 */
709 inline void dirtyClip() {
710 mDirtyClip = true;
711 }
712
Romain Guybb9524b2010-06-22 18:56:38 -0700713 // Dimensions of the drawing surface
714 int mWidth, mHeight;
715
Romain Guy85bf02f2010-06-22 13:11:24 -0700716 // Matrix used for ortho projection in shaders
Romain Guy260e1022010-07-12 14:41:06 -0700717 mat4 mOrthoMatrix;
Romain Guybb9524b2010-06-22 18:56:38 -0700718
Romain Guyc7d53492010-06-25 13:41:57 -0700719 // Model-view matrix used to position/size objects
720 mat4 mModelView;
721
Romain Guybb9524b2010-06-22 18:56:38 -0700722 // Number of saved states
723 int mSaveCount;
Romain Guyf6a11b82010-06-23 17:47:49 -0700724 // Base state
Romain Guyae5575b2010-07-29 18:48:04 -0700725 sp<Snapshot> mFirstSnapshot;
Romain Guybb9524b2010-06-22 18:56:38 -0700726 // Current state
727 sp<Snapshot> mSnapshot;
Romain Guy9d5316e2010-06-24 19:30:36 -0700728
729 // Shaders
Romain Guy06f96e22010-07-30 19:18:16 -0700730 SkiaShader* mShader;
Romain Guy026c5e162010-06-28 17:12:22 -0700731
Romain Guydb1938e2010-08-02 18:50:22 -0700732 // Color filters
733 SkiaColorFilter* mColorFilter;
734
Romain Guy026c5e162010-06-28 17:12:22 -0700735 // Used to draw textured quads
Romain Guyac670c02010-07-27 17:39:27 -0700736 TextureVertex mMeshVertices[4];
Romain Guyce0537b2010-06-29 21:05:21 -0700737
Romain Guy1e45aae2010-08-13 19:39:53 -0700738 // Drop shadow
739 bool mHasShadow;
740 float mShadowRadius;
741 float mShadowDx;
742 float mShadowDy;
743 int mShadowColor;
744
Romain Guy5ff9df62012-01-23 17:09:05 -0800745 // Draw filters
746 bool mHasDrawFilter;
747 int mPaintFilterClearBits;
748 int mPaintFilterSetBits;
749 SkPaint mFilteredPaint;
750
Romain Guy82ba8142010-07-09 13:25:56 -0700751 // Various caches
Romain Guyfb8b7632010-08-23 21:05:08 -0700752 Caches& mCaches;
Romain Guy86942302010-09-12 13:02:16 -0700753
Romain Guy8f3b8e32012-03-27 16:33:45 -0700754 // List of rectangles to clear after saveLayer() is invoked
Romain Guy54be1cd2011-06-13 19:04:27 -0700755 Vector<Rect*> mLayers;
Romain Guy8f3b8e32012-03-27 16:33:45 -0700756 // List of functors to invoke after a frame is drawn
Romain Guyba6be8a2012-04-23 18:22:09 -0700757 SortedVector<Functor*> mFunctors;
Romain Guy54be1cd2011-06-13 19:04:27 -0700758
Romain Guy99bcdc52010-10-13 15:17:00 -0700759 // Indentity matrix
760 const mat4 mIdentity;
761
Romain Guy746b7402010-10-26 16:27:31 -0700762 // Indicates whether the clip must be restored
763 bool mDirtyClip;
764
Romain Guy70ca14e2010-12-13 18:24:33 -0800765 // The following fields are used to setup drawing
766 // Used to describe the shaders to generate
767 ProgramDescription mDescription;
768 // Color description
769 bool mColorSet;
770 float mColorA, mColorR, mColorG, mColorB;
771 // Indicates that the shader should get a color
772 bool mSetShaderColor;
773 // Current texture unit
774 GLuint mTextureUnit;
775 // Track dirty regions, true by default
776 bool mTrackDirtyRegions;
Romain Guy70ca14e2010-12-13 18:24:33 -0800777
Romain Guyb051e892010-09-28 19:09:36 -0700778 friend class DisplayListRenderer;
779
Romain Guybb9524b2010-06-22 18:56:38 -0700780}; // class OpenGLRenderer
Romain Guye4d01122010-06-16 18:44:05 -0700781
Romain Guy9d5316e2010-06-24 19:30:36 -0700782}; // namespace uirenderer
Romain Guye4d01122010-06-16 18:44:05 -0700783}; // namespace android
784
Romain Guy5b3b3522010-10-27 18:57:51 -0700785#endif // ANDROID_HWUI_OPENGL_RENDERER_H