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