OpenGLRenderer.h revision 03c00b5a135e68d22ca5bb829b899ebda6ed7e9d
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, int bitmapCount, TextureVertex* vertices, 292 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 /** 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(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 /** 476 * Compose the layer defined in the current snapshot with the layer 477 * defined by the previous snapshot. 478 * 479 * The current snapshot *must* be a layer (flag kFlagIsLayer set.) 480 * 481 * @param curent The current snapshot containing the layer to compose 482 * @param previous The previous snapshot to compose the current layer with 483 */ 484 virtual void composeLayer(sp<Snapshot> current, sp<Snapshot> previous); 485 486 /** 487 * Marks the specified region as dirty at the specified bounds. 488 */ 489 void dirtyLayerUnchecked(Rect& bounds, Region* region); 490 491 /** 492 * Returns the current snapshot. 493 */ 494 sp<Snapshot> getSnapshot() const { 495 return mSnapshot; 496 } 497 498 /** 499 * Returns the region of the current layer. 500 */ 501 virtual Region* getRegion() const { 502 return mSnapshot->region; 503 } 504 505 /** 506 * Indicates whether rendering is currently targeted at a layer. 507 */ 508 virtual bool hasLayer() const { 509 return (mSnapshot->flags & Snapshot::kFlagFboTarget) && mSnapshot->region; 510 } 511 512 /** 513 * Returns the name of the FBO this renderer is rendering into. 514 */ 515 virtual GLint getTargetFbo() const { 516 return 0; 517 } 518 519 /** 520 * Renders the specified layer as a textured quad. 521 * 522 * @param layer The layer to render 523 * @param rect The bounds of the layer 524 */ 525 void drawTextureLayer(Layer* layer, const Rect& rect); 526 527 /** 528 * Gets the alpha and xfermode out of a paint object. If the paint is null 529 * alpha will be 255 and the xfermode will be SRC_OVER. Accounts for both 530 * snapshot alpha, and overrideLayerAlpha 531 * 532 * @param paint The paint to extract values from 533 * @param alpha Where to store the resulting alpha 534 * @param mode Where to store the resulting xfermode 535 */ 536 inline void getAlphaAndMode(SkPaint* paint, int* alpha, SkXfermode::Mode* mode) const; 537 538 /** 539 * Gets the alpha from a layer, accounting for snapshot alpha and overrideLayerAlpha 540 * 541 * @param layer The layer from which the alpha is extracted 542 */ 543 inline float getLayerAlpha(Layer* layer) const; 544 545 /** 546 * Safely retrieves the mode from the specified xfermode. If the specified 547 * xfermode is null, the mode is assumed to be SkXfermode::kSrcOver_Mode. 548 */ 549 static inline SkXfermode::Mode getXfermode(SkXfermode* mode) { 550 SkXfermode::Mode resultMode; 551 if (!SkXfermode::AsMode(mode, &resultMode)) { 552 resultMode = SkXfermode::kSrcOver_Mode; 553 } 554 return resultMode; 555 } 556 557 /** 558 * Set to true to suppress error checks at the end of a frame. 559 */ 560 virtual bool suppressErrorChecks() const { 561 return false; 562 } 563 564private: 565 /** 566 * Discards the content of the framebuffer if supported by the driver. 567 * This method should be called at the beginning of a frame to optimize 568 * rendering on some tiler architectures. 569 */ 570 void discardFramebuffer(float left, float top, float right, float bottom); 571 572 /** 573 * Ensures the state of the renderer is the same as the state of 574 * the GL context. 575 */ 576 void syncState(); 577 578 /** 579 * Tells the GPU what part of the screen is about to be redrawn. 580 * This method will use the clip rect that we started drawing the 581 * frame with. 582 * This method needs to be invoked every time getTargetFbo() is 583 * bound again. 584 */ 585 void startTiling(const sp<Snapshot>& snapshot, bool opaque = false); 586 587 /** 588 * Tells the GPU what part of the screen is about to be redrawn. 589 * This method needs to be invoked every time getTargetFbo() is 590 * bound again. 591 */ 592 void startTiling(const Rect& clip, int windowHeight, bool opaque = false); 593 594 /** 595 * Tells the GPU that we are done drawing the frame or that we 596 * are switching to another render target. 597 */ 598 void endTiling(); 599 600 /** 601 * Saves the current state of the renderer as a new snapshot. 602 * The new snapshot is saved in mSnapshot and the previous snapshot 603 * is linked from mSnapshot->previous. 604 * 605 * @param flags The save flags; see SkCanvas for more information 606 * 607 * @return The new save count. This value can be passed to #restoreToCount() 608 */ 609 int saveSnapshot(int flags); 610 611 /** 612 * Restores the current snapshot; mSnapshot becomes mSnapshot->previous. 613 * 614 * @return True if the clip was modified. 615 */ 616 bool restoreSnapshot(); 617 618 /** 619 * Sets the clipping rectangle using glScissor. The clip is defined by 620 * the current snapshot's clipRect member. 621 */ 622 void setScissorFromClip(); 623 624 /** 625 * Sets the clipping region using the stencil buffer. The clip region 626 * is defined by the current snapshot's clipRegion member. 627 */ 628 void setStencilFromClip(); 629 630 /** 631 * Given the local bounds of the layer, calculates ... 632 */ 633 void calculateLayerBoundsAndClip(Rect& bounds, Rect& clip, bool fboLayer); 634 635 /** 636 * Given the local bounds + clip of the layer, updates current snapshot's empty/invisible 637 */ 638 void updateSnapshotIgnoreForLayer(const Rect& bounds, const Rect& clip, 639 bool fboLayer, int alpha); 640 641 /** 642 * Creates a new layer stored in the specified snapshot. 643 * 644 * @param snapshot The snapshot associated with the new layer 645 * @param left The left coordinate of the layer 646 * @param top The top coordinate of the layer 647 * @param right The right coordinate of the layer 648 * @param bottom The bottom coordinate of the layer 649 * @param alpha The translucency of the layer 650 * @param mode The blending mode of the layer 651 * @param flags The layer save flags 652 * @param previousFbo The name of the current framebuffer 653 * 654 * @return True if the layer was successfully created, false otherwise 655 */ 656 bool createLayer(float left, float top, float right, float bottom, 657 int alpha, SkXfermode::Mode mode, int flags, GLuint previousFbo); 658 659 /** 660 * Creates a new layer stored in the specified snapshot as an FBO. 661 * 662 * @param layer The layer to store as an FBO 663 * @param snapshot The snapshot associated with the new layer 664 * @param bounds The bounds of the layer 665 * @param previousFbo The name of the current framebuffer 666 */ 667 bool createFboLayer(Layer* layer, Rect& bounds, Rect& clip, GLuint previousFbo); 668 669 /** 670 * Compose the specified layer as a region. 671 * 672 * @param layer The layer to compose 673 * @param rect The layer's bounds 674 */ 675 void composeLayerRegion(Layer* layer, const Rect& rect); 676 677 /** 678 * Compose the specified layer as a simple rectangle. 679 * 680 * @param layer The layer to compose 681 * @param rect The layer's bounds 682 * @param swap If true, the source and destination are swapped 683 */ 684 void composeLayerRect(Layer* layer, const Rect& rect, bool swap = false); 685 686 /** 687 * Clears all the regions corresponding to the current list of layers. 688 * This method MUST be invoked before any drawing operation. 689 */ 690 void clearLayerRegions(); 691 692 /** 693 * Mark the layer as dirty at the specified coordinates. The coordinates 694 * are transformed with the supplied matrix. 695 */ 696 void dirtyLayer(const float left, const float top, 697 const float right, const float bottom, const mat4 transform); 698 699 /** 700 * Mark the layer as dirty at the specified coordinates. 701 */ 702 void dirtyLayer(const float left, const float top, 703 const float right, const float bottom); 704 705 /** 706 * Draws a colored rectangle with the specified color. The specified coordinates 707 * are transformed by the current snapshot's transform matrix unless specified 708 * otherwise. 709 * 710 * @param left The left coordinate of the rectangle 711 * @param top The top coordinate of the rectangle 712 * @param right The right coordinate of the rectangle 713 * @param bottom The bottom coordinate of the rectangle 714 * @param color The rectangle's ARGB color, defined as a packed 32 bits word 715 * @param mode The Skia xfermode to use 716 * @param ignoreTransform True if the current transform should be ignored 717 */ 718 void drawColorRect(float left, float top, float right, float bottom, 719 int color, SkXfermode::Mode mode, bool ignoreTransform = false); 720 721 /** 722 * Draws a series of colored rectangles with the specified color. The specified 723 * coordinates are transformed by the current snapshot's transform matrix unless 724 * specified otherwise. 725 * 726 * @param rects A list of rectangles, 4 floats (left, top, right, bottom) 727 * per rectangle 728 * @param color The rectangles' ARGB color, defined as a packed 32 bits word 729 * @param mode The Skia xfermode to use 730 * @param ignoreTransform True if the current transform should be ignored 731 * @param dirty True if calling this method should dirty the current layer 732 * @param clip True if the rects should be clipped, false otherwise 733 */ 734 status_t drawColorRects(const float* rects, int count, int color, 735 SkXfermode::Mode mode, bool ignoreTransform = false, 736 bool dirty = true, bool clip = true); 737 738 /** 739 * Draws the shape represented by the specified path texture. 740 * This method invokes drawPathTexture() but takes into account 741 * the extra left/top offset and the texture offset to correctly 742 * position the final shape. 743 * 744 * @param left The left coordinate of the shape to render 745 * @param top The top coordinate of the shape to render 746 * @param texture The texture reprsenting the shape 747 * @param paint The paint to draw the shape with 748 */ 749 status_t drawShape(float left, float top, const PathTexture* texture, SkPaint* paint); 750 751 /** 752 * Draws the specified texture as an alpha bitmap. Alpha bitmaps obey 753 * different compositing rules. 754 * 755 * @param texture The texture to draw with 756 * @param left The x coordinate of the bitmap 757 * @param top The y coordinate of the bitmap 758 * @param paint The paint to render with 759 */ 760 void drawAlphaBitmap(Texture* texture, float left, float top, SkPaint* paint); 761 762 /** 763 * Renders a strip of polygons with the specified paint, used for tessellated geometry. 764 * 765 * @param vertexBuffer The VertexBuffer to be drawn 766 * @param paint The paint to render with 767 * @param useOffset Offset the vertexBuffer (used in drawing non-AA lines) 768 */ 769 status_t drawVertexBuffer(const VertexBuffer& vertexBuffer, SkPaint* paint, 770 bool useOffset = false); 771 772 /** 773 * Renders the convex hull defined by the specified path as a strip of polygons. 774 * 775 * @param path The hull of the path to draw 776 * @param paint The paint to render with 777 */ 778 status_t drawConvexPath(const SkPath& path, SkPaint* paint); 779 780 /** 781 * Draws a textured rectangle with the specified texture. The specified coordinates 782 * are transformed by the current snapshot's transform matrix. 783 * 784 * @param left The left coordinate of the rectangle 785 * @param top The top coordinate of the rectangle 786 * @param right The right coordinate of the rectangle 787 * @param bottom The bottom coordinate of the rectangle 788 * @param texture The texture name to map onto the rectangle 789 * @param alpha An additional translucency parameter, between 0.0f and 1.0f 790 * @param mode The blending mode 791 * @param blend True if the texture contains an alpha channel 792 */ 793 void drawTextureRect(float left, float top, float right, float bottom, GLuint texture, 794 float alpha, SkXfermode::Mode mode, bool blend); 795 796 /** 797 * Draws a textured rectangle with the specified texture. The specified coordinates 798 * are transformed by the current snapshot's transform matrix. 799 * 800 * @param left The left coordinate of the rectangle 801 * @param top The top coordinate of the rectangle 802 * @param right The right coordinate of the rectangle 803 * @param bottom The bottom coordinate of the rectangle 804 * @param texture The texture to use 805 * @param paint The paint containing the alpha, blending mode, etc. 806 */ 807 void drawTextureRect(float left, float top, float right, float bottom, 808 Texture* texture, SkPaint* paint); 809 810 /** 811 * Draws a textured mesh with the specified texture. If the indices are omitted, 812 * the mesh is drawn as a simple quad. The mesh pointers become offsets when a 813 * VBO is bound. 814 * 815 * @param left The left coordinate of the rectangle 816 * @param top The top coordinate of the rectangle 817 * @param right The right coordinate of the rectangle 818 * @param bottom The bottom coordinate of the rectangle 819 * @param texture The texture name to map onto the rectangle 820 * @param alpha An additional translucency parameter, between 0.0f and 1.0f 821 * @param mode The blending mode 822 * @param blend True if the texture contains an alpha channel 823 * @param vertices The vertices that define the mesh 824 * @param texCoords The texture coordinates of each vertex 825 * @param elementsCount The number of elements in the mesh, required by indices 826 * @param swapSrcDst Whether or not the src and dst blending operations should be swapped 827 * @param ignoreTransform True if the current transform should be ignored 828 * @param vbo The VBO used to draw the mesh 829 * @param ignoreScale True if the model view matrix should not be scaled 830 * @param dirty True if calling this method should dirty the current layer 831 */ 832 void drawTextureMesh(float left, float top, float right, float bottom, GLuint texture, 833 float alpha, SkXfermode::Mode mode, bool blend, 834 GLvoid* vertices, GLvoid* texCoords, GLenum drawMode, GLsizei elementsCount, 835 bool swapSrcDst = false, bool ignoreTransform = false, GLuint vbo = 0, 836 bool ignoreScale = false, bool dirty = true); 837 838 void drawIndexedTextureMesh(float left, float top, float right, float bottom, GLuint texture, 839 float alpha, SkXfermode::Mode mode, bool blend, 840 GLvoid* vertices, GLvoid* texCoords, GLenum drawMode, GLsizei elementsCount, 841 bool swapSrcDst = false, bool ignoreTransform = false, GLuint vbo = 0, 842 bool ignoreScale = false, bool dirty = true); 843 844 void drawAlpha8TextureMesh(float left, float top, float right, float bottom, 845 GLuint texture, bool hasColor, int color, int alpha, SkXfermode::Mode mode, 846 GLvoid* vertices, GLvoid* texCoords, GLenum drawMode, GLsizei elementsCount, 847 bool ignoreTransform, bool ignoreScale = false, bool dirty = true); 848 849 /** 850 * Draws text underline and strike-through if needed. 851 * 852 * @param text The text to decor 853 * @param bytesCount The number of bytes in the text 854 * @param totalAdvance The total advance in pixels, defines underline/strikethrough length 855 * @param x The x coordinate where the text will be drawn 856 * @param y The y coordinate where the text will be drawn 857 * @param paint The paint to draw the text with 858 */ 859 void drawTextDecorations(const char* text, int bytesCount, float totalAdvance, 860 float x, float y, SkPaint* paint); 861 862 /** 863 * Draws shadow layer on text (with optional positions). 864 * 865 * @param paint The paint to draw the shadow with 866 * @param text The text to draw 867 * @param bytesCount The number of bytes in the text 868 * @param count The number of glyphs in the text 869 * @param positions The x, y positions of individual glyphs (or NULL) 870 * @param fontRenderer The font renderer object 871 * @param alpha The alpha value for drawing the shadow 872 * @param mode The xfermode for drawing the shadow 873 * @param x The x coordinate where the shadow will be drawn 874 * @param y The y coordinate where the shadow will be drawn 875 */ 876 void drawTextShadow(SkPaint* paint, const char* text, int bytesCount, int count, 877 const float* positions, FontRenderer& fontRenderer, int alpha, SkXfermode::Mode mode, 878 float x, float y); 879 880 /** 881 * Draws a path texture. Path textures are alpha8 bitmaps that need special 882 * compositing to apply colors/filters/etc. 883 * 884 * @param texture The texture to render 885 * @param x The x coordinate where the texture will be drawn 886 * @param y The y coordinate where the texture will be drawn 887 * @param paint The paint to draw the texture with 888 */ 889 void drawPathTexture(const PathTexture* texture, float x, float y, SkPaint* paint); 890 891 /** 892 * Resets the texture coordinates stored in mMeshVertices. Setting the values 893 * back to default is achieved by calling: 894 * 895 * resetDrawTextureTexCoords(0.0f, 0.0f, 1.0f, 1.0f); 896 * 897 * @param u1 The left coordinate of the texture 898 * @param v1 The bottom coordinate of the texture 899 * @param u2 The right coordinate of the texture 900 * @param v2 The top coordinate of the texture 901 */ 902 void resetDrawTextureTexCoords(float u1, float v1, float u2, float v2); 903 904 /** 905 * Returns true if the specified paint will draw invisible text. 906 */ 907 bool canSkipText(const SkPaint* paint) const; 908 909 /** 910 * Binds the specified texture. The texture unit must have been selected 911 * prior to calling this method. 912 */ 913 inline void bindTexture(GLuint texture) { 914 mCaches.bindTexture(texture); 915 } 916 917 /** 918 * Binds the specified EGLImage texture. The texture unit must have been selected 919 * prior to calling this method. 920 */ 921 inline void bindExternalTexture(GLuint texture) { 922 mCaches.bindTexture(GL_TEXTURE_EXTERNAL_OES, texture); 923 } 924 925 /** 926 * Enable or disable blending as necessary. This function sets the appropriate 927 * blend function based on the specified xfermode. 928 */ 929 inline void chooseBlending(bool blend, SkXfermode::Mode mode, ProgramDescription& description, 930 bool swapSrcDst = false); 931 932 /** 933 * Use the specified program with the current GL context. If the program is already 934 * in use, it will not be bound again. If it is not in use, the current program is 935 * marked unused and the specified program becomes used and becomes the new 936 * current program. 937 * 938 * @param program The program to use 939 * 940 * @return true If the specified program was already in use, false otherwise. 941 */ 942 inline bool useProgram(Program* program); 943 944 /** 945 * Invoked before any drawing operation. This sets required state. 946 */ 947 void setupDraw(bool clear = true); 948 949 /** 950 * Various methods to setup OpenGL rendering. 951 */ 952 void setupDrawWithTexture(bool isAlpha8 = false); 953 void setupDrawWithTextureAndColor(bool isAlpha8 = false); 954 void setupDrawWithExternalTexture(); 955 void setupDrawNoTexture(); 956 void setupDrawAA(); 957 void setupDrawColor(int color, int alpha); 958 void setupDrawColor(float r, float g, float b, float a); 959 void setupDrawAlpha8Color(int color, int alpha); 960 void setupDrawTextGamma(const SkPaint* paint); 961 void setupDrawShader(); 962 void setupDrawColorFilter(); 963 void setupDrawBlending(SkXfermode::Mode mode = SkXfermode::kSrcOver_Mode, 964 bool swapSrcDst = false); 965 void setupDrawBlending(bool blend = true, SkXfermode::Mode mode = SkXfermode::kSrcOver_Mode, 966 bool swapSrcDst = false); 967 void setupDrawProgram(); 968 void setupDrawDirtyRegionsDisabled(); 969 void setupDrawModelViewIdentity(bool offset = false); 970 void setupDrawModelView(float left, float top, float right, float bottom, 971 bool ignoreTransform = false, bool ignoreModelView = false); 972 void setupDrawModelViewTranslate(float left, float top, float right, float bottom, 973 bool ignoreTransform = false); 974 void setupDrawColorUniforms(); 975 void setupDrawPureColorUniforms(); 976 void setupDrawShaderIdentityUniforms(); 977 void setupDrawShaderUniforms(bool ignoreTransform = false); 978 void setupDrawColorFilterUniforms(); 979 void setupDrawSimpleMesh(); 980 void setupDrawTexture(GLuint texture); 981 void setupDrawExternalTexture(GLuint texture); 982 void setupDrawTextureTransform(); 983 void setupDrawTextureTransformUniforms(mat4& transform); 984 void setupDrawTextGammaUniforms(); 985 void setupDrawMesh(GLvoid* vertices, GLvoid* texCoords = NULL, GLuint vbo = 0); 986 void setupDrawMesh(GLvoid* vertices, GLvoid* texCoords, GLvoid* colors); 987 void setupDrawMeshIndices(GLvoid* vertices, GLvoid* texCoords, GLuint vbo = 0); 988 void setupDrawVertices(GLvoid* vertices); 989 void finishDrawTexture(); 990 void accountForClear(SkXfermode::Mode mode); 991 992 bool updateLayer(Layer* layer, bool inFrame); 993 void updateLayers(); 994 void flushLayers(); 995 996 /** 997 * Renders the specified region as a series of rectangles. This method 998 * is used for debugging only. 999 */ 1000 void drawRegionRects(const Region& region); 1001 1002 /** 1003 * Renders the specified region as a series of rectangles. The region 1004 * must be in screen-space coordinates. 1005 */ 1006 void drawRegionRects(const SkRegion& region, int color, SkXfermode::Mode mode, 1007 bool dirty = false); 1008 1009 /** 1010 * Draws the current clip region if any. Only when DEBUG_CLIP_REGIONS 1011 * is turned on. 1012 */ 1013 void debugClip(); 1014 1015 void debugOverdraw(bool enable, bool clear); 1016 void renderOverdraw(); 1017 void countOverdraw(); 1018 1019 /** 1020 * Should be invoked every time the glScissor is modified. 1021 */ 1022 inline void dirtyClip() { 1023 mDirtyClip = true; 1024 } 1025 1026 inline mat4& currentTransform() const { 1027 return *mSnapshot->transform; 1028 } 1029 1030 inline const UvMapper& getMapper(const Texture* texture) { 1031 return texture && texture->uvMapper ? *texture->uvMapper : mUvMapper; 1032 } 1033 1034 /** 1035 * Returns a texture object for the specified bitmap. The texture can 1036 * come from the texture cache or an atlas. If this method returns 1037 * NULL, the texture could not be found and/or allocated. 1038 */ 1039 Texture* getTexture(SkBitmap* bitmap); 1040 1041 // Dimensions of the drawing surface 1042 int mWidth, mHeight; 1043 1044 // Matrix used for ortho projection in shaders 1045 mat4 mOrthoMatrix; 1046 1047 // Model-view matrix used to position/size objects 1048 mat4 mModelView; 1049 1050 // Number of saved states 1051 int mSaveCount; 1052 // Base state 1053 sp<Snapshot> mFirstSnapshot; 1054 // Current state 1055 sp<Snapshot> mSnapshot; 1056 // State used to define the clipping region 1057 Rect mTilingClip; 1058 // Is the target render surface opaque 1059 bool mOpaque; 1060 // Is a frame currently being rendered 1061 bool mFrameStarted; 1062 1063 // Used to draw textured quads 1064 TextureVertex mMeshVertices[4]; 1065 1066 // Default UV mapper 1067 const UvMapper mUvMapper; 1068 1069 // shader, filters, and shadow 1070 DrawModifiers mDrawModifiers; 1071 SkPaint mFilteredPaint; 1072 1073 // Various caches 1074 Caches& mCaches; 1075 Extensions& mExtensions; 1076 1077 // List of rectangles to clear after saveLayer() is invoked 1078 Vector<Rect*> mLayers; 1079 // List of functors to invoke after a frame is drawn 1080 SortedVector<Functor*> mFunctors; 1081 // List of layers to update at the beginning of a frame 1082 Vector<Layer*> mLayerUpdates; 1083 1084 // Indicates whether the clip must be restored 1085 bool mDirtyClip; 1086 1087 // The following fields are used to setup drawing 1088 // Used to describe the shaders to generate 1089 ProgramDescription mDescription; 1090 // Color description 1091 bool mColorSet; 1092 float mColorA, mColorR, mColorG, mColorB; 1093 // Indicates that the shader should get a color 1094 bool mSetShaderColor; 1095 // Current texture unit 1096 GLuint mTextureUnit; 1097 // Track dirty regions, true by default 1098 bool mTrackDirtyRegions; 1099 // Indicate whether we are drawing an opaque frame 1100 bool mOpaqueFrame; 1101 1102 // See PROPERTY_DISABLE_SCISSOR_OPTIMIZATION in 1103 // Properties.h 1104 bool mScissorOptimizationDisabled; 1105 1106 // No-ops start/endTiling when set 1107 bool mSuppressTiling; 1108 1109 // If true, this renderer will setup drawing to emulate 1110 // an increment stencil buffer in the color buffer 1111 bool mCountOverdraw; 1112 float mOverdraw; 1113 1114 // Optional name of the renderer 1115 String8 mName; 1116 1117 friend class DisplayListRenderer; 1118 friend class Layer; 1119 friend class TextSetupFunctor; 1120 friend class DrawBitmapOp; 1121 friend class DrawPatchOp; 1122 1123}; // class OpenGLRenderer 1124 1125}; // namespace uirenderer 1126}; // namespace android 1127 1128#endif // ANDROID_HWUI_OPENGL_RENDERER_H 1129