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