OpenGLRenderer.h revision 448455fe783b0a711340322dca272b8cc0ebe473
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/SortedVector.h> 33#include <utils/Vector.h> 34 35#include <cutils/compiler.h> 36 37#include <androidfw/ResourceTypes.h> 38 39#include "Debug.h" 40#include "Extensions.h" 41#include "Matrix.h" 42#include "Program.h" 43#include "Rect.h" 44#include "Snapshot.h" 45#include "Vertex.h" 46#include "SkiaShader.h" 47#include "SkiaColorFilter.h" 48#include "UvMapper.h" 49#include "Caches.h" 50 51namespace android { 52namespace uirenderer { 53 54struct DrawModifiers { 55 SkiaShader* mShader; 56 SkiaColorFilter* mColorFilter; 57 float mOverrideLayerAlpha; 58 59 // Drop shadow 60 bool mHasShadow; 61 float mShadowRadius; 62 float mShadowDx; 63 float mShadowDy; 64 int mShadowColor; 65 66 // Draw filters 67 bool mHasDrawFilter; 68 int mPaintFilterClearBits; 69 int mPaintFilterSetBits; 70}; 71 72enum StateDeferFlags { 73 kStateDeferFlag_Draw = 0x1, 74 kStateDeferFlag_Clip = 0x2 75}; 76 77enum DrawOpMode { 78 kDrawOpMode_Immediate, 79 kDrawOpMode_Defer, 80 kDrawOpMode_Flush 81}; 82 83enum ClipSideFlags { 84 kClipSide_None = 0x0, 85 kClipSide_Left = 0x1, 86 kClipSide_Top = 0x2, 87 kClipSide_Right = 0x4, 88 kClipSide_Bottom = 0x8, 89 kClipSide_Full = 0xF, 90 kClipSide_ConservativeFull = 0x1F 91}; 92 93struct DeferredDisplayState { 94 // global op bounds, mapped by mMatrix to be in screen space coordinates, clipped 95 Rect mBounds; 96 97 // the below are set and used by the OpenGLRenderer at record and deferred playback 98 bool mClipValid; 99 Rect mClip; 100 int mClipSideFlags; // specifies which sides of the bounds are clipped, unclipped if cleared 101 bool mClipped; 102 mat4 mMatrix; 103 DrawModifiers mDrawModifiers; 104 float mAlpha; 105}; 106 107/////////////////////////////////////////////////////////////////////////////// 108// Renderer 109/////////////////////////////////////////////////////////////////////////////// 110 111class DisplayList; 112class TextSetupFunctor; 113class VertexBuffer; 114 115/** 116 * OpenGL renderer used to draw accelerated 2D graphics. The API is a 117 * simplified version of Skia's Canvas API. 118 */ 119class OpenGLRenderer { 120public: 121 ANDROID_API OpenGLRenderer(); 122 virtual ~OpenGLRenderer(); 123 124 /** 125 * Sets the name of this renderer. The name is optional and 126 * empty by default. If the pointer is null the name is set 127 * to the empty string. 128 */ 129 ANDROID_API void setName(const char* name); 130 131 /** 132 * Returns the name of this renderer as UTF8 string. 133 * The returned pointer is never null. 134 */ 135 ANDROID_API const char* getName() const; 136 137 /** 138 * Read externally defined properties to control the behavior 139 * of the renderer. 140 */ 141 ANDROID_API void initProperties(); 142 143 /** 144 * Indicates whether this renderer executes drawing commands immediately. 145 * If this method returns true, the drawing commands will be executed 146 * later. 147 */ 148 virtual bool isDeferred(); 149 150 /** 151 * Sets the dimension of the underlying drawing surface. This method must 152 * be called at least once every time the drawing surface changes size. 153 * 154 * @param width The width in pixels of the underlysing surface 155 * @param height The height in pixels of the underlysing surface 156 */ 157 virtual void setViewport(int width, int height); 158 159 /** 160 * Prepares the renderer to draw a frame. This method must be invoked 161 * at the beginning of each frame. When this method is invoked, the 162 * entire drawing surface is assumed to be redrawn. 163 * 164 * @param opaque If true, the target surface is considered opaque 165 * and will not be cleared. If false, the target surface 166 * will be cleared 167 */ 168 ANDROID_API status_t prepare(bool opaque); 169 170 /** 171 * Prepares the renderer to draw a frame. This method must be invoked 172 * at the beginning of each frame. Only the specified rectangle of the 173 * frame is assumed to be dirty. A clip will automatically be set to 174 * the specified rectangle. 175 * 176 * @param left The left coordinate of the dirty rectangle 177 * @param top The top coordinate of the dirty rectangle 178 * @param right The right coordinate of the dirty rectangle 179 * @param bottom The bottom coordinate of the dirty rectangle 180 * @param opaque If true, the target surface is considered opaque 181 * and will not be cleared. If false, the target surface 182 * will be cleared in the specified dirty rectangle 183 */ 184 virtual status_t prepareDirty(float left, float top, float right, float bottom, bool opaque); 185 186 /** 187 * Indicates the end of a frame. This method must be invoked whenever 188 * the caller is done rendering a frame. 189 */ 190 virtual void finish(); 191 192 /** 193 * This method must be invoked before handing control over to a draw functor. 194 * See callDrawGLFunction() for instance. 195 * 196 * This command must not be recorded inside display lists. 197 */ 198 virtual void interrupt(); 199 200 /** 201 * This method must be invoked after getting control back from a draw functor. 202 * 203 * This command must not be recorded inside display lists. 204 */ 205 virtual void resume(); 206 207 ANDROID_API void setCountOverdrawEnabled(bool enabled) { 208 mCountOverdraw = enabled; 209 } 210 211 ANDROID_API float getOverdraw() { 212 return mCountOverdraw ? mOverdraw : 0.0f; 213 } 214 215 ANDROID_API status_t invokeFunctors(Rect& dirty); 216 ANDROID_API void detachFunctor(Functor* functor); 217 ANDROID_API void attachFunctor(Functor* functor); 218 virtual status_t callDrawGLFunction(Functor* functor, Rect& dirty); 219 220 ANDROID_API void pushLayerUpdate(Layer* layer); 221 ANDROID_API void cancelLayerUpdate(Layer* layer); 222 ANDROID_API void clearLayerUpdates(); 223 ANDROID_API void flushLayerUpdates(); 224 225 ANDROID_API int getSaveCount() const; 226 virtual int save(int flags); 227 virtual void restore(); 228 virtual void restoreToCount(int saveCount); 229 230 ANDROID_API int saveLayer(float left, float top, float right, float bottom, 231 SkPaint* paint, int flags) { 232 SkXfermode::Mode mode = SkXfermode::kSrcOver_Mode; 233 if (paint) mode = getXfermode(paint->getXfermode()); 234 return saveLayer(left, top, right, bottom, paint ? paint->getAlpha() : 255, mode, flags); 235 } 236 ANDROID_API int saveLayerAlpha(float left, float top, float right, float bottom, 237 int alpha, int flags) { 238 return saveLayer(left, top, right, bottom, alpha, SkXfermode::kSrcOver_Mode, flags); 239 } 240 virtual int saveLayer(float left, float top, float right, float bottom, 241 int alpha, SkXfermode::Mode mode, int flags); 242 243 int saveLayerDeferred(float left, float top, float right, float bottom, 244 int alpha, SkXfermode::Mode mode, int flags); 245 246 virtual void translate(float dx, float dy); 247 virtual void rotate(float degrees); 248 virtual void scale(float sx, float sy); 249 virtual void skew(float sx, float sy); 250 251 bool hasRectToRectTransform(); 252 ANDROID_API void getMatrix(SkMatrix* matrix); 253 virtual void setMatrix(SkMatrix* matrix); 254 virtual void concatMatrix(SkMatrix* matrix); 255 256 ANDROID_API const Rect& getClipBounds(); 257 258 /** 259 * Performs a quick reject but adjust the bounds to account for stroke width if necessary 260 */ 261 bool quickRejectPreStroke(float left, float top, float right, float bottom, SkPaint* paint); 262 263 /** 264 * Returns false and sets scissor based upon bounds if drawing won't be clipped out 265 */ 266 bool quickReject(float left, float top, float right, float bottom); 267 bool quickReject(const Rect& bounds) { 268 return quickReject(bounds.left, bounds.top, bounds.right, bounds.bottom); 269 } 270 271 /** 272 * Same as quickReject, without the scissor, instead returning clipRequired through pointer. 273 * clipRequired will be only set if not rejected 274 */ 275 ANDROID_API bool quickRejectNoScissor(float left, float top, float right, float bottom, 276 bool* clipRequired = NULL); 277 bool quickRejectNoScissor(const Rect& bounds, bool* clipRequired = NULL) { 278 return quickRejectNoScissor(bounds.left, bounds.top, bounds.right, bounds.bottom, 279 clipRequired); 280 } 281 282 virtual bool clipRect(float left, float top, float right, float bottom, SkRegion::Op op); 283 virtual bool clipPath(SkPath* path, SkRegion::Op op); 284 virtual bool clipRegion(SkRegion* region, SkRegion::Op op); 285 virtual Rect* getClipRect(); 286 287 virtual status_t drawDisplayList(DisplayList* displayList, Rect& dirty, int32_t replayFlags); 288 virtual void outputDisplayList(DisplayList* displayList); 289 virtual status_t drawLayer(Layer* layer, float x, float y); 290 virtual status_t drawBitmap(SkBitmap* bitmap, float left, float top, SkPaint* paint); 291 status_t drawBitmaps(SkBitmap* bitmap, AssetAtlas::Entry* entry, int bitmapCount, 292 TextureVertex* vertices, bool transformed, const Rect& bounds, SkPaint* paint); 293 virtual status_t drawBitmap(SkBitmap* bitmap, SkMatrix* matrix, SkPaint* paint); 294 virtual status_t drawBitmap(SkBitmap* bitmap, float srcLeft, float srcTop, 295 float srcRight, float srcBottom, float dstLeft, float dstTop, 296 float dstRight, float dstBottom, SkPaint* paint); 297 virtual status_t drawBitmapData(SkBitmap* bitmap, float left, float top, SkPaint* paint); 298 virtual status_t drawBitmapMesh(SkBitmap* bitmap, int meshWidth, int meshHeight, 299 float* vertices, int* colors, SkPaint* paint); 300 status_t drawPatches(SkBitmap* bitmap, AssetAtlas::Entry* entry, 301 TextureVertex* vertices, uint32_t indexCount, SkPaint* paint); 302 virtual status_t drawPatch(SkBitmap* bitmap, Res_png_9patch* patch, 303 float left, float top, float right, float bottom, SkPaint* paint); 304 status_t drawPatch(SkBitmap* bitmap, const Patch* mesh, AssetAtlas::Entry* entry, 305 float left, float top, float right, float bottom, SkPaint* paint); 306 virtual status_t drawColor(int color, SkXfermode::Mode mode); 307 virtual status_t drawRect(float left, float top, float right, float bottom, SkPaint* paint); 308 virtual status_t drawRoundRect(float left, float top, float right, float bottom, 309 float rx, float ry, SkPaint* paint); 310 virtual status_t drawCircle(float x, float y, float radius, SkPaint* paint); 311 virtual status_t drawOval(float left, float top, float right, float bottom, SkPaint* paint); 312 virtual status_t drawArc(float left, float top, float right, float bottom, 313 float startAngle, float sweepAngle, bool useCenter, SkPaint* paint); 314 virtual status_t drawPath(SkPath* path, SkPaint* paint); 315 virtual status_t drawLines(float* points, int count, SkPaint* paint); 316 virtual status_t drawPoints(float* points, int count, SkPaint* paint); 317 virtual status_t drawTextOnPath(const char* text, int bytesCount, int count, SkPath* path, 318 float hOffset, float vOffset, SkPaint* paint); 319 virtual status_t drawPosText(const char* text, int bytesCount, int count, 320 const float* positions, SkPaint* paint); 321 virtual status_t drawText(const char* text, int bytesCount, int count, float x, float y, 322 const float* positions, SkPaint* paint, float totalAdvance, const Rect& bounds, 323 DrawOpMode drawOpMode = kDrawOpMode_Immediate); 324 virtual status_t drawRects(const float* rects, int count, SkPaint* paint); 325 326 virtual void resetShader(); 327 virtual void setupShader(SkiaShader* shader); 328 329 virtual void resetColorFilter(); 330 virtual void setupColorFilter(SkiaColorFilter* filter); 331 332 virtual void resetShadow(); 333 virtual void setupShadow(float radius, float dx, float dy, int color); 334 335 virtual void resetPaintFilter(); 336 virtual void setupPaintFilter(int clearBits, int setBits); 337 338 // If this value is set to < 1.0, it overrides alpha set on layer (see drawBitmap, drawLayer) 339 void setOverrideLayerAlpha(float alpha) { mDrawModifiers.mOverrideLayerAlpha = alpha; } 340 341 SkPaint* filterPaint(SkPaint* paint); 342 343 bool storeDisplayState(DeferredDisplayState& state, int stateDeferFlags); 344 void restoreDisplayState(const DeferredDisplayState& state, bool skipClipRestore = false); 345 void setupMergedMultiDraw(const Rect* clipRect); 346 347 const DrawModifiers& getDrawModifiers() { return mDrawModifiers; } 348 void setDrawModifiers(const DrawModifiers& drawModifiers) { mDrawModifiers = drawModifiers; } 349 350 ANDROID_API bool isCurrentTransformSimple() { 351 return mSnapshot->transform->isSimple(); 352 } 353 354 Caches& getCaches() { 355 return mCaches; 356 } 357 358 // simple rect clip 359 bool isCurrentClipSimple() { 360 return mSnapshot->clipRegion->isEmpty(); 361 } 362 363 int getViewportWidth() { return getSnapshot()->viewport.getWidth(); } 364 int getViewportHeight() { return getSnapshot()->viewport.getHeight(); } 365 366 /** 367 * Scales the alpha on the current snapshot. This alpha value will be modulated 368 * with other alpha values when drawing primitives. 369 */ 370 void scaleAlpha(float alpha) { 371 mSnapshot->alpha *= alpha; 372 } 373 374 /** 375 * Inserts a named event marker in the stream of GL commands. 376 */ 377 void eventMark(const char* name) const; 378 379 /** 380 * Inserts a named group marker in the stream of GL commands. This marker 381 * can be used by tools to group commands into logical groups. A call to 382 * this method must always be followed later on by a call to endMark(). 383 */ 384 void startMark(const char* name) const; 385 386 /** 387 * Closes the last group marker opened by startMark(). 388 */ 389 void endMark() const; 390 391 /** 392 * Gets the alpha and xfermode out of a paint object. If the paint is null 393 * alpha will be 255 and the xfermode will be SRC_OVER. This method does 394 * not multiply the paint's alpha by the current snapshot's alpha, and does 395 * not replace the alpha with the overrideLayerAlpha 396 * 397 * @param paint The paint to extract values from 398 * @param alpha Where to store the resulting alpha 399 * @param mode Where to store the resulting xfermode 400 */ 401 static inline void getAlphaAndModeDirect(SkPaint* paint, int* alpha, SkXfermode::Mode* mode) { 402 *mode = getXfermodeDirect(paint); 403 *alpha = getAlphaDirect(paint); 404 } 405 406 static inline SkXfermode::Mode getXfermodeDirect(SkPaint* paint) { 407 if (!paint) return SkXfermode::kSrcOver_Mode; 408 return getXfermode(paint->getXfermode()); 409 } 410 411 static inline int getAlphaDirect(SkPaint* paint) { 412 if (!paint) return 255; 413 return paint->getAlpha(); 414 } 415 416 /** 417 * Return the best transform to use to rasterize text given a full 418 * transform matrix. 419 */ 420 mat4 findBestFontTransform(const mat4& transform) const; 421 422#if DEBUG_MERGE_BEHAVIOR 423 void drawScreenSpaceColorRect(float left, float top, float right, float bottom, int color) { 424 mCaches.setScissorEnabled(false); 425 426 // should only be called outside of other draw ops, so stencil can only be in test state 427 bool stencilWasEnabled = mCaches.stencil.isTestEnabled(); 428 mCaches.stencil.disable(); 429 430 drawColorRect(left, top, right, bottom, color, SkXfermode::kSrcOver_Mode, true); 431 432 if (stencilWasEnabled) mCaches.stencil.enableTest(); 433 } 434#endif 435 436protected: 437 /** 438 * Computes the projection matrix, initialize the first snapshot 439 * and stores the dimensions of the render target. 440 */ 441 void initViewport(int width, int height); 442 443 /** 444 * Perform the setup specific to a frame. This method does not 445 * issue any OpenGL commands. 446 */ 447 void setupFrameState(float left, float top, float right, float bottom, bool opaque); 448 449 /** 450 * Indicates the start of rendering. This method will setup the 451 * initial OpenGL state (viewport, clearing the buffer, etc.) 452 */ 453 status_t startFrame(); 454 455 /** 456 * Clears the underlying surface if needed. 457 */ 458 virtual status_t clear(float left, float top, float right, float bottom, bool opaque); 459 460 /** 461 * Call this method after updating a layer during a drawing pass. 462 */ 463 void resumeAfterLayer(); 464 465 /** 466 * This method is called whenever a stencil buffer is required. Subclasses 467 * should override this method and call attachStencilBufferToLayer() on the 468 * appropriate layer(s). 469 */ 470 virtual void ensureStencilBuffer(); 471 472 /** 473 * Obtains a stencil render buffer (allocating it if necessary) and 474 * attaches it to the specified layer. 475 */ 476 void attachStencilBufferToLayer(Layer* layer); 477 478 /** 479 * Compose the layer defined in the current snapshot with the layer 480 * defined by the previous snapshot. 481 * 482 * The current snapshot *must* be a layer (flag kFlagIsLayer set.) 483 * 484 * @param curent The current snapshot containing the layer to compose 485 * @param previous The previous snapshot to compose the current layer with 486 */ 487 virtual void composeLayer(sp<Snapshot> current, sp<Snapshot> previous); 488 489 /** 490 * Marks the specified region as dirty at the specified bounds. 491 */ 492 void dirtyLayerUnchecked(Rect& bounds, Region* region); 493 494 /** 495 * Returns the current snapshot. 496 */ 497 sp<Snapshot> getSnapshot() const { 498 return mSnapshot; 499 } 500 501 /** 502 * Returns the region of the current layer. 503 */ 504 virtual Region* getRegion() const { 505 return mSnapshot->region; 506 } 507 508 /** 509 * Indicates whether rendering is currently targeted at a layer. 510 */ 511 virtual bool hasLayer() const { 512 return (mSnapshot->flags & Snapshot::kFlagFboTarget) && mSnapshot->region; 513 } 514 515 /** 516 * Returns the name of the FBO this renderer is rendering into. 517 */ 518 virtual GLint getTargetFbo() const { 519 return 0; 520 } 521 522 /** 523 * Renders the specified layer as a textured quad. 524 * 525 * @param layer The layer to render 526 * @param rect The bounds of the layer 527 */ 528 void drawTextureLayer(Layer* layer, const Rect& rect); 529 530 /** 531 * Gets the alpha and xfermode out of a paint object. If the paint is null 532 * alpha will be 255 and the xfermode will be SRC_OVER. Accounts for both 533 * snapshot alpha, and overrideLayerAlpha 534 * 535 * @param paint The paint to extract values from 536 * @param alpha Where to store the resulting alpha 537 * @param mode Where to store the resulting xfermode 538 */ 539 inline void getAlphaAndMode(SkPaint* paint, int* alpha, SkXfermode::Mode* mode) const; 540 541 /** 542 * Gets the alpha from a layer, accounting for snapshot alpha and overrideLayerAlpha 543 * 544 * @param layer The layer from which the alpha is extracted 545 */ 546 inline float getLayerAlpha(Layer* layer) const; 547 548 /** 549 * Safely retrieves the mode from the specified xfermode. If the specified 550 * xfermode is null, the mode is assumed to be SkXfermode::kSrcOver_Mode. 551 */ 552 static inline SkXfermode::Mode getXfermode(SkXfermode* mode) { 553 SkXfermode::Mode resultMode; 554 if (!SkXfermode::AsMode(mode, &resultMode)) { 555 resultMode = SkXfermode::kSrcOver_Mode; 556 } 557 return resultMode; 558 } 559 560 /** 561 * Set to true to suppress error checks at the end of a frame. 562 */ 563 virtual bool suppressErrorChecks() const { 564 return false; 565 } 566 567private: 568 /** 569 * Discards the content of the framebuffer if supported by the driver. 570 * This method should be called at the beginning of a frame to optimize 571 * rendering on some tiler architectures. 572 */ 573 void discardFramebuffer(float left, float top, float right, float bottom); 574 575 /** 576 * Ensures the state of the renderer is the same as the state of 577 * the GL context. 578 */ 579 void syncState(); 580 581 /** 582 * Tells the GPU what part of the screen is about to be redrawn. 583 * This method will use the clip rect that we started drawing the 584 * frame with. 585 * This method needs to be invoked every time getTargetFbo() is 586 * bound again. 587 */ 588 void startTiling(const sp<Snapshot>& snapshot, bool opaque = false); 589 590 /** 591 * Tells the GPU what part of the screen is about to be redrawn. 592 * This method needs to be invoked every time getTargetFbo() is 593 * bound again. 594 */ 595 void startTiling(const Rect& clip, int windowHeight, bool opaque = false); 596 597 /** 598 * Tells the GPU that we are done drawing the frame or that we 599 * are switching to another render target. 600 */ 601 void endTiling(); 602 603 /** 604 * Saves the current state of the renderer as a new snapshot. 605 * The new snapshot is saved in mSnapshot and the previous snapshot 606 * is linked from mSnapshot->previous. 607 * 608 * @param flags The save flags; see SkCanvas for more information 609 * 610 * @return The new save count. This value can be passed to #restoreToCount() 611 */ 612 int saveSnapshot(int flags); 613 614 /** 615 * Restores the current snapshot; mSnapshot becomes mSnapshot->previous. 616 * 617 * @return True if the clip was modified. 618 */ 619 bool restoreSnapshot(); 620 621 /** 622 * Sets the clipping rectangle using glScissor. The clip is defined by 623 * the current snapshot's clipRect member. 624 */ 625 void setScissorFromClip(); 626 627 /** 628 * Sets the clipping region using the stencil buffer. The clip region 629 * is defined by the current snapshot's clipRegion member. 630 */ 631 void setStencilFromClip(); 632 633 /** 634 * Given the local bounds of the layer, calculates ... 635 */ 636 void calculateLayerBoundsAndClip(Rect& bounds, Rect& clip, bool fboLayer); 637 638 /** 639 * Given the local bounds + clip of the layer, updates current snapshot's empty/invisible 640 */ 641 void updateSnapshotIgnoreForLayer(const Rect& bounds, const Rect& clip, 642 bool fboLayer, int alpha); 643 644 /** 645 * Creates a new layer stored in the specified snapshot. 646 * 647 * @param snapshot The snapshot associated with the new layer 648 * @param left The left coordinate of the layer 649 * @param top The top coordinate of the layer 650 * @param right The right coordinate of the layer 651 * @param bottom The bottom coordinate of the layer 652 * @param alpha The translucency of the layer 653 * @param mode The blending mode of the layer 654 * @param flags The layer save flags 655 * @param previousFbo The name of the current framebuffer 656 * 657 * @return True if the layer was successfully created, false otherwise 658 */ 659 bool createLayer(float left, float top, float right, float bottom, 660 int alpha, SkXfermode::Mode mode, int flags, GLuint previousFbo); 661 662 /** 663 * Creates a new layer stored in the specified snapshot as an FBO. 664 * 665 * @param layer The layer to store as an FBO 666 * @param snapshot The snapshot associated with the new layer 667 * @param bounds The bounds of the layer 668 * @param previousFbo The name of the current framebuffer 669 */ 670 bool createFboLayer(Layer* layer, Rect& bounds, Rect& clip, GLuint previousFbo); 671 672 /** 673 * Compose the specified layer as a region. 674 * 675 * @param layer The layer to compose 676 * @param rect The layer's bounds 677 */ 678 void composeLayerRegion(Layer* layer, const Rect& rect); 679 680 /** 681 * Compose the specified layer as a simple rectangle. 682 * 683 * @param layer The layer to compose 684 * @param rect The layer's bounds 685 * @param swap If true, the source and destination are swapped 686 */ 687 void composeLayerRect(Layer* layer, const Rect& rect, bool swap = false); 688 689 /** 690 * Clears all the regions corresponding to the current list of layers. 691 * This method MUST be invoked before any drawing operation. 692 */ 693 void clearLayerRegions(); 694 695 /** 696 * Mark the layer as dirty at the specified coordinates. The coordinates 697 * are transformed with the supplied matrix. 698 */ 699 void dirtyLayer(const float left, const float top, 700 const float right, const float bottom, const mat4 transform); 701 702 /** 703 * Mark the layer as dirty at the specified coordinates. 704 */ 705 void dirtyLayer(const float left, const float top, 706 const float right, const float bottom); 707 708 /** 709 * Draws a colored rectangle with the specified color. The specified coordinates 710 * are transformed by the current snapshot's transform matrix unless specified 711 * otherwise. 712 * 713 * @param left The left coordinate of the rectangle 714 * @param top The top coordinate of the rectangle 715 * @param right The right coordinate of the rectangle 716 * @param bottom The bottom coordinate of the rectangle 717 * @param color The rectangle's ARGB color, defined as a packed 32 bits word 718 * @param mode The Skia xfermode to use 719 * @param ignoreTransform True if the current transform should be ignored 720 */ 721 void drawColorRect(float left, float top, float right, float bottom, 722 int color, SkXfermode::Mode mode, bool ignoreTransform = false); 723 724 /** 725 * Draws a series of colored rectangles with the specified color. The specified 726 * coordinates are transformed by the current snapshot's transform matrix unless 727 * specified otherwise. 728 * 729 * @param rects A list of rectangles, 4 floats (left, top, right, bottom) 730 * per rectangle 731 * @param color The rectangles' ARGB color, defined as a packed 32 bits word 732 * @param mode The Skia xfermode to use 733 * @param ignoreTransform True if the current transform should be ignored 734 * @param dirty True if calling this method should dirty the current layer 735 * @param clip True if the rects should be clipped, false otherwise 736 */ 737 status_t drawColorRects(const float* rects, int count, int color, 738 SkXfermode::Mode mode, bool ignoreTransform = false, 739 bool dirty = true, bool clip = true); 740 741 /** 742 * Draws the shape represented by the specified path texture. 743 * This method invokes drawPathTexture() but takes into account 744 * the extra left/top offset and the texture offset to correctly 745 * position the final shape. 746 * 747 * @param left The left coordinate of the shape to render 748 * @param top The top coordinate of the shape to render 749 * @param texture The texture reprsenting the shape 750 * @param paint The paint to draw the shape with 751 */ 752 status_t drawShape(float left, float top, const PathTexture* texture, SkPaint* paint); 753 754 /** 755 * Draws the specified texture as an alpha bitmap. Alpha bitmaps obey 756 * different compositing rules. 757 * 758 * @param texture The texture to draw with 759 * @param left The x coordinate of the bitmap 760 * @param top The y coordinate of the bitmap 761 * @param paint The paint to render with 762 */ 763 void drawAlphaBitmap(Texture* texture, float left, float top, SkPaint* paint); 764 765 /** 766 * Renders a strip of polygons with the specified paint, used for tessellated geometry. 767 * 768 * @param vertexBuffer The VertexBuffer to be drawn 769 * @param paint The paint to render with 770 * @param useOffset Offset the vertexBuffer (used in drawing non-AA lines) 771 */ 772 status_t drawVertexBuffer(const VertexBuffer& vertexBuffer, SkPaint* paint, 773 bool useOffset = false); 774 775 /** 776 * Renders the convex hull defined by the specified path as a strip of polygons. 777 * 778 * @param path The hull of the path to draw 779 * @param paint The paint to render with 780 */ 781 status_t drawConvexPath(const SkPath& path, SkPaint* paint); 782 783 /** 784 * Draws a textured rectangle with the specified texture. The specified coordinates 785 * are transformed by the current snapshot's transform matrix. 786 * 787 * @param left The left coordinate of the rectangle 788 * @param top The top coordinate of the rectangle 789 * @param right The right coordinate of the rectangle 790 * @param bottom The bottom coordinate of the rectangle 791 * @param texture The texture name to map onto the rectangle 792 * @param alpha An additional translucency parameter, between 0.0f and 1.0f 793 * @param mode The blending mode 794 * @param blend True if the texture contains an alpha channel 795 */ 796 void drawTextureRect(float left, float top, float right, float bottom, GLuint texture, 797 float alpha, SkXfermode::Mode mode, bool blend); 798 799 /** 800 * Draws a textured rectangle with the specified texture. The specified coordinates 801 * are transformed by the current snapshot's transform matrix. 802 * 803 * @param left The left coordinate of the rectangle 804 * @param top The top coordinate of the rectangle 805 * @param right The right coordinate of the rectangle 806 * @param bottom The bottom coordinate of the rectangle 807 * @param texture The texture to use 808 * @param paint The paint containing the alpha, blending mode, etc. 809 */ 810 void drawTextureRect(float left, float top, float right, float bottom, 811 Texture* texture, SkPaint* paint); 812 813 /** 814 * Draws a textured mesh with the specified texture. If the indices are omitted, 815 * the mesh is drawn as a simple quad. The mesh pointers become offsets when a 816 * VBO is bound. 817 * 818 * @param left The left coordinate of the rectangle 819 * @param top The top coordinate of the rectangle 820 * @param right The right coordinate of the rectangle 821 * @param bottom The bottom coordinate of the rectangle 822 * @param texture The texture name to map onto the rectangle 823 * @param alpha An additional translucency parameter, between 0.0f and 1.0f 824 * @param mode The blending mode 825 * @param blend True if the texture contains an alpha channel 826 * @param vertices The vertices that define the mesh 827 * @param texCoords The texture coordinates of each vertex 828 * @param elementsCount The number of elements in the mesh, required by indices 829 * @param swapSrcDst Whether or not the src and dst blending operations should be swapped 830 * @param ignoreTransform True if the current transform should be ignored 831 * @param vbo The VBO used to draw the mesh 832 * @param ignoreScale True if the model view matrix should not be scaled 833 * @param dirty True if calling this method should dirty the current layer 834 */ 835 void drawTextureMesh(float left, float top, float right, float bottom, GLuint texture, 836 float alpha, SkXfermode::Mode mode, bool blend, 837 GLvoid* vertices, GLvoid* texCoords, GLenum drawMode, GLsizei elementsCount, 838 bool swapSrcDst = false, bool ignoreTransform = false, GLuint vbo = 0, 839 bool ignoreScale = false, bool dirty = true); 840 841 void drawIndexedTextureMesh(float left, float top, float right, float bottom, GLuint texture, 842 float alpha, SkXfermode::Mode mode, bool blend, 843 GLvoid* vertices, GLvoid* texCoords, GLenum drawMode, GLsizei elementsCount, 844 bool swapSrcDst = false, bool ignoreTransform = false, GLuint vbo = 0, 845 bool ignoreScale = false, bool dirty = true); 846 847 void drawAlpha8TextureMesh(float left, float top, float right, float bottom, 848 GLuint texture, bool hasColor, int color, int alpha, SkXfermode::Mode mode, 849 GLvoid* vertices, GLvoid* texCoords, GLenum drawMode, GLsizei elementsCount, 850 bool ignoreTransform, bool ignoreScale = false, bool dirty = true); 851 852 /** 853 * Draws the specified list of vertices as quads using indexed GL_TRIANGLES. 854 * If the number of vertices to draw exceeds the number of indices we have 855 * pre-allocated, this method will generate several glDrawElements() calls. 856 */ 857 void drawIndexedQuads(Vertex* mesh, GLsizei quadsCount); 858 859 /** 860 * Draws text underline and strike-through if needed. 861 * 862 * @param text The text to decor 863 * @param bytesCount The number of bytes in the text 864 * @param totalAdvance The total advance in pixels, defines underline/strikethrough length 865 * @param x The x coordinate where the text will be drawn 866 * @param y The y coordinate where the text will be drawn 867 * @param paint The paint to draw the text with 868 */ 869 void drawTextDecorations(const char* text, int bytesCount, float totalAdvance, 870 float x, float y, SkPaint* paint); 871 872 /** 873 * Draws shadow layer on text (with optional positions). 874 * 875 * @param paint The paint to draw the shadow with 876 * @param text The text to draw 877 * @param bytesCount The number of bytes in the text 878 * @param count The number of glyphs in the text 879 * @param positions The x, y positions of individual glyphs (or NULL) 880 * @param fontRenderer The font renderer object 881 * @param alpha The alpha value for drawing the shadow 882 * @param mode The xfermode for drawing the shadow 883 * @param x The x coordinate where the shadow will be drawn 884 * @param y The y coordinate where the shadow will be drawn 885 */ 886 void drawTextShadow(SkPaint* paint, const char* text, int bytesCount, int count, 887 const float* positions, FontRenderer& fontRenderer, int alpha, SkXfermode::Mode mode, 888 float x, float y); 889 890 /** 891 * Draws a path texture. Path textures are alpha8 bitmaps that need special 892 * compositing to apply colors/filters/etc. 893 * 894 * @param texture The texture to render 895 * @param x The x coordinate where the texture will be drawn 896 * @param y The y coordinate where the texture will be drawn 897 * @param paint The paint to draw the texture with 898 */ 899 void drawPathTexture(const PathTexture* texture, float x, float y, SkPaint* paint); 900 901 /** 902 * Resets the texture coordinates stored in mMeshVertices. Setting the values 903 * back to default is achieved by calling: 904 * 905 * resetDrawTextureTexCoords(0.0f, 0.0f, 1.0f, 1.0f); 906 * 907 * @param u1 The left coordinate of the texture 908 * @param v1 The bottom coordinate of the texture 909 * @param u2 The right coordinate of the texture 910 * @param v2 The top coordinate of the texture 911 */ 912 void resetDrawTextureTexCoords(float u1, float v1, float u2, float v2); 913 914 /** 915 * Returns true if the specified paint will draw invisible text. 916 */ 917 bool canSkipText(const SkPaint* paint) const; 918 919 /** 920 * Binds the specified texture. The texture unit must have been selected 921 * prior to calling this method. 922 */ 923 inline void bindTexture(GLuint texture) { 924 mCaches.bindTexture(texture); 925 } 926 927 /** 928 * Binds the specified EGLImage texture. The texture unit must have been selected 929 * prior to calling this method. 930 */ 931 inline void bindExternalTexture(GLuint texture) { 932 mCaches.bindTexture(GL_TEXTURE_EXTERNAL_OES, texture); 933 } 934 935 /** 936 * Enable or disable blending as necessary. This function sets the appropriate 937 * blend function based on the specified xfermode. 938 */ 939 inline void chooseBlending(bool blend, SkXfermode::Mode mode, ProgramDescription& description, 940 bool swapSrcDst = false); 941 942 /** 943 * Use the specified program with the current GL context. If the program is already 944 * in use, it will not be bound again. If it is not in use, the current program is 945 * marked unused and the specified program becomes used and becomes the new 946 * current program. 947 * 948 * @param program The program to use 949 * 950 * @return true If the specified program was already in use, false otherwise. 951 */ 952 inline bool useProgram(Program* program); 953 954 /** 955 * Invoked before any drawing operation. This sets required state. 956 */ 957 void setupDraw(bool clear = true); 958 959 /** 960 * Various methods to setup OpenGL rendering. 961 */ 962 void setupDrawWithTexture(bool isAlpha8 = false); 963 void setupDrawWithTextureAndColor(bool isAlpha8 = false); 964 void setupDrawWithExternalTexture(); 965 void setupDrawNoTexture(); 966 void setupDrawAA(); 967 void setupDrawColor(int color, int alpha); 968 void setupDrawColor(float r, float g, float b, float a); 969 void setupDrawAlpha8Color(int color, int alpha); 970 void setupDrawTextGamma(const SkPaint* paint); 971 void setupDrawShader(); 972 void setupDrawColorFilter(); 973 void setupDrawBlending(SkXfermode::Mode mode = SkXfermode::kSrcOver_Mode, 974 bool swapSrcDst = false); 975 void setupDrawBlending(bool blend = true, SkXfermode::Mode mode = SkXfermode::kSrcOver_Mode, 976 bool swapSrcDst = false); 977 void setupDrawProgram(); 978 void setupDrawDirtyRegionsDisabled(); 979 void setupDrawModelViewIdentity(bool offset = false); 980 void setupDrawModelView(float left, float top, float right, float bottom, 981 bool ignoreTransform = false, bool ignoreModelView = false); 982 void setupDrawModelViewTranslate(float left, float top, float right, float bottom, 983 bool ignoreTransform = false); 984 void setupDrawColorUniforms(); 985 void setupDrawPureColorUniforms(); 986 void setupDrawShaderIdentityUniforms(); 987 void setupDrawShaderUniforms(bool ignoreTransform = false); 988 void setupDrawColorFilterUniforms(); 989 void setupDrawSimpleMesh(); 990 void setupDrawTexture(GLuint texture); 991 void setupDrawExternalTexture(GLuint texture); 992 void setupDrawTextureTransform(); 993 void setupDrawTextureTransformUniforms(mat4& transform); 994 void setupDrawTextGammaUniforms(); 995 void setupDrawMesh(GLvoid* vertices, GLvoid* texCoords = NULL, GLuint vbo = 0); 996 void setupDrawMesh(GLvoid* vertices, GLvoid* texCoords, GLvoid* colors); 997 void setupDrawMeshIndices(GLvoid* vertices, GLvoid* texCoords, GLuint vbo = 0); 998 void setupDrawIndexedVertices(GLvoid* vertices); 999 void finishDrawTexture(); 1000 void accountForClear(SkXfermode::Mode mode); 1001 1002 bool updateLayer(Layer* layer, bool inFrame); 1003 void updateLayers(); 1004 void flushLayers(); 1005 1006 /** 1007 * Renders the specified region as a series of rectangles. This method 1008 * is used for debugging only. 1009 */ 1010 void drawRegionRects(const Region& region); 1011 1012 /** 1013 * Renders the specified region as a series of rectangles. The region 1014 * must be in screen-space coordinates. 1015 */ 1016 void drawRegionRects(const SkRegion& region, int color, SkXfermode::Mode mode, 1017 bool dirty = false); 1018 1019 /** 1020 * Draws the current clip region if any. Only when DEBUG_CLIP_REGIONS 1021 * is turned on. 1022 */ 1023 void debugClip(); 1024 1025 void debugOverdraw(bool enable, bool clear); 1026 void renderOverdraw(); 1027 void countOverdraw(); 1028 1029 /** 1030 * Should be invoked every time the glScissor is modified. 1031 */ 1032 inline void dirtyClip() { 1033 mDirtyClip = true; 1034 } 1035 1036 inline mat4& currentTransform() const { 1037 return *mSnapshot->transform; 1038 } 1039 1040 inline const UvMapper& getMapper(const Texture* texture) { 1041 return texture && texture->uvMapper ? *texture->uvMapper : mUvMapper; 1042 } 1043 1044 /** 1045 * Returns a texture object for the specified bitmap. The texture can 1046 * come from the texture cache or an atlas. If this method returns 1047 * NULL, the texture could not be found and/or allocated. 1048 */ 1049 Texture* getTexture(SkBitmap* bitmap); 1050 1051 // Dimensions of the drawing surface 1052 int mWidth, mHeight; 1053 1054 // Matrix used for ortho projection in shaders 1055 mat4 mOrthoMatrix; 1056 1057 // Model-view matrix used to position/size objects 1058 mat4 mModelView; 1059 1060 // Number of saved states 1061 int mSaveCount; 1062 // Base state 1063 sp<Snapshot> mFirstSnapshot; 1064 // Current state 1065 sp<Snapshot> mSnapshot; 1066 // State used to define the clipping region 1067 Rect mTilingClip; 1068 // Is the target render surface opaque 1069 bool mOpaque; 1070 // Is a frame currently being rendered 1071 bool mFrameStarted; 1072 1073 // Used to draw textured quads 1074 TextureVertex mMeshVertices[4]; 1075 1076 // Default UV mapper 1077 const UvMapper mUvMapper; 1078 1079 // shader, filters, and shadow 1080 DrawModifiers mDrawModifiers; 1081 SkPaint mFilteredPaint; 1082 1083 // Various caches 1084 Caches& mCaches; 1085 Extensions& mExtensions; 1086 1087 // List of rectangles to clear after saveLayer() is invoked 1088 Vector<Rect*> mLayers; 1089 // List of functors to invoke after a frame is drawn 1090 SortedVector<Functor*> mFunctors; 1091 // List of layers to update at the beginning of a frame 1092 Vector<Layer*> mLayerUpdates; 1093 1094 // Indicates whether the clip must be restored 1095 bool mDirtyClip; 1096 1097 // The following fields are used to setup drawing 1098 // Used to describe the shaders to generate 1099 ProgramDescription mDescription; 1100 // Color description 1101 bool mColorSet; 1102 float mColorA, mColorR, mColorG, mColorB; 1103 // Indicates that the shader should get a color 1104 bool mSetShaderColor; 1105 // Current texture unit 1106 GLuint mTextureUnit; 1107 // Track dirty regions, true by default 1108 bool mTrackDirtyRegions; 1109 // Indicate whether we are drawing an opaque frame 1110 bool mOpaqueFrame; 1111 1112 // See PROPERTY_DISABLE_SCISSOR_OPTIMIZATION in 1113 // Properties.h 1114 bool mScissorOptimizationDisabled; 1115 1116 // No-ops start/endTiling when set 1117 bool mSuppressTiling; 1118 1119 // If true, this renderer will setup drawing to emulate 1120 // an increment stencil buffer in the color buffer 1121 bool mCountOverdraw; 1122 float mOverdraw; 1123 1124 // Optional name of the renderer 1125 String8 mName; 1126 1127 friend class DisplayListRenderer; 1128 friend class Layer; 1129 friend class TextSetupFunctor; 1130 friend class DrawBitmapOp; 1131 friend class DrawPatchOp; 1132 1133}; // class OpenGLRenderer 1134 1135}; // namespace uirenderer 1136}; // namespace android 1137 1138#endif // ANDROID_HWUI_OPENGL_RENDERER_H 1139