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