OpenGLRenderer.h revision 530041d3191ce817832a0108514617768e43cda6
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 146protected: 147 /** 148 * Compose the layer defined in the current snapshot with the layer 149 * defined by the previous snapshot. 150 * 151 * The current snapshot *must* be a layer (flag kFlagIsLayer set.) 152 * 153 * @param curent The current snapshot containing the layer to compose 154 * @param previous The previous snapshot to compose the current layer with 155 */ 156 virtual void composeLayer(sp<Snapshot> current, sp<Snapshot> previous); 157 158 /** 159 * Marks the specified region as dirty at the specified bounds. 160 */ 161 void dirtyLayerUnchecked(Rect& bounds, Region* region); 162 163 /** 164 * Returns the current snapshot. 165 */ 166 sp<Snapshot> getSnapshot() { 167 return mSnapshot; 168 } 169 170 /** 171 * Returns the region of the current layer. 172 */ 173 virtual Region* getRegion() { 174 return mSnapshot->region; 175 } 176 177 /** 178 * Indicates whether rendering is currently targeted at a layer. 179 */ 180 virtual bool hasLayer() { 181 return (mSnapshot->flags & Snapshot::kFlagFboTarget) && mSnapshot->region; 182 } 183 184 /** 185 * Returns the name of the FBO this renderer is rendering into. 186 */ 187 virtual GLint getTargetFbo() { 188 return 0; 189 } 190 191 /** 192 * Renders the specified layer as a textured quad. 193 * 194 * @param layer The layer to render 195 * @param rect The bounds of the layer 196 */ 197 void drawTextureLayer(Layer* layer, const Rect& rect); 198 199private: 200 /** 201 * Saves the current state of the renderer as a new snapshot. 202 * The new snapshot is saved in mSnapshot and the previous snapshot 203 * is linked from mSnapshot->previous. 204 * 205 * @param flags The save flags; see SkCanvas for more information 206 * 207 * @return The new save count. This value can be passed to #restoreToCount() 208 */ 209 int saveSnapshot(int flags); 210 211 /** 212 * Restores the current snapshot; mSnapshot becomes mSnapshot->previous. 213 * 214 * @return True if the clip was modified. 215 */ 216 bool restoreSnapshot(); 217 218 /** 219 * Sets the clipping rectangle using glScissor. The clip is defined by 220 * the current snapshot's clipRect member. 221 */ 222 void setScissorFromClip(); 223 224 /** 225 * Creates a new layer stored in the specified snapshot. 226 * 227 * @param snapshot The snapshot associated with the new layer 228 * @param left The left coordinate of the layer 229 * @param top The top coordinate of the layer 230 * @param right The right coordinate of the layer 231 * @param bottom The bottom coordinate of the layer 232 * @param alpha The translucency of the layer 233 * @param mode The blending mode of the layer 234 * @param flags The layer save flags 235 * @param previousFbo The name of the current framebuffer 236 * 237 * @return True if the layer was successfully created, false otherwise 238 */ 239 bool createLayer(sp<Snapshot> snapshot, float left, float top, float right, float bottom, 240 int alpha, SkXfermode::Mode mode, int flags, GLuint previousFbo); 241 242 /** 243 * Creates a new layer stored in the specified snapshot as an FBO. 244 * 245 * @param layer The layer to store as an FBO 246 * @param snapshot The snapshot associated with the new layer 247 * @param bounds The bounds of the layer 248 * @param previousFbo The name of the current framebuffer 249 */ 250 bool createFboLayer(Layer* layer, Rect& bounds, sp<Snapshot> snapshot, 251 GLuint previousFbo); 252 253 /** 254 * Compose the specified layer as a region. 255 * 256 * @param layer The layer to compose 257 * @param rect The layer's bounds 258 */ 259 void composeLayerRegion(Layer* layer, const Rect& rect); 260 261 /** 262 * Compose the specified layer as a simple rectangle. 263 * 264 * @param layer The layer to compose 265 * @param rect The layer's bounds 266 * @param swap If true, the source and destination are swapped 267 */ 268 void composeLayerRect(Layer* layer, const Rect& rect, bool swap = false); 269 270 /** 271 * Clears all the regions corresponding to the current list of layers. 272 * This method MUST be invoked before any drawing operation. 273 */ 274 void clearLayerRegions(); 275 276 /** 277 * Mark the layer as dirty at the specified coordinates. The coordinates 278 * are transformed with the supplied matrix. 279 */ 280 void dirtyLayer(const float left, const float top, 281 const float right, const float bottom, const mat4 transform); 282 283 /** 284 * Mark the layer as dirty at the specified coordinates. 285 */ 286 void dirtyLayer(const float left, const float top, 287 const float right, const float bottom); 288 289 /** 290 * Draws a colored rectangle with the specified color. The specified coordinates 291 * are transformed by the current snapshot's transform matrix. 292 * 293 * @param left The left coordinate of the rectangle 294 * @param top The top coordinate of the rectangle 295 * @param right The right coordinate of the rectangle 296 * @param bottom The bottom coordinate of the rectangle 297 * @param color The rectangle's ARGB color, defined as a packed 32 bits word 298 * @param mode The Skia xfermode to use 299 * @param ignoreTransform True if the current transform should be ignored 300 * @param ignoreBlending True if the blending is set by the caller 301 */ 302 void drawColorRect(float left, float top, float right, float bottom, 303 int color, SkXfermode::Mode mode, bool ignoreTransform = false); 304 305 /** 306 * Draws the shape represented by the specified path texture. 307 * This method invokes drawPathTexture() but takes into account 308 * the extra left/top offset and the texture offset to correctly 309 * position the final shape. 310 * 311 * @param left The left coordinate of the shape to render 312 * @param top The top coordinate of the shape to render 313 * @param texture The texture reprsenting the shape 314 * @param paint The paint to draw the shape with 315 */ 316 void drawShape(float left, float top, const PathTexture* texture, SkPaint* paint); 317 318 /** 319 * Renders the rect defined by the specified bounds as a shape. 320 * This will render the rect using a path texture, which is used to render 321 * rects with stroke effects. 322 * 323 * @param left The left coordinate of the rect to draw 324 * @param top The top coordinate of the rect to draw 325 * @param right The right coordinate of the rect to draw 326 * @param bottom The bottom coordinate of the rect to draw 327 * @param p The paint to draw the rect with 328 */ 329 void drawRectAsShape(float left, float top, float right, float bottom, SkPaint* p); 330 331 /** 332 * Draws the specified texture as an alpha bitmap. Alpha bitmaps obey 333 * different compositing rules. 334 * 335 * @param texture The texture to draw with 336 * @param left The x coordinate of the bitmap 337 * @param top The y coordinate of the bitmap 338 * @param paint The paint to render with 339 */ 340 void drawAlphaBitmap(Texture* texture, float left, float top, SkPaint* paint); 341 342 /** 343 * Renders the rect defined by the specified bounds as an anti-aliased rect. 344 * 345 * @param left The left coordinate of the rect to draw 346 * @param top The top coordinate of the rect to draw 347 * @param right The right coordinate of the rect to draw 348 * @param bottom The bottom coordinate of the rect to draw 349 * @param color The color of the rect 350 * @param mode The blending mode to draw the rect 351 */ 352 void drawAARect(float left, float top, float right, float bottom, 353 int color, SkXfermode::Mode mode); 354 355 /** 356 * Draws a textured rectangle with the specified texture. The specified coordinates 357 * are transformed by the current snapshot's transform matrix. 358 * 359 * @param left The left coordinate of the rectangle 360 * @param top The top coordinate of the rectangle 361 * @param right The right coordinate of the rectangle 362 * @param bottom The bottom coordinate of the rectangle 363 * @param texture The texture name to map onto the rectangle 364 * @param alpha An additional translucency parameter, between 0.0f and 1.0f 365 * @param mode The blending mode 366 * @param blend True if the texture contains an alpha channel 367 */ 368 void drawTextureRect(float left, float top, float right, float bottom, GLuint texture, 369 float alpha, SkXfermode::Mode mode, bool blend); 370 371 /** 372 * Draws a textured rectangle with the specified texture. The specified coordinates 373 * are transformed by the current snapshot's transform matrix. 374 * 375 * @param left The left coordinate of the rectangle 376 * @param top The top coordinate of the rectangle 377 * @param right The right coordinate of the rectangle 378 * @param bottom The bottom coordinate of the rectangle 379 * @param texture The texture to use 380 * @param paint The paint containing the alpha, blending mode, etc. 381 */ 382 void drawTextureRect(float left, float top, float right, float bottom, 383 Texture* texture, SkPaint* paint); 384 385 /** 386 * Draws a textured mesh with the specified texture. If the indices are omitted, 387 * the mesh is drawn as a simple quad. The mesh pointers become offsets when a 388 * VBO is bound. 389 * 390 * @param left The left coordinate of the rectangle 391 * @param top The top coordinate of the rectangle 392 * @param right The right coordinate of the rectangle 393 * @param bottom The bottom coordinate of the rectangle 394 * @param texture The texture name to map onto the rectangle 395 * @param alpha An additional translucency parameter, between 0.0f and 1.0f 396 * @param mode The blending mode 397 * @param blend True if the texture contains an alpha channel 398 * @param vertices The vertices that define the mesh 399 * @param texCoords The texture coordinates of each vertex 400 * @param elementsCount The number of elements in the mesh, required by indices 401 * @param swapSrcDst Whether or not the src and dst blending operations should be swapped 402 * @param ignoreTransform True if the current transform should be ignored 403 * @param vbo The VBO used to draw the mesh 404 * @param ignoreScale True if the model view matrix should not be scaled 405 * @param dirty True if calling this method should dirty the current layer 406 */ 407 void drawTextureMesh(float left, float top, float right, float bottom, GLuint texture, 408 float alpha, SkXfermode::Mode mode, bool blend, 409 GLvoid* vertices, GLvoid* texCoords, GLenum drawMode, GLsizei elementsCount, 410 bool swapSrcDst = false, bool ignoreTransform = false, GLuint vbo = 0, 411 bool ignoreScale = false, bool dirty = true); 412 413 /** 414 * Draws text underline and strike-through if needed. 415 * 416 * @param text The text to decor 417 * @param bytesCount The number of bytes in the text 418 * @param length The length in pixels of the text, can be <= 0.0f to force a measurement 419 * @param x The x coordinate where the text will be drawn 420 * @param y The y coordinate where the text will be drawn 421 * @param paint The paint to draw the text with 422 */ 423 void drawTextDecorations(const char* text, int bytesCount, float length, 424 float x, float y, SkPaint* paint); 425 426 /** 427 * Draws a path texture. Path textures are alpha8 bitmaps that need special 428 * compositing to apply colors/filters/etc. 429 * 430 * @param texture The texture to render 431 * @param x The x coordinate where the texture will be drawn 432 * @param y The y coordinate where the texture will be drawn 433 * @param paint The paint to draw the texture with 434 */ 435 void drawPathTexture(const PathTexture* texture, float x, float y, SkPaint* paint); 436 437 /** 438 * Resets the texture coordinates stored in mMeshVertices. Setting the values 439 * back to default is achieved by calling: 440 * 441 * resetDrawTextureTexCoords(0.0f, 0.0f, 1.0f, 1.0f); 442 * 443 * @param u1 The left coordinate of the texture 444 * @param v1 The bottom coordinate of the texture 445 * @param u2 The right coordinate of the texture 446 * @param v2 The top coordinate of the texture 447 */ 448 void resetDrawTextureTexCoords(float u1, float v1, float u2, float v2); 449 450 /** 451 * Gets the alpha and xfermode out of a paint object. If the paint is null 452 * alpha will be 255 and the xfermode will be SRC_OVER. 453 * 454 * @param paint The paint to extract values from 455 * @param alpha Where to store the resulting alpha 456 * @param mode Where to store the resulting xfermode 457 */ 458 inline void getAlphaAndMode(SkPaint* paint, int* alpha, SkXfermode::Mode* mode); 459 460 /** 461 * Binds the specified texture. The texture unit must have been selected 462 * prior to calling this method. 463 */ 464 inline void bindTexture(GLuint texture) { 465 glBindTexture(GL_TEXTURE_2D, texture); 466 } 467 468 /** 469 * Binds the specified EGLImage texture. The texture unit must have been selected 470 * prior to calling this method. 471 */ 472 inline void bindExternalTexture(GLuint texture) { 473 glBindTexture(GL_TEXTURE_EXTERNAL_OES, texture); 474 } 475 476 /** 477 * Enable or disable blending as necessary. This function sets the appropriate 478 * blend function based on the specified xfermode. 479 */ 480 inline void chooseBlending(bool blend, SkXfermode::Mode mode, ProgramDescription& description, 481 bool swapSrcDst = false); 482 483 /** 484 * Safely retrieves the mode from the specified xfermode. If the specified 485 * xfermode is null, the mode is assumed to be SkXfermode::kSrcOver_Mode. 486 */ 487 inline SkXfermode::Mode getXfermode(SkXfermode* mode); 488 489 /** 490 * Use the specified program with the current GL context. If the program is already 491 * in use, it will not be bound again. If it is not in use, the current program is 492 * marked unused and the specified program becomes used and becomes the new 493 * current program. 494 * 495 * @param program The program to use 496 * 497 * @return true If the specified program was already in use, false otherwise. 498 */ 499 inline bool useProgram(Program* program); 500 501 /** 502 * Invoked before any drawing operation. This sets required state. 503 */ 504 void setupDraw(bool clear = true); 505 /** 506 * Various methods to setup OpenGL rendering. 507 */ 508 void setupDrawWithTexture(bool isAlpha8 = false); 509 void setupDrawWithExternalTexture(); 510 void setupDrawNoTexture(); 511 void setupDrawAALine(); 512 void setupDrawPoint(float pointSize); 513 void setupDrawColor(int color); 514 void setupDrawColor(int color, int alpha); 515 void setupDrawColor(float r, float g, float b, float a); 516 void setupDrawAlpha8Color(int color, int alpha); 517 void setupDrawAlpha8Color(float r, float g, float b, float a); 518 void setupDrawShader(); 519 void setupDrawColorFilter(); 520 void setupDrawBlending(SkXfermode::Mode mode = SkXfermode::kSrcOver_Mode, 521 bool swapSrcDst = false); 522 void setupDrawBlending(bool blend = true, SkXfermode::Mode mode = SkXfermode::kSrcOver_Mode, 523 bool swapSrcDst = false); 524 void setupDrawProgram(); 525 void setupDrawDirtyRegionsDisabled(); 526 void setupDrawModelViewIdentity(bool offset = false); 527 void setupDrawModelView(float left, float top, float right, float bottom, 528 bool ignoreTransform = false, bool ignoreModelView = false); 529 void setupDrawModelViewTranslate(float left, float top, float right, float bottom, 530 bool ignoreTransform = false); 531 void setupDrawPointUniforms(); 532 void setupDrawColorUniforms(); 533 void setupDrawPureColorUniforms(); 534 void setupDrawShaderIdentityUniforms(); 535 void setupDrawShaderUniforms(bool ignoreTransform = false); 536 void setupDrawColorFilterUniforms(); 537 void setupDrawSimpleMesh(); 538 void setupDrawTexture(GLuint texture); 539 void setupDrawExternalTexture(GLuint texture); 540 void setupDrawTextureTransform(); 541 void setupDrawTextureTransformUniforms(mat4& transform); 542 void setupDrawMesh(GLvoid* vertices, GLvoid* texCoords = NULL, GLuint vbo = 0); 543 void setupDrawMeshIndices(GLvoid* vertices, GLvoid* texCoords); 544 void setupDrawVertices(GLvoid* vertices); 545 void setupDrawAALine(GLvoid* vertices, GLvoid* distanceCoords, GLvoid* lengthCoords, 546 float strokeWidth); 547 void finishDrawTexture(); 548 void accountForClear(SkXfermode::Mode mode); 549 550 void drawRegionRects(const Region& region); 551 552 /** 553 * Should be invoked every time the glScissor is modified. 554 */ 555 inline void dirtyClip() { 556 mDirtyClip = true; 557 } 558 559 // Dimensions of the drawing surface 560 int mWidth, mHeight; 561 562 // Matrix used for ortho projection in shaders 563 mat4 mOrthoMatrix; 564 565 // Model-view matrix used to position/size objects 566 mat4 mModelView; 567 568 // Number of saved states 569 int mSaveCount; 570 // Base state 571 sp<Snapshot> mFirstSnapshot; 572 // Current state 573 sp<Snapshot> mSnapshot; 574 575 // Shaders 576 SkiaShader* mShader; 577 578 // Color filters 579 SkiaColorFilter* mColorFilter; 580 581 // Used to draw textured quads 582 TextureVertex mMeshVertices[4]; 583 584 // Drop shadow 585 bool mHasShadow; 586 float mShadowRadius; 587 float mShadowDx; 588 float mShadowDy; 589 int mShadowColor; 590 591 // Draw filters 592 bool mHasDrawFilter; 593 int mPaintFilterClearBits; 594 int mPaintFilterSetBits; 595 SkPaint mFilteredPaint; 596 597 // Various caches 598 Caches& mCaches; 599 600 // List of rectagnles to clear after saveLayer() is invoked 601 Vector<Rect*> mLayers; 602 603 // Indentity matrix 604 const mat4 mIdentity; 605 606 // Indicates whether the clip must be restored 607 bool mDirtyClip; 608 609 // The following fields are used to setup drawing 610 // Used to describe the shaders to generate 611 ProgramDescription mDescription; 612 // Color description 613 bool mColorSet; 614 float mColorA, mColorR, mColorG, mColorB; 615 // Indicates that the shader should get a color 616 bool mSetShaderColor; 617 // Current texture unit 618 GLuint mTextureUnit; 619 // Track dirty regions, true by default 620 bool mTrackDirtyRegions; 621 622 friend class DisplayListRenderer; 623 624}; // class OpenGLRenderer 625 626}; // namespace uirenderer 627}; // namespace android 628 629#endif // ANDROID_HWUI_OPENGL_RENDERER_H 630