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