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