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