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