OpenGLRenderer.h revision 13631f3da855f200a151e7837ed9f6b079622b58
1/* 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 17#ifndef ANDROID_HWUI_OPENGL_RENDERER_H 18#define ANDROID_HWUI_OPENGL_RENDERER_H 19 20#include <GLES2/gl2.h> 21#include <GLES2/gl2ext.h> 22 23#include <SkBitmap.h> 24#include <SkMatrix.h> 25#include <SkPaint.h> 26#include <SkRegion.h> 27#include <SkShader.h> 28#include <SkXfermode.h> 29 30#include <utils/Functor.h> 31#include <utils/RefBase.h> 32#include <utils/Vector.h> 33 34#include <cutils/compiler.h> 35 36#include "Debug.h" 37#include "Extensions.h" 38#include "Matrix.h" 39#include "Program.h" 40#include "Rect.h" 41#include "Snapshot.h" 42#include "Vertex.h" 43#include "SkiaShader.h" 44#include "SkiaColorFilter.h" 45#include "Caches.h" 46 47namespace android { 48namespace uirenderer { 49 50/////////////////////////////////////////////////////////////////////////////// 51// Renderer 52/////////////////////////////////////////////////////////////////////////////// 53 54class DisplayList; 55 56/** 57 * OpenGL renderer used to draw accelerated 2D graphics. The API is a 58 * simplified version of Skia's Canvas API. 59 */ 60class OpenGLRenderer { 61public: 62 ANDROID_API OpenGLRenderer(); 63 virtual ~OpenGLRenderer(); 64 65 virtual void setViewport(int width, int height); 66 67 ANDROID_API void prepare(bool opaque); 68 virtual void prepareDirty(float left, float top, float right, float bottom, bool opaque); 69 virtual void finish(); 70 71 // These two calls must not be recorded in display lists 72 virtual void interrupt(); 73 virtual void resume(); 74 75 virtual bool callDrawGLFunction(Functor *functor, Rect& dirty); 76 77 ANDROID_API int getSaveCount() const; 78 virtual int save(int flags); 79 virtual void restore(); 80 virtual void restoreToCount(int saveCount); 81 82 virtual int saveLayer(float left, float top, float right, float bottom, 83 SkPaint* p, int flags); 84 virtual int saveLayerAlpha(float left, float top, float right, float bottom, 85 int alpha, int flags); 86 87 virtual void translate(float dx, float dy); 88 virtual void rotate(float degrees); 89 virtual void scale(float sx, float sy); 90 virtual void skew(float sx, float sy); 91 92 ANDROID_API void getMatrix(SkMatrix* matrix); 93 virtual void setMatrix(SkMatrix* matrix); 94 virtual void concatMatrix(SkMatrix* matrix); 95 96 ANDROID_API const Rect& getClipBounds(); 97 ANDROID_API bool quickReject(float left, float top, float right, float bottom); 98 virtual bool clipRect(float left, float top, float right, float bottom, SkRegion::Op op); 99 100 virtual bool drawDisplayList(DisplayList* displayList, uint32_t width, uint32_t height, 101 Rect& dirty, uint32_t level = 0); 102 virtual void outputDisplayList(DisplayList* displayList, uint32_t level = 0); 103 virtual void drawLayer(Layer* layer, float x, float y, SkPaint* paint); 104 virtual void drawBitmap(SkBitmap* bitmap, float left, float top, SkPaint* paint); 105 virtual void drawBitmap(SkBitmap* bitmap, SkMatrix* matrix, SkPaint* paint); 106 virtual void drawBitmap(SkBitmap* bitmap, float srcLeft, float srcTop, 107 float srcRight, float srcBottom, float dstLeft, float dstTop, 108 float dstRight, float dstBottom, SkPaint* paint); 109 virtual void drawBitmapMesh(SkBitmap* bitmap, int meshWidth, int meshHeight, 110 float* vertices, int* colors, SkPaint* paint); 111 virtual void drawPatch(SkBitmap* bitmap, const int32_t* xDivs, const int32_t* yDivs, 112 const uint32_t* colors, uint32_t width, uint32_t height, int8_t numColors, 113 float left, float top, float right, float bottom, SkPaint* paint); 114 virtual void drawColor(int color, SkXfermode::Mode mode); 115 virtual void drawRect(float left, float top, float right, float bottom, SkPaint* paint); 116 virtual void drawRoundRect(float left, float top, float right, float bottom, 117 float rx, float ry, SkPaint* paint); 118 virtual void drawCircle(float x, float y, float radius, SkPaint* paint); 119 virtual void drawOval(float left, float top, float right, float bottom, SkPaint* paint); 120 virtual void drawArc(float left, float top, float right, float bottom, 121 float startAngle, float sweepAngle, bool useCenter, SkPaint* paint); 122 virtual void drawPath(SkPath* path, SkPaint* paint); 123 virtual void drawLines(float* points, int count, SkPaint* paint); 124 virtual void drawPoints(float* points, int count, SkPaint* paint); 125 virtual void drawText(const char* text, int bytesCount, int count, float x, float y, 126 SkPaint* paint, float length = -1.0f); 127 virtual void drawPosText(const char* text, int bytesCount, int count, const float* positions, 128 SkPaint* paint); 129 130 virtual void resetShader(); 131 virtual void setupShader(SkiaShader* shader); 132 133 virtual void resetColorFilter(); 134 virtual void setupColorFilter(SkiaColorFilter* filter); 135 136 virtual void resetShadow(); 137 virtual void setupShadow(float radius, float dx, float dy, int color); 138 139 virtual void resetPaintFilter(); 140 virtual void setupPaintFilter(int clearBits, int setBits); 141 142 SkPaint* filterPaint(SkPaint* paint); 143 144 ANDROID_API static uint32_t getStencilSize(); 145 146 void startMark(const char* name) const; 147 void endMark() const; 148 149protected: 150 /** 151 * Compose the layer defined in the current snapshot with the layer 152 * defined by the previous snapshot. 153 * 154 * The current snapshot *must* be a layer (flag kFlagIsLayer set.) 155 * 156 * @param curent The current snapshot containing the layer to compose 157 * @param previous The previous snapshot to compose the current layer with 158 */ 159 virtual void composeLayer(sp<Snapshot> current, sp<Snapshot> previous); 160 161 /** 162 * Marks the specified region as dirty at the specified bounds. 163 */ 164 void dirtyLayerUnchecked(Rect& bounds, Region* region); 165 166 /** 167 * Returns the current snapshot. 168 */ 169 sp<Snapshot> getSnapshot() { 170 return mSnapshot; 171 } 172 173 /** 174 * Returns the region of the current layer. 175 */ 176 virtual Region* getRegion() { 177 return mSnapshot->region; 178 } 179 180 /** 181 * Indicates whether rendering is currently targeted at a layer. 182 */ 183 virtual bool hasLayer() { 184 return (mSnapshot->flags & Snapshot::kFlagFboTarget) && mSnapshot->region; 185 } 186 187 /** 188 * Returns the name of the FBO this renderer is rendering into. 189 */ 190 virtual GLint getTargetFbo() { 191 return 0; 192 } 193 194 /** 195 * Renders the specified layer as a textured quad. 196 * 197 * @param layer The layer to render 198 * @param rect The bounds of the layer 199 */ 200 void drawTextureLayer(Layer* layer, const Rect& rect); 201 202private: 203 /** 204 * Saves the current state of the renderer as a new snapshot. 205 * The new snapshot is saved in mSnapshot and the previous snapshot 206 * is linked from mSnapshot->previous. 207 * 208 * @param flags The save flags; see SkCanvas for more information 209 * 210 * @return The new save count. This value can be passed to #restoreToCount() 211 */ 212 int saveSnapshot(int flags); 213 214 /** 215 * Restores the current snapshot; mSnapshot becomes mSnapshot->previous. 216 * 217 * @return True if the clip was modified. 218 */ 219 bool restoreSnapshot(); 220 221 /** 222 * Sets the clipping rectangle using glScissor. The clip is defined by 223 * the current snapshot's clipRect member. 224 */ 225 void setScissorFromClip(); 226 227 /** 228 * Creates a new layer stored in the specified snapshot. 229 * 230 * @param snapshot The snapshot associated with the new layer 231 * @param left The left coordinate of the layer 232 * @param top The top coordinate of the layer 233 * @param right The right coordinate of the layer 234 * @param bottom The bottom coordinate of the layer 235 * @param alpha The translucency of the layer 236 * @param mode The blending mode of the layer 237 * @param flags The layer save flags 238 * @param previousFbo The name of the current framebuffer 239 * 240 * @return True if the layer was successfully created, false otherwise 241 */ 242 bool createLayer(sp<Snapshot> snapshot, float left, float top, float right, float bottom, 243 int alpha, SkXfermode::Mode mode, int flags, GLuint previousFbo); 244 245 /** 246 * Creates a new layer stored in the specified snapshot as an FBO. 247 * 248 * @param layer The layer to store as an FBO 249 * @param snapshot The snapshot associated with the new layer 250 * @param bounds The bounds of the layer 251 * @param previousFbo The name of the current framebuffer 252 */ 253 bool createFboLayer(Layer* layer, Rect& bounds, sp<Snapshot> snapshot, 254 GLuint previousFbo); 255 256 /** 257 * Compose the specified layer as a region. 258 * 259 * @param layer The layer to compose 260 * @param rect The layer's bounds 261 */ 262 void composeLayerRegion(Layer* layer, const Rect& rect); 263 264 /** 265 * Compose the specified layer as a simple rectangle. 266 * 267 * @param layer The layer to compose 268 * @param rect The layer's bounds 269 * @param swap If true, the source and destination are swapped 270 */ 271 void composeLayerRect(Layer* layer, const Rect& rect, bool swap = false); 272 273 /** 274 * Clears all the regions corresponding to the current list of layers. 275 * This method MUST be invoked before any drawing operation. 276 */ 277 void clearLayerRegions(); 278 279 /** 280 * Mark the layer as dirty at the specified coordinates. The coordinates 281 * are transformed with the supplied matrix. 282 */ 283 void dirtyLayer(const float left, const float top, 284 const float right, const float bottom, const mat4 transform); 285 286 /** 287 * Mark the layer as dirty at the specified coordinates. 288 */ 289 void dirtyLayer(const float left, const float top, 290 const float right, const float bottom); 291 292 /** 293 * Draws a colored rectangle with the specified color. The specified coordinates 294 * are transformed by the current snapshot's transform matrix. 295 * 296 * @param left The left coordinate of the rectangle 297 * @param top The top coordinate of the rectangle 298 * @param right The right coordinate of the rectangle 299 * @param bottom The bottom coordinate of the rectangle 300 * @param color The rectangle's ARGB color, defined as a packed 32 bits word 301 * @param mode The Skia xfermode to use 302 * @param ignoreTransform True if the current transform should be ignored 303 * @param ignoreBlending True if the blending is set by the caller 304 */ 305 void drawColorRect(float left, float top, float right, float bottom, 306 int color, SkXfermode::Mode mode, bool ignoreTransform = false); 307 308 /** 309 * Draws the shape represented by the specified path texture. 310 * This method invokes drawPathTexture() but takes into account 311 * the extra left/top offset and the texture offset to correctly 312 * position the final shape. 313 * 314 * @param left The left coordinate of the shape to render 315 * @param top The top coordinate of the shape to render 316 * @param texture The texture reprsenting the shape 317 * @param paint The paint to draw the shape with 318 */ 319 void drawShape(float left, float top, const PathTexture* texture, SkPaint* paint); 320 321 /** 322 * Renders the rect defined by the specified bounds as a shape. 323 * This will render the rect using a path texture, which is used to render 324 * rects with stroke effects. 325 * 326 * @param left The left coordinate of the rect to draw 327 * @param top The top coordinate of the rect to draw 328 * @param right The right coordinate of the rect to draw 329 * @param bottom The bottom coordinate of the rect to draw 330 * @param p The paint to draw the rect with 331 */ 332 void drawRectAsShape(float left, float top, float right, float bottom, SkPaint* p); 333 334 /** 335 * Draws the specified texture as an alpha bitmap. Alpha bitmaps obey 336 * different compositing rules. 337 * 338 * @param texture The texture to draw with 339 * @param left The x coordinate of the bitmap 340 * @param top The y coordinate of the bitmap 341 * @param paint The paint to render with 342 */ 343 void drawAlphaBitmap(Texture* texture, float left, float top, SkPaint* paint); 344 345 /** 346 * Renders the rect defined by the specified bounds as an anti-aliased rect. 347 * 348 * @param left The left coordinate of the rect to draw 349 * @param top The top coordinate of the rect to draw 350 * @param right The right coordinate of the rect to draw 351 * @param bottom The bottom coordinate of the rect to draw 352 * @param color The color of the rect 353 * @param mode The blending mode to draw the rect 354 */ 355 void drawAARect(float left, float top, float right, float bottom, 356 int color, SkXfermode::Mode mode); 357 358 /** 359 * Draws a textured rectangle with the specified texture. The specified coordinates 360 * are transformed by the current snapshot's transform matrix. 361 * 362 * @param left The left coordinate of the rectangle 363 * @param top The top coordinate of the rectangle 364 * @param right The right coordinate of the rectangle 365 * @param bottom The bottom coordinate of the rectangle 366 * @param texture The texture name to map onto the rectangle 367 * @param alpha An additional translucency parameter, between 0.0f and 1.0f 368 * @param mode The blending mode 369 * @param blend True if the texture contains an alpha channel 370 */ 371 void drawTextureRect(float left, float top, float right, float bottom, GLuint texture, 372 float alpha, SkXfermode::Mode mode, bool blend); 373 374 /** 375 * Draws a textured rectangle with the specified texture. The specified coordinates 376 * are transformed by the current snapshot's transform matrix. 377 * 378 * @param left The left coordinate of the rectangle 379 * @param top The top coordinate of the rectangle 380 * @param right The right coordinate of the rectangle 381 * @param bottom The bottom coordinate of the rectangle 382 * @param texture The texture to use 383 * @param paint The paint containing the alpha, blending mode, etc. 384 */ 385 void drawTextureRect(float left, float top, float right, float bottom, 386 Texture* texture, SkPaint* paint); 387 388 /** 389 * Draws a textured mesh with the specified texture. If the indices are omitted, 390 * the mesh is drawn as a simple quad. The mesh pointers become offsets when a 391 * VBO is bound. 392 * 393 * @param left The left coordinate of the rectangle 394 * @param top The top coordinate of the rectangle 395 * @param right The right coordinate of the rectangle 396 * @param bottom The bottom coordinate of the rectangle 397 * @param texture The texture name to map onto the rectangle 398 * @param alpha An additional translucency parameter, between 0.0f and 1.0f 399 * @param mode The blending mode 400 * @param blend True if the texture contains an alpha channel 401 * @param vertices The vertices that define the mesh 402 * @param texCoords The texture coordinates of each vertex 403 * @param elementsCount The number of elements in the mesh, required by indices 404 * @param swapSrcDst Whether or not the src and dst blending operations should be swapped 405 * @param ignoreTransform True if the current transform should be ignored 406 * @param vbo The VBO used to draw the mesh 407 * @param ignoreScale True if the model view matrix should not be scaled 408 * @param dirty True if calling this method should dirty the current layer 409 */ 410 void drawTextureMesh(float left, float top, float right, float bottom, GLuint texture, 411 float alpha, SkXfermode::Mode mode, bool blend, 412 GLvoid* vertices, GLvoid* texCoords, GLenum drawMode, GLsizei elementsCount, 413 bool swapSrcDst = false, bool ignoreTransform = false, GLuint vbo = 0, 414 bool ignoreScale = false, bool dirty = true); 415 416 /** 417 * Draws text underline and strike-through if needed. 418 * 419 * @param text The text to decor 420 * @param bytesCount The number of bytes in the text 421 * @param length The length in pixels of the text, can be <= 0.0f to force a measurement 422 * @param x The x coordinate where the text will be drawn 423 * @param y The y coordinate where the text will be drawn 424 * @param paint The paint to draw the text with 425 */ 426 void drawTextDecorations(const char* text, int bytesCount, float length, 427 float x, float y, SkPaint* paint); 428 429 /** 430 * Draws a path texture. Path textures are alpha8 bitmaps that need special 431 * compositing to apply colors/filters/etc. 432 * 433 * @param texture The texture to render 434 * @param x The x coordinate where the texture will be drawn 435 * @param y The y coordinate where the texture will be drawn 436 * @param paint The paint to draw the texture with 437 */ 438 void drawPathTexture(const PathTexture* texture, float x, float y, SkPaint* paint); 439 440 /** 441 * Resets the texture coordinates stored in mMeshVertices. Setting the values 442 * back to default is achieved by calling: 443 * 444 * resetDrawTextureTexCoords(0.0f, 0.0f, 1.0f, 1.0f); 445 * 446 * @param u1 The left coordinate of the texture 447 * @param v1 The bottom coordinate of the texture 448 * @param u2 The right coordinate of the texture 449 * @param v2 The top coordinate of the texture 450 */ 451 void resetDrawTextureTexCoords(float u1, float v1, float u2, float v2); 452 453 /** 454 * Gets the alpha and xfermode out of a paint object. If the paint is null 455 * alpha will be 255 and the xfermode will be SRC_OVER. 456 * 457 * @param paint The paint to extract values from 458 * @param alpha Where to store the resulting alpha 459 * @param mode Where to store the resulting xfermode 460 */ 461 inline void getAlphaAndMode(SkPaint* paint, int* alpha, SkXfermode::Mode* mode); 462 463 /** 464 * Binds the specified texture. The texture unit must have been selected 465 * prior to calling this method. 466 */ 467 inline void bindTexture(GLuint texture) { 468 glBindTexture(GL_TEXTURE_2D, texture); 469 } 470 471 /** 472 * Binds the specified EGLImage texture. The texture unit must have been selected 473 * prior to calling this method. 474 */ 475 inline void bindExternalTexture(GLuint texture) { 476 glBindTexture(GL_TEXTURE_EXTERNAL_OES, texture); 477 } 478 479 /** 480 * Enable or disable blending as necessary. This function sets the appropriate 481 * blend function based on the specified xfermode. 482 */ 483 inline void chooseBlending(bool blend, SkXfermode::Mode mode, ProgramDescription& description, 484 bool swapSrcDst = false); 485 486 /** 487 * Safely retrieves the mode from the specified xfermode. If the specified 488 * xfermode is null, the mode is assumed to be SkXfermode::kSrcOver_Mode. 489 */ 490 inline SkXfermode::Mode getXfermode(SkXfermode* mode); 491 492 /** 493 * Use the specified program with the current GL context. If the program is already 494 * in use, it will not be bound again. If it is not in use, the current program is 495 * marked unused and the specified program becomes used and becomes the new 496 * current program. 497 * 498 * @param program The program to use 499 * 500 * @return true If the specified program was already in use, false otherwise. 501 */ 502 inline bool useProgram(Program* program); 503 504 /** 505 * Invoked before any drawing operation. This sets required state. 506 */ 507 void setupDraw(bool clear = true); 508 /** 509 * Various methods to setup OpenGL rendering. 510 */ 511 void setupDrawWithTexture(bool isAlpha8 = false); 512 void setupDrawWithExternalTexture(); 513 void setupDrawNoTexture(); 514 void setupDrawAALine(); 515 void setupDrawPoint(float pointSize); 516 void setupDrawColor(int color); 517 void setupDrawColor(int color, int alpha); 518 void setupDrawColor(float r, float g, float b, float a); 519 void setupDrawAlpha8Color(int color, int alpha); 520 void setupDrawAlpha8Color(float r, float g, float b, float a); 521 void setupDrawShader(); 522 void setupDrawColorFilter(); 523 void setupDrawBlending(SkXfermode::Mode mode = SkXfermode::kSrcOver_Mode, 524 bool swapSrcDst = false); 525 void setupDrawBlending(bool blend = true, SkXfermode::Mode mode = SkXfermode::kSrcOver_Mode, 526 bool swapSrcDst = false); 527 void setupDrawProgram(); 528 void setupDrawDirtyRegionsDisabled(); 529 void setupDrawModelViewIdentity(bool offset = false); 530 void setupDrawModelView(float left, float top, float right, float bottom, 531 bool ignoreTransform = false, bool ignoreModelView = false); 532 void setupDrawModelViewTranslate(float left, float top, float right, float bottom, 533 bool ignoreTransform = false); 534 void setupDrawPointUniforms(); 535 void setupDrawColorUniforms(); 536 void setupDrawPureColorUniforms(); 537 void setupDrawShaderIdentityUniforms(); 538 void setupDrawShaderUniforms(bool ignoreTransform = false); 539 void setupDrawColorFilterUniforms(); 540 void setupDrawSimpleMesh(); 541 void setupDrawTexture(GLuint texture); 542 void setupDrawExternalTexture(GLuint texture); 543 void setupDrawTextureTransform(); 544 void setupDrawTextureTransformUniforms(mat4& transform); 545 void setupDrawMesh(GLvoid* vertices, GLvoid* texCoords = NULL, GLuint vbo = 0); 546 void setupDrawMeshIndices(GLvoid* vertices, GLvoid* texCoords); 547 void setupDrawVertices(GLvoid* vertices); 548 void setupDrawAALine(GLvoid* vertices, GLvoid* distanceCoords, GLvoid* lengthCoords, 549 float strokeWidth); 550 void finishDrawTexture(); 551 void accountForClear(SkXfermode::Mode mode); 552 553 void drawRegionRects(const Region& region); 554 555 /** 556 * Should be invoked every time the glScissor is modified. 557 */ 558 inline void dirtyClip() { 559 mDirtyClip = true; 560 } 561 562 // Dimensions of the drawing surface 563 int mWidth, mHeight; 564 565 // Matrix used for ortho projection in shaders 566 mat4 mOrthoMatrix; 567 568 // Model-view matrix used to position/size objects 569 mat4 mModelView; 570 571 // Number of saved states 572 int mSaveCount; 573 // Base state 574 sp<Snapshot> mFirstSnapshot; 575 // Current state 576 sp<Snapshot> mSnapshot; 577 578 // Shaders 579 SkiaShader* mShader; 580 581 // Color filters 582 SkiaColorFilter* mColorFilter; 583 584 // Used to draw textured quads 585 TextureVertex mMeshVertices[4]; 586 587 // Drop shadow 588 bool mHasShadow; 589 float mShadowRadius; 590 float mShadowDx; 591 float mShadowDy; 592 int mShadowColor; 593 594 // Draw filters 595 bool mHasDrawFilter; 596 int mPaintFilterClearBits; 597 int mPaintFilterSetBits; 598 SkPaint mFilteredPaint; 599 600 // Various caches 601 Caches& mCaches; 602 603 // List of rectagnles to clear after saveLayer() is invoked 604 Vector<Rect*> mLayers; 605 606 // Indentity matrix 607 const mat4 mIdentity; 608 609 // Indicates whether the clip must be restored 610 bool mDirtyClip; 611 612 // The following fields are used to setup drawing 613 // Used to describe the shaders to generate 614 ProgramDescription mDescription; 615 // Color description 616 bool mColorSet; 617 float mColorA, mColorR, mColorG, mColorB; 618 // Indicates that the shader should get a color 619 bool mSetShaderColor; 620 // Current texture unit 621 GLuint mTextureUnit; 622 // Track dirty regions, true by default 623 bool mTrackDirtyRegions; 624 625 friend class DisplayListRenderer; 626 627}; // class OpenGLRenderer 628 629}; // namespace uirenderer 630}; // namespace android 631 632#endif // ANDROID_HWUI_OPENGL_RENDERER_H 633