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