libs/hwui/OpenGLRenderer.h

   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 "CanvasState.h"
  21 #include "Debug.h"
  22 #include "Extensions.h"
  23 #include "Matrix.h"
  24 #include "Program.h"
  25 #include "Rect.h"
  26 #include "Snapshot.h"
  27 #include "UvMapper.h"
  28 #include "Vertex.h"
  29 #include "Caches.h"
  30 #include "utils/PaintUtils.h"
  31
  32 #include <GLES2/gl2.h>
  33 #include <GLES2/gl2ext.h>
  34
  35 #include <SkBitmap.h>
  36 #include <SkCanvas.h>
  37 #include <SkColorFilter.h>
  38 #include <SkMatrix.h>
  39 #include <SkPaint.h>
  40 #include <SkRegion.h>
  41 #include <SkXfermode.h>
  42
  43 #include <utils/Blur.h>
  44 #include <utils/Functor.h>
  45 #include <utils/RefBase.h>
  46 #include <utils/SortedVector.h>
  47 #include <utils/Vector.h>
  48
  49 #include <cutils/compiler.h>
  50
  51 #include <androidfw/ResourceTypes.h>
  52
  53 class SkShader;
  54
  55 namespace android {
  56 namespace uirenderer {
  57
  58 enum class DrawOpMode {
  59     kImmediate,
  60     kDefer,
  61     kFlush
  62 };
  63
  64 class DeferredDisplayState;
  65 struct Glop;
  66 class RenderState;
  67 class RenderNode;
  68 class TextSetupFunctor;
  69 class VertexBuffer;
  70
  71 struct DrawModifiers {
  72     DrawModifiers()
  73         : mOverrideLayerAlpha(0.0f) {}
  74
  75     void reset() {
  76         mOverrideLayerAlpha = 0.0f;
  77     }
  78
  79     float mOverrideLayerAlpha;
  80 };
  81
  82 enum StateDeferFlags {
  83     kStateDeferFlag_Draw = 0x1,
  84     kStateDeferFlag_Clip = 0x2
  85 };
  86
  87 enum ClipSideFlags {
  88     kClipSide_None = 0x0,
  89     kClipSide_Left = 0x1,
  90     kClipSide_Top = 0x2,
  91     kClipSide_Right = 0x4,
  92     kClipSide_Bottom = 0x8,
  93     kClipSide_Full = 0xF,
  94     kClipSide_ConservativeFull = 0x1F
  95 };
  96
  97 enum VertexBufferDisplayFlags {
  98     kVertexBuffer_Offset = 0x1,
  99     kVertexBuffer_ShadowInterp = 0x2,
 100 };
 101
 102 /**
 103  * Defines additional transformation that should be applied by the model view matrix, beyond that of
 104  * the currentTransform()
 105  */
 106 enum ModelViewMode {
 107     /**
 108      * Used when the model view should simply translate geometry passed to the shader. The resulting
 109      * matrix will be a simple translation.
 110      */
 111     kModelViewMode_Translate = 0,
 112
 113     /**
 114      * Used when the model view should translate and scale geometry. The resulting matrix will be a
 115      * translation + scale. This is frequently used together with VBO 0, the (0,0,1,1) rect.
 116      */
 117     kModelViewMode_TranslateAndScale = 1,
 118 };
 119
 120 ///////////////////////////////////////////////////////////////////////////////
 121 // Renderer
 122 ///////////////////////////////////////////////////////////////////////////////
 123 /**
 124  * OpenGL Renderer implementation.
 125  */
 126 class OpenGLRenderer : public CanvasStateClient {
 127 public:
 128     OpenGLRenderer(RenderState& renderState);
 129     virtual ~OpenGLRenderer();
 130
 131     /**
 132      * Sets the dimension of the underlying drawing surface. This method must
 133      * be called at least once every time the drawing surface changes size.
 134      *
 135      * @param width The width in pixels of the underlysing surface
 136      * @param height The height in pixels of the underlysing surface
 137      */
 138     void setViewport(int width, int height) { mState.setViewport(width, height); }
 139
 140     void initProperties();
 141     void initLight(const Vector3& lightCenter, float lightRadius,
 142             uint8_t ambientShadowAlpha, uint8_t spotShadowAlpha);
 143
 144     /*
 145      * Prepares the renderer to draw a frame. This method must be invoked
 146      * at the beginning of each frame. Only the specified rectangle of the
 147      * frame is assumed to be dirty. A clip will automatically be set to
 148      * the specified rectangle.
 149      *
 150      * @param opaque If true, the target surface is considered opaque
 151      *               and will not be cleared. If false, the target surface
 152      *               will be cleared
 153      */
 154     virtual void prepareDirty(float left, float top, float right, float bottom,
 155             bool opaque);
 156
 157     /**
 158      * Prepares the renderer to draw a frame. This method must be invoked
 159      * at the beginning of each frame. When this method is invoked, the
 160      * entire drawing surface is assumed to be redrawn.
 161      *
 162      * @param opaque If true, the target surface is considered opaque
 163      *               and will not be cleared. If false, the target surface
 164      *               will be cleared
 165      */
 166     void prepare(bool opaque) {
 167         prepareDirty(0.0f, 0.0f, mState.getWidth(), mState.getHeight(), opaque);
 168     }
 169
 170     /**
 171      * Indicates the end of a frame. This method must be invoked whenever
 172      * the caller is done rendering a frame.
 173      * Returns true if any drawing was done during the frame (the output
 174      * has changed / is "dirty" and should be displayed to the user).
 175      */
 176     virtual bool finish();
 177
 178     void callDrawGLFunction(Functor* functor, Rect& dirty);
 179
 180     void pushLayerUpdate(Layer* layer);
 181     void cancelLayerUpdate(Layer* layer);
 182     void flushLayerUpdates();
 183     void markLayersAsBuildLayers();
 184
 185     virtual int saveLayer(float left, float top, float right, float bottom,
 186             const SkPaint* paint, int flags) {
 187         return saveLayer(left, top, right, bottom, paint, flags, nullptr);
 188     }
 189
 190     // Specialized saveLayer implementation, which will pass the convexMask to an FBO layer, if
 191     // created, which will in turn clip to that mask when drawn back/restored.
 192     int saveLayer(float left, float top, float right, float bottom,
 193             const SkPaint* paint, int flags, const SkPath* convexMask);
 194
 195     int saveLayerDeferred(float left, float top, float right, float bottom,
 196             const SkPaint* paint, int flags);
 197
 198     void drawRenderNode(RenderNode* displayList, Rect& dirty, int32_t replayFlags = 1);
 199     void drawLayer(Layer* layer, float x, float y);
 200     void drawBitmap(const SkBitmap* bitmap, const SkPaint* paint);
 201     void drawBitmaps(const SkBitmap* bitmap, AssetAtlas::Entry* entry, int bitmapCount,
 202             TextureVertex* vertices, bool pureTranslate, const Rect& bounds, const SkPaint* paint);
 203     void drawBitmap(const SkBitmap* bitmap, Rect src, Rect dst,
 204             const SkPaint* paint);
 205     void drawBitmapMesh(const SkBitmap* bitmap, int meshWidth, int meshHeight,
 206             const float* vertices, const int* colors, const SkPaint* paint);
 207     void drawPatches(const SkBitmap* bitmap, AssetAtlas::Entry* entry,
 208             TextureVertex* vertices, uint32_t indexCount, const SkPaint* paint);
 209     void drawPatch(const SkBitmap* bitmap, const Patch* mesh, AssetAtlas::Entry* entry,
 210             float left, float top, float right, float bottom, const SkPaint* paint);
 211     void drawColor(int color, SkXfermode::Mode mode);
 212     void drawRect(float left, float top, float right, float bottom,
 213             const SkPaint* paint);
 214     void drawRoundRect(float left, float top, float right, float bottom,
 215             float rx, float ry, const SkPaint* paint);
 216     void drawCircle(float x, float y, float radius, const SkPaint* paint);
 217     void drawOval(float left, float top, float right, float bottom,
 218             const SkPaint* paint);
 219     void drawArc(float left, float top, float right, float bottom,
 220             float startAngle, float sweepAngle, bool useCenter, const SkPaint* paint);
 221     void drawPath(const SkPath* path, const SkPaint* paint);
 222     void drawLines(const float* points, int count, const SkPaint* paint);
 223     void drawPoints(const float* points, int count, const SkPaint* paint);
 224     void drawTextOnPath(const char* text, int bytesCount, int count, const SkPath* path,
 225             float hOffset, float vOffset, const SkPaint* paint);
 226     void drawPosText(const char* text, int bytesCount, int count,
 227             const float* positions, const SkPaint* paint);
 228     void drawText(const char* text, int bytesCount, int count, float x, float y,
 229             const float* positions, const SkPaint* paint, float totalAdvance, const Rect& bounds,
 230             DrawOpMode drawOpMode = DrawOpMode::kImmediate);
 231     void drawRects(const float* rects, int count, const SkPaint* paint);
 232
 233     void drawShadow(float casterAlpha,
 234             const VertexBuffer* ambientShadowVertexBuffer,
 235             const VertexBuffer* spotShadowVertexBuffer);
 236
 237     void setDrawFilter(SkDrawFilter* filter);
 238
 239     // If this value is set to < 1.0, it overrides alpha set on layer (see drawBitmap, drawLayer)
 240     void setOverrideLayerAlpha(float alpha) { mDrawModifiers.mOverrideLayerAlpha = alpha; }
 241
 242     /**
 243      * Store the current display state (most importantly, the current clip and transform), and
 244      * additionally map the state's bounds from local to window coordinates.
 245      *
 246      * Returns true if quick-rejected
 247      */
 248     bool storeDisplayState(DeferredDisplayState& state, int stateDeferFlags);
 249     void restoreDisplayState(const DeferredDisplayState& state, bool skipClipRestore = false);
 250     void setupMergedMultiDraw(const Rect* clipRect);
 251
 252     const DrawModifiers& getDrawModifiers() { return mDrawModifiers; }
 253     void setDrawModifiers(const DrawModifiers& drawModifiers) { mDrawModifiers = drawModifiers; }
 254
 255     bool isCurrentTransformSimple() {
 256         return currentTransform()->isSimple();
 257     }
 258
 259     Caches& getCaches() {
 260         return mCaches;
 261     }
 262
 263     RenderState& renderState() {
 264         return mRenderState;
 265     }
 266
 267     int getViewportWidth() { return mState.getViewportWidth(); }
 268     int getViewportHeight() { return mState.getViewportHeight(); }
 269
 270     /**
 271      * Scales the alpha on the current snapshot. This alpha value will be modulated
 272      * with other alpha values when drawing primitives.
 273      */
 274     void scaleAlpha(float alpha) { mState.scaleAlpha(alpha); }
 275
 276     /**
 277      * Inserts a named event marker in the stream of GL commands.
 278      */
 279     void eventMark(const char* name) const;
 280
 281     /**
 282      * Inserts a formatted event marker in the stream of GL commands.
 283      */
 284     void eventMarkDEBUG(const char *fmt, ...) const;
 285
 286     /**
 287      * Inserts a named group marker in the stream of GL commands. This marker
 288      * can be used by tools to group commands into logical groups. A call to
 289      * this method must always be followed later on by a call to endMark().
 290      */
 291     void startMark(const char* name) const;
 292
 293     /**
 294      * Closes the last group marker opened by startMark().
 295      */
 296     void endMark() const;
 297
 298     /**
 299      * Gets the alpha and xfermode out of a paint object. If the paint is null
 300      * alpha will be 255 and the xfermode will be SRC_OVER. This method does
 301      * not multiply the paint's alpha by the current snapshot's alpha, and does
 302      * not replace the alpha with the overrideLayerAlpha
 303      *
 304      * @param paint The paint to extract values from
 305      * @param alpha Where to store the resulting alpha
 306      * @param mode Where to store the resulting xfermode
 307      */
 308     static inline void getAlphaAndModeDirect(const SkPaint* paint, int* alpha,
 309             SkXfermode::Mode* mode) {
 310         *mode = getXfermodeDirect(paint);
 311         *alpha = getAlphaDirect(paint);
 312     }
 313
 314     static inline SkXfermode::Mode getXfermodeDirect(const SkPaint* paint) {
 315         if (!paint) return SkXfermode::kSrcOver_Mode;
 316         return PaintUtils::getXfermode(paint->getXfermode());
 317     }
 318
 319     static inline int getAlphaDirect(const SkPaint* paint) {
 320         if (!paint) return 255;
 321         return paint->getAlpha();
 322     }
 323
 324     struct TextShadow {
 325         SkScalar radius;
 326         float dx;
 327         float dy;
 328         SkColor color;
 329     };
 330
 331     static inline bool getTextShadow(const SkPaint* paint, TextShadow* textShadow) {
 332         SkDrawLooper::BlurShadowRec blur;
 333         if (paint && paint->getLooper() && paint->getLooper()->asABlurShadow(&blur)) {
 334             if (textShadow) {
 335                 textShadow->radius = Blur::convertSigmaToRadius(blur.fSigma);
 336                 textShadow->dx = blur.fOffset.fX;
 337                 textShadow->dy = blur.fOffset.fY;
 338                 textShadow->color = blur.fColor;
 339             }
 340             return true;
 341         }
 342         return false;
 343     }
 344
 345     static inline bool hasTextShadow(const SkPaint* paint) {
 346         return getTextShadow(paint, nullptr);
 347     }
 348
 349     /**
 350      * Build the best transform to use to rasterize text given a full
 351      * transform matrix, and whether filteration is needed.
 352      *
 353      * Returns whether filtration is needed
 354      */
 355     bool findBestFontTransform(const mat4& transform, SkMatrix* outMatrix) const;
 356
 357 #if DEBUG_MERGE_BEHAVIOR
 358     void drawScreenSpaceColorRect(float left, float top, float right, float bottom, int color) {
 359         mCaches.setScissorEnabled(false);
 360
 361         // should only be called outside of other draw ops, so stencil can only be in test state
 362         bool stencilWasEnabled = mCaches.stencil.isTestEnabled();
 363         mCaches.stencil.disable();
 364
 365         drawColorRect(left, top, right, bottom, color, SkXfermode::kSrcOver_Mode, true);
 366
 367         if (stencilWasEnabled) mCaches.stencil.enableTest();
 368         mDirty = true;
 369     }
 370 #endif
 371
 372     const Vector3& getLightCenter() const { return mState.currentLightCenter(); }
 373     float getLightRadius() const { return mLightRadius; }
 374     uint8_t getAmbientShadowAlpha() const { return mAmbientShadowAlpha; }
 375     uint8_t getSpotShadowAlpha() const { return mSpotShadowAlpha; }
 376
 377     ///////////////////////////////////////////////////////////////////
 378     /// State manipulation
 379
 380     int getSaveCount() const;
 381     int save(int flags);
 382     void restore();
 383     void restoreToCount(int saveCount);
 384
 385     void getMatrix(SkMatrix* outMatrix) const { mState.getMatrix(outMatrix); }
 386     void setMatrix(const SkMatrix& matrix) { mState.setMatrix(matrix); }
 387     void concatMatrix(const SkMatrix& matrix) { mState.concatMatrix(matrix); }
 388
 389     void translate(float dx, float dy, float dz = 0.0f);
 390     void rotate(float degrees);
 391     void scale(float sx, float sy);
 392     void skew(float sx, float sy);
 393
 394     void setMatrix(const Matrix4& matrix); // internal only convenience method
 395     void concatMatrix(const Matrix4& matrix); // internal only convenience method
 396
 397     const Rect& getLocalClipBounds() const { return mState.getLocalClipBounds(); }
 398     const Rect& getRenderTargetClipBounds() const { return mState.getRenderTargetClipBounds(); }
 399     bool quickRejectConservative(float left, float top,
 400             float right, float bottom) const {
 401         return mState.quickRejectConservative(left, top, right, bottom);
 402     }
 403
 404     bool clipRect(float left, float top,
 405             float right, float bottom, SkRegion::Op op);
 406     bool clipPath(const SkPath* path, SkRegion::Op op);
 407     bool clipRegion(const SkRegion* region, SkRegion::Op op);
 408
 409     /**
 410      * Does not support different clipping Ops (that is, every call to setClippingOutline is
 411      * effectively using SkRegion::kReplaceOp)
 412      *
 413      * The clipping outline is independent from the regular clip.
 414      */
 415     void setClippingOutline(LinearAllocator& allocator, const Outline* outline);
 416     void setClippingRoundRect(LinearAllocator& allocator,
 417             const Rect& rect, float radius, bool highPriority = true);
 418
 419     inline bool hasRectToRectTransform() const { return mState.hasRectToRectTransform(); }
 420     inline const mat4* currentTransform() const { return mState.currentTransform(); }
 421
 422     ///////////////////////////////////////////////////////////////////
 423     /// CanvasStateClient interface
 424
 425     virtual void onViewportInitialized() override;
 426     virtual void onSnapshotRestored(const Snapshot& removed, const Snapshot& restored) override;
 427     virtual GLuint getTargetFbo() const override { return 0; }
 428
 429     SkPath* allocPathForFrame() {
 430         std::unique_ptr<SkPath> path(new SkPath());
 431         SkPath* returnPath = path.get();
 432         mTempPaths.push_back(std::move(path));
 433         return returnPath;
 434     }
 435
 436 protected:
 437     /**
 438      * Perform the setup specific to a frame. This method does not
 439      * issue any OpenGL commands.
 440      */
 441     void setupFrameState(float left, float top, float right, float bottom, bool opaque);
 442
 443     /**
 444      * Indicates the start of rendering. This method will setup the
 445      * initial OpenGL state (viewport, clearing the buffer, etc.)
 446      */
 447     void startFrame();
 448
 449     /**
 450      * Clears the underlying surface if needed.
 451      */
 452     virtual void clear(float left, float top, float right, float bottom, bool opaque);
 453
 454     /**
 455      * Call this method after updating a layer during a drawing pass.
 456      */
 457     void resumeAfterLayer();
 458
 459     /**
 460      * This method is called whenever a stencil buffer is required. Subclasses
 461      * should override this method and call attachStencilBufferToLayer() on the
 462      * appropriate layer(s).
 463      */
 464     virtual void ensureStencilBuffer();
 465
 466     /**
 467      * Obtains a stencil render buffer (allocating it if necessary) and
 468      * attaches it to the specified layer.
 469      */
 470     void attachStencilBufferToLayer(Layer* layer);
 471
 472     /**
 473      * Draw a rectangle list. Currently only used for the the stencil buffer so that the stencil
 474      * will have a value of 'n' in every unclipped pixel, where 'n' is the number of rectangles
 475      * in the list.
 476      */
 477     void drawRectangleList(const RectangleList& rectangleList);
 478
 479     bool quickRejectSetupScissor(float left, float top, float right, float bottom,
 480             const SkPaint* paint = nullptr);
 481     bool quickRejectSetupScissor(const Rect& bounds, const SkPaint* paint = nullptr) {
 482         return quickRejectSetupScissor(bounds.left, bounds.top,
 483                 bounds.right, bounds.bottom, paint);
 484     }
 485
 486     /**
 487      * Compose the layer defined in the current snapshot with the layer
 488      * defined by the previous snapshot.
 489      *
 490      * The current snapshot *must* be a layer (flag kFlagIsLayer set.)
 491      *
 492      * @param curent The current snapshot containing the layer to compose
 493      * @param previous The previous snapshot to compose the current layer with
 494      */
 495     virtual void composeLayer(const Snapshot& current, const Snapshot& previous);
 496
 497     /**
 498      * Marks the specified region as dirty at the specified bounds.
 499      */
 500     void dirtyLayerUnchecked(Rect& bounds, Region* region);
 501
 502     /**
 503      * Returns the region of the current layer.
 504      */
 505     virtual Region* getRegion() const {
 506         return mState.currentRegion();
 507     }
 508
 509     /**
 510      * Indicates whether rendering is currently targeted at a layer.
 511      */
 512     virtual bool hasLayer() const {
 513         return (mState.currentFlags() & Snapshot::kFlagFboTarget) && mState.currentRegion();
 514     }
 515
 516     /**
 517      * Renders the specified layer as a textured quad.
 518      *
 519      * @param layer The layer to render
 520      * @param rect The bounds of the layer
 521      */
 522     void drawTextureLayer(Layer* layer, const Rect& rect);
 523
 524     /**
 525      * Gets the alpha and xfermode out of a paint object. If the paint is null
 526      * alpha will be 255 and the xfermode will be SRC_OVER. Accounts for both
 527      * snapshot alpha, and overrideLayerAlpha
 528      *
 529      * @param paint The paint to extract values from
 530      * @param alpha Where to store the resulting alpha
 531      * @param mode Where to store the resulting xfermode
 532      */
 533     inline void getAlphaAndMode(const SkPaint* paint, int* alpha, SkXfermode::Mode* mode) const;
 534
 535     /**
 536      * Gets the alpha from a layer, accounting for snapshot alpha and overrideLayerAlpha
 537      *
 538      * @param layer The layer from which the alpha is extracted
 539      */
 540     inline float getLayerAlpha(const Layer* layer) const;
 541
 542     /**
 543      * Safely retrieves the ColorFilter from the given Paint. If the paint is
 544      * null then null is returned.
 545      */
 546     static inline SkColorFilter* getColorFilter(const SkPaint* paint) {
 547         return paint ? paint->getColorFilter() : nullptr;
 548     }
 549
 550     /**
 551      * Safely retrieves the Shader from the given Paint. If the paint is
 552      * null then null is returned.
 553      */
 554     static inline const SkShader* getShader(const SkPaint* paint) {
 555         return paint ? paint->getShader() : nullptr;
 556     }
 557
 558     /**
 559      * Set to true to suppress error checks at the end of a frame.
 560      */
 561     virtual bool suppressErrorChecks() const {
 562         return false;
 563     }
 564
 565     CanvasState mState;
 566     Caches& mCaches;
 567     RenderState& mRenderState;
 568
 569 private:
 570     void renderGlop(const Glop& glop, bool clearLayer = true);
 571
 572     /**
 573      * Discards the content of the framebuffer if supported by the driver.
 574      * This method should be called at the beginning of a frame to optimize
 575      * rendering on some tiler architectures.
 576      */
 577     void discardFramebuffer(float left, float top, float right, float bottom);
 578
 579     /**
 580      * Tells the GPU what part of the screen is about to be redrawn.
 581      * This method will use the current layer space clip rect.
 582      * This method needs to be invoked every time getTargetFbo() is
 583      * bound again.
 584      */
 585     void startTilingCurrentClip(bool opaque = false, bool expand = false);
 586
 587     /**
 588      * Tells the GPU what part of the screen is about to be redrawn.
 589      * This method needs to be invoked every time getTargetFbo() is
 590      * bound again.
 591      */
 592     void startTiling(const Rect& clip, int windowHeight, bool opaque = false, bool expand = false);
 593
 594     /**
 595      * Tells the GPU that we are done drawing the frame or that we
 596      * are switching to another render target.
 597      */
 598     void endTiling();
 599
 600     /**
 601      * Sets the clipping rectangle using glScissor. The clip is defined by
 602      * the current snapshot's clipRect member.
 603      */
 604     void setScissorFromClip();
 605
 606     /**
 607      * Sets the clipping region using the stencil buffer. The clip region
 608      * is defined by the current snapshot's clipRegion member.
 609      */
 610     void setStencilFromClip();
 611
 612     /**
 613      * Given the local bounds of the layer, calculates ...
 614      */
 615     void calculateLayerBoundsAndClip(Rect& bounds, Rect& clip, bool fboLayer);
 616
 617     /**
 618      * Given the local bounds + clip of the layer, updates current snapshot's empty/invisible
 619      */
 620     void updateSnapshotIgnoreForLayer(const Rect& bounds, const Rect& clip,
 621             bool fboLayer, int alpha);
 622
 623     /**
 624      * Creates a new layer stored in the specified snapshot.
 625      *
 626      * @param snapshot The snapshot associated with the new layer
 627      * @param left The left coordinate of the layer
 628      * @param top The top coordinate of the layer
 629      * @param right The right coordinate of the layer
 630      * @param bottom The bottom coordinate of the layer
 631      * @param alpha The translucency of the layer
 632      * @param mode The blending mode of the layer
 633      * @param flags The layer save flags
 634      * @param mask A mask to use when drawing the layer back, may be empty
 635      *
 636      * @return True if the layer was successfully created, false otherwise
 637      */
 638     bool createLayer(float left, float top, float right, float bottom,
 639             const SkPaint* paint, int flags, const SkPath* convexMask);
 640
 641     /**
 642      * Creates a new layer stored in the specified snapshot as an FBO.
 643      *
 644      * @param layer The layer to store as an FBO
 645      * @param snapshot The snapshot associated with the new layer
 646      * @param bounds The bounds of the layer
 647      */
 648     bool createFboLayer(Layer* layer, Rect& bounds, Rect& clip);
 649
 650     /**
 651      * Compose the specified layer as a region.
 652      *
 653      * @param layer The layer to compose
 654      * @param rect The layer's bounds
 655      */
 656     void composeLayerRegion(Layer* layer, const Rect& rect);
 657
 658     /**
 659      * Compose the specified layer as a simple rectangle.
 660      *
 661      * @param layer The layer to compose
 662      * @param rect The layer's bounds
 663      * @param swap If true, the source and destination are swapped
 664      */
 665     void composeLayerRect(Layer* layer, const Rect& rect, bool swap = false);
 666
 667     /**
 668      * Clears all the regions corresponding to the current list of layers.
 669      * This method MUST be invoked before any drawing operation.
 670      */
 671     void clearLayerRegions();
 672
 673     /**
 674      * Mark the layer as dirty at the specified coordinates. The coordinates
 675      * are transformed with the supplied matrix.
 676      */
 677     void dirtyLayer(const float left, const float top,
 678             const float right, const float bottom, const Matrix4& transform);
 679
 680     /**
 681      * Mark the layer as dirty at the specified coordinates.
 682      */
 683     void dirtyLayer(const float left, const float top,
 684             const float right, const float bottom);
 685
 686     /**
 687      * Draws a colored rectangle with the specified color. The specified coordinates
 688      * are transformed by the current snapshot's transform matrix unless specified
 689      * otherwise.
 690      *
 691      * @param left The left coordinate of the rectangle
 692      * @param top The top coordinate of the rectangle
 693      * @param right The right coordinate of the rectangle
 694      * @param bottom The bottom coordinate of the rectangle
 695      * @param paint The paint containing the color, blending mode, etc.
 696      * @param ignoreTransform True if the current transform should be ignored
 697      */
 698     void drawColorRect(float left, float top, float right, float bottom,
 699             const SkPaint* paint, bool ignoreTransform = false);
 700
 701     /**
 702      * Draws a series of colored rectangles with the specified color. The specified
 703      * coordinates are transformed by the current snapshot's transform matrix unless
 704      * specified otherwise.
 705      *
 706      * @param rects A list of rectangles, 4 floats (left, top, right, bottom)
 707      *              per rectangle
 708      * @param paint The paint containing the color, blending mode, etc.
 709      * @param ignoreTransform True if the current transform should be ignored
 710      * @param dirty True if calling this method should dirty the current layer
 711      * @param clip True if the rects should be clipped, false otherwise
 712      */
 713     void drawColorRects(const float* rects, int count, const SkPaint* paint,
 714             bool ignoreTransform = false, bool dirty = true, bool clip = true);
 715
 716     /**
 717      * Draws the shape represented by the specified path texture.
 718      * This method invokes drawPathTexture() but takes into account
 719      * the extra left/top offset and the texture offset to correctly
 720      * position the final shape.
 721      *
 722      * @param left The left coordinate of the shape to render
 723      * @param top The top coordinate of the shape to render
 724      * @param texture The texture reprsenting the shape
 725      * @param paint The paint to draw the shape with
 726      */
 727     void drawShape(float left, float top, PathTexture* texture, const SkPaint* paint);
 728
 729     /**
 730      * Draws the specified texture as an alpha bitmap. Alpha bitmaps obey
 731      * different compositing rules.
 732      *
 733      * @param texture The texture to draw with
 734      * @param paint The paint to render with
 735      */
 736     void drawAlphaBitmap(Texture* texture, const SkPaint* paint);
 737
 738     /**
 739      * Renders a strip of polygons with the specified paint, used for tessellated geometry.
 740      *
 741      * @param vertexBuffer The VertexBuffer to be drawn
 742      * @param paint The paint to render with
 743      * @param flags flags with which to draw
 744      */
 745     void drawVertexBuffer(float translateX, float translateY, const VertexBuffer& vertexBuffer,
 746             const SkPaint* paint, int flags = 0);
 747
 748     /**
 749      * Convenience for translating method
 750      */
 751     void drawVertexBuffer(const VertexBuffer& vertexBuffer,
 752             const SkPaint* paint, int flags = 0) {
 753         drawVertexBuffer(0.0f, 0.0f, vertexBuffer, paint, flags);
 754     }
 755
 756     /**
 757      * Renders the convex hull defined by the specified path as a strip of polygons.
 758      *
 759      * @param path The hull of the path to draw
 760      * @param paint The paint to render with
 761      */
 762     void drawConvexPath(const SkPath& path, const SkPaint* paint);
 763
 764     /**
 765      * Draws a textured rectangle with the specified texture.
 766      *
 767      * @param texture The texture to use
 768      * @param paint The paint containing the alpha, blending mode, etc.
 769      */
 770     void drawTextureRect(Texture* texture, const SkPaint* paint);
 771
 772     /**
 773      * Draws a textured mesh with the specified texture. If the indices are omitted,
 774      * the mesh is drawn as a simple quad. The mesh pointers become offsets when a
 775      * VBO is bound.
 776      *
 777      * @param left The left coordinate of the rectangle
 778      * @param top The top coordinate of the rectangle
 779      * @param right The right coordinate of the rectangle
 780      * @param bottom The bottom coordinate of the rectangle
 781      * @param texture The texture name to map onto the rectangle
 782      * @param paint The paint containing the alpha, blending mode, colorFilter, etc.
 783      * @param blend True if the texture contains an alpha channel
 784      * @param vertices The vertices that define the mesh
 785      * @param texCoords The texture coordinates of each vertex
 786      * @param elementsCount The number of elements in the mesh, required by indices
 787      * @param swapSrcDst Whether or not the src and dst blending operations should be swapped
 788      * @param ignoreTransform True if the current transform should be ignored
 789      * @param vbo The VBO used to draw the mesh
 790      * @param modelViewMode Defines whether the model view matrix should be scaled
 791      * @param dirty True if calling this method should dirty the current layer
 792      */
 793     void drawTextureMesh(float left, float top, float right, float bottom, GLuint texture,
 794             const SkPaint* paint, bool blend,
 795             GLvoid* vertices, GLvoid* texCoords, GLenum drawMode, GLsizei elementsCount,
 796             bool swapSrcDst = false, bool ignoreTransform = false, GLuint vbo = 0,
 797             ModelViewMode modelViewMode = kModelViewMode_TranslateAndScale, bool dirty = true);
 798
 799     void drawIndexedTextureMesh(float left, float top, float right, float bottom, GLuint texture,
 800             const SkPaint* paint, bool blend,
 801             GLvoid* vertices, GLvoid* texCoords, GLenum drawMode, GLsizei elementsCount,
 802             bool swapSrcDst = false, bool ignoreTransform = false, GLuint vbo = 0,
 803             ModelViewMode modelViewMode = kModelViewMode_TranslateAndScale, bool dirty = true);
 804
 805     void drawAlpha8TextureMesh(float left, float top, float right, float bottom,
 806             GLuint texture, const SkPaint* paint,
 807             GLvoid* vertices, GLvoid* texCoords, GLenum drawMode, GLsizei elementsCount,
 808             bool ignoreTransform, ModelViewMode modelViewMode = kModelViewMode_TranslateAndScale,
 809             bool dirty = true);
 810
 811     /**
 812      * Draws the specified list of vertices as quads using indexed GL_TRIANGLES.
 813      * If the number of vertices to draw exceeds the number of indices we have
 814      * pre-allocated, this method will generate several glDrawElements() calls.
 815      */
 816     void issueIndexedQuadDraw(Vertex* mesh, GLsizei quadsCount);
 817
 818     /**
 819      * Draws text underline and strike-through if needed.
 820      *
 821      * @param text The text to decor
 822      * @param bytesCount The number of bytes in the text
 823      * @param totalAdvance The total advance in pixels, defines underline/strikethrough length
 824      * @param x The x coordinate where the text will be drawn
 825      * @param y The y coordinate where the text will be drawn
 826      * @param paint The paint to draw the text with
 827      */
 828     void drawTextDecorations(float totalAdvance, float x, float y, const SkPaint* paint);
 829
 830    /**
 831      * Draws shadow layer on text (with optional positions).
 832      *
 833      * @param paint The paint to draw the shadow with
 834      * @param text The text to draw
 835      * @param bytesCount The number of bytes in the text
 836      * @param count The number of glyphs in the text
 837      * @param positions The x, y positions of individual glyphs (or NULL)
 838      * @param fontRenderer The font renderer object
 839      * @param alpha The alpha value for drawing the shadow
 840      * @param x The x coordinate where the shadow will be drawn
 841      * @param y The y coordinate where the shadow will be drawn
 842      */
 843     void drawTextShadow(const SkPaint* paint, const char* text, int bytesCount, int count,
 844             const float* positions, FontRenderer& fontRenderer, int alpha,
 845             float x, float y);
 846
 847     /**
 848      * Draws a path texture. Path textures are alpha8 bitmaps that need special
 849      * compositing to apply colors/filters/etc.
 850      *
 851      * @param texture The texture to render
 852      * @param x The x coordinate where the texture will be drawn
 853      * @param y The y coordinate where the texture will be drawn
 854      * @param paint The paint to draw the texture with
 855      */
 856      void drawPathTexture(PathTexture* texture, float x, float y, const SkPaint* paint);
 857
 858     /**
 859      * Resets the texture coordinates stored in mMeshVertices. Setting the values
 860      * back to default is achieved by calling:
 861      *
 862      * resetDrawTextureTexCoords(0.0f, 0.0f, 1.0f, 1.0f);
 863      *
 864      * @param u1 The left coordinate of the texture
 865      * @param v1 The bottom coordinate of the texture
 866      * @param u2 The right coordinate of the texture
 867      * @param v2 The top coordinate of the texture
 868      */
 869     void resetDrawTextureTexCoords(float u1, float v1, float u2, float v2);
 870
 871     /**
 872      * Returns true if the specified paint will draw invisible text.
 873      */
 874     bool canSkipText(const SkPaint* paint) const;
 875
 876     /**
 877      * Enable or disable blending as necessary. This function sets the appropriate
 878      * blend function based on the specified xfermode.
 879      */
 880     inline void chooseBlending(bool blend, SkXfermode::Mode mode, ProgramDescription& description,
 881             bool swapSrcDst = false);
 882
 883     /**
 884      * Invoked before any drawing operation. This sets required state.
 885      */
 886     void setupDraw(bool clear = true);
 887
 888     /**
 889      * Various methods to setup OpenGL rendering.
 890      */
 891     void setupDrawWithTexture(bool isAlpha8 = false);
 892     void setupDrawWithTextureAndColor(bool isAlpha8 = false);
 893     void setupDrawWithExternalTexture();
 894     void setupDrawNoTexture();
 895     void setupDrawVertexAlpha(bool useShadowAlphaInterp);
 896     void setupDrawColor(int color, int alpha);
 897     void setupDrawColor(float r, float g, float b, float a);
 898     void setupDrawAlpha8Color(int color, int alpha);
 899     void setupDrawTextGamma(const SkPaint* paint);
 900     void setupDrawShader(const SkShader* shader);
 901     void setupDrawColorFilter(const SkColorFilter* filter);
 902     void setupDrawBlending(const Layer* layer, bool swapSrcDst = false);
 903     void setupDrawBlending(const SkPaint* paint, bool blend = true, bool swapSrcDst = false);
 904     void setupDrawProgram();
 905     void setupDrawDirtyRegionsDisabled();
 906
 907     /**
 908      * Setup the current program matrices based upon the nature of the geometry.
 909      *
 910      * @param mode If kModelViewMode_Translate, the geometry must be translated by the left and top
 911      * parameters. If kModelViewMode_TranslateAndScale, the geometry that exists in the (0,0, 1,1)
 912      * space must be scaled up and translated to fill the quad provided in (l,t,r,b). These
 913      * transformations are stored in the modelView matrix and uploaded to the shader.
 914      *
 915      * @param offset Set to true if the the matrix should be fudged (translated) slightly to
 916      * disambiguate geometry pixel positioning. See Vertex::GeometryFudgeFactor().
 917      *
 918      * @param ignoreTransform Set to true if l,t,r,b coordinates already in layer space,
 919      * currentTransform() will be ignored. (e.g. when drawing clip in layer coordinates to stencil,
 920      * or when simple translation has been extracted)
 921      */
 922     void setupDrawModelView(ModelViewMode mode, bool offset,
 923             float left, float top, float right, float bottom, bool ignoreTransform = false);
 924     void setupDrawColorUniforms(bool hasShader);
 925     void setupDrawPureColorUniforms();
 926
 927     /**
 928      * Setup uniforms for the current shader.
 929      *
 930      * @param shader SkShader on the current paint.
 931      *
 932      * @param ignoreTransform Set to true to ignore the transform in shader.
 933      */
 934     void setupDrawShaderUniforms(const SkShader* shader, bool ignoreTransform = false);
 935     void setupDrawColorFilterUniforms(const SkColorFilter* paint);
 936     void setupDrawSimpleMesh();
 937     void setupDrawTexture(GLuint texture);
 938     void setupDrawExternalTexture(GLuint texture);
 939     void setupDrawTextureTransform();
 940     void setupDrawTextureTransformUniforms(mat4& transform);
 941     void setupDrawTextGammaUniforms();
 942     void setupDrawMesh(const GLvoid* vertices, const GLvoid* texCoords = nullptr, GLuint vbo = 0);
 943     void setupDrawMesh(const GLvoid* vertices, const GLvoid* texCoords, const GLvoid* colors);
 944     void setupDrawMeshIndices(const GLvoid* vertices, const GLvoid* texCoords, GLuint vbo = 0);
 945     void setupDrawIndexedVertices(GLvoid* vertices);
 946     void accountForClear(SkXfermode::Mode mode);
 947
 948     bool updateLayer(Layer* layer, bool inFrame);
 949     void updateLayers();
 950     void flushLayers();
 951
 952 #if DEBUG_LAYERS_AS_REGIONS
 953     /**
 954      * Renders the specified region as a series of rectangles. This method
 955      * is used for debugging only.
 956      */
 957     void drawRegionRectsDebug(const Region& region);
 958 #endif
 959
 960     /**
 961      * Renders the specified region as a series of rectangles. The region
 962      * must be in screen-space coordinates.
 963      */
 964     void drawRegionRects(const SkRegion& region, const SkPaint& paint, bool dirty = false);
 965
 966     /**
 967      * Draws the current clip region if any. Only when DEBUG_CLIP_REGIONS
 968      * is turned on.
 969      */
 970     void debugClip();
 971
 972     void debugOverdraw(bool enable, bool clear);
 973     void renderOverdraw();
 974     void countOverdraw();
 975
 976     /**
 977      * Should be invoked every time the glScissor is modified.
 978      */
 979     inline void dirtyClip() { mState.setDirtyClip(true); }
 980
 981     inline const UvMapper& getMapper(const Texture* texture) {
 982         return texture && texture->uvMapper ? *texture->uvMapper : mUvMapper;
 983     }
 984
 985     /**
 986      * Returns a texture object for the specified bitmap. The texture can
 987      * come from the texture cache or an atlas. If this method returns
 988      * NULL, the texture could not be found and/or allocated.
 989      */
 990     Texture* getTexture(const SkBitmap* bitmap);
 991
 992     bool reportAndClearDirty() { bool ret = mDirty; mDirty = false; return ret; }
 993     inline Snapshot* writableSnapshot() { return mState.writableSnapshot(); }
 994     inline const Snapshot* currentSnapshot() const { return mState.currentSnapshot(); }
 995
 996     /**
 997      * Model-view matrix used to position/size objects
 998      *
 999      * Stores operation-local modifications to the draw matrix that aren't incorporated into the
1000      * currentTransform().
1001      *
1002      * If generated with kModelViewMode_Translate, mModelViewMatrix will reflect an x/y offset,
1003      * e.g. the offset in drawLayer(). If generated with kModelViewMode_TranslateAndScale,
1004      * mModelViewMatrix will reflect a translation and scale, e.g. the translation and scale
1005      * required to make VBO 0 (a rect of (0,0,1,1)) scaled to match the x,y offset, and width/height
1006      * of a bitmap.
1007      *
1008      * Used as input to SkiaShader transformation.
1009      */
1010     mat4 mModelViewMatrix;
1011
1012     // State used to define the clipping region
1013     Rect mTilingClip;
1014     // Is the target render surface opaque
1015     bool mOpaque;
1016     // Is a frame currently being rendered
1017     bool mFrameStarted;
1018
1019     // Used to draw textured quads
1020     TextureVertex mMeshVertices[4];
1021
1022     // Default UV mapper
1023     const UvMapper mUvMapper;
1024
1025     // shader, filters, and shadow
1026     DrawModifiers mDrawModifiers;
1027     SkPaint mFilteredPaint;
1028
1029     // List of rectangles to clear after saveLayer() is invoked
1030     std::vector<Rect> mLayers;
1031     // List of layers to update at the beginning of a frame
1032     Vector< sp<Layer> > mLayerUpdates;
1033
1034     // The following fields are used to setup drawing
1035     // Used to describe the shaders to generate
1036     ProgramDescription mDescription;
1037     // Color description
1038     bool mColorSet;
1039     FloatColor mColor;
1040     // Indicates that the shader should get a color
1041     bool mSetShaderColor;
1042     // Current texture unit
1043     GLuint mTextureUnit;
1044     // Track dirty regions, true by default
1045     bool mTrackDirtyRegions;
1046     // Indicate whether we are drawing an opaque frame
1047     bool mOpaqueFrame;
1048
1049     // See PROPERTY_DISABLE_SCISSOR_OPTIMIZATION in
1050     // Properties.h
1051     bool mScissorOptimizationDisabled;
1052
1053     // No-ops start/endTiling when set
1054     bool mSuppressTiling;
1055     bool mFirstFrameAfterResize;
1056
1057     bool mSkipOutlineClip;
1058
1059     // True if anything has been drawn since the last call to
1060     // reportAndClearDirty()
1061     bool mDirty;
1062
1063     // Lighting + shadows
1064     Vector3 mLightCenter;
1065     float mLightRadius;
1066     uint8_t mAmbientShadowAlpha;
1067     uint8_t mSpotShadowAlpha;
1068
1069     // Paths kept alive for the duration of the frame
1070     std::vector<std::unique_ptr<SkPath>> mTempPaths;
1071
1072     friend class Layer;
1073     friend class TextSetupFunctor;
1074     friend class DrawBitmapOp;
1075     friend class DrawPatchOp;
1076
1077 }; // class OpenGLRenderer
1078
1079 }; // namespace uirenderer
1080 }; // namespace android
1081
1082 #endif // ANDROID_HWUI_OPENGL_RENDERER_H