OpenGLRenderer.h revision 5b0200bd47e8a9a4dc8d2e6c3a110d522b30bf82
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/Vector.h> 33 34#include "Debug.h" 35#include "Extensions.h" 36#include "Matrix.h" 37#include "Program.h" 38#include "Rect.h" 39#include "Snapshot.h" 40#include "Vertex.h" 41#include "SkiaShader.h" 42#include "SkiaColorFilter.h" 43#include "Caches.h" 44 45namespace android { 46namespace uirenderer { 47 48/////////////////////////////////////////////////////////////////////////////// 49// Renderer 50/////////////////////////////////////////////////////////////////////////////// 51 52class DisplayList; 53 54/** 55 * OpenGL renderer used to draw accelerated 2D graphics. The API is a 56 * simplified version of Skia's Canvas API. 57 */ 58class OpenGLRenderer { 59public: 60 OpenGLRenderer(); 61 virtual ~OpenGLRenderer(); 62 63 virtual void setViewport(int width, int height); 64 65 void prepare(bool opaque); 66 virtual void prepareDirty(float left, float top, float right, float bottom, bool opaque); 67 virtual void finish(); 68 69 // These two calls must not be recorded in display lists 70 virtual void interrupt(); 71 virtual void resume(); 72 73 virtual bool callDrawGLFunction(Functor *functor, Rect& dirty); 74 75 int getSaveCount() const; 76 virtual int save(int flags); 77 virtual void restore(); 78 virtual void restoreToCount(int saveCount); 79 80 virtual int saveLayer(float left, float top, float right, float bottom, 81 SkPaint* p, int flags); 82 virtual int saveLayerAlpha(float left, float top, float right, float bottom, 83 int alpha, int flags); 84 85 virtual void translate(float dx, float dy); 86 virtual void rotate(float degrees); 87 virtual void scale(float sx, float sy); 88 virtual void skew(float sx, float sy); 89 90 const float* getMatrix() const; 91 void getMatrix(SkMatrix* matrix); 92 virtual void setMatrix(SkMatrix* matrix); 93 virtual void concatMatrix(SkMatrix* matrix); 94 95 const Rect& getClipBounds(); 96 bool quickReject(float left, float top, float right, float bottom); 97 virtual bool clipRect(float left, float top, float right, float bottom, SkRegion::Op op); 98 99 virtual bool drawDisplayList(DisplayList* displayList, uint32_t width, uint32_t height, 100 Rect& dirty, uint32_t level = 0); 101 virtual void drawLayer(Layer* layer, float x, float y, SkPaint* paint); 102 virtual void drawBitmap(SkBitmap* bitmap, float left, float top, SkPaint* paint); 103 virtual void drawBitmap(SkBitmap* bitmap, SkMatrix* matrix, SkPaint* paint); 104 virtual void drawBitmap(SkBitmap* bitmap, float srcLeft, float srcTop, 105 float srcRight, float srcBottom, float dstLeft, float dstTop, 106 float dstRight, float dstBottom, SkPaint* paint); 107 virtual void drawBitmapMesh(SkBitmap* bitmap, int meshWidth, int meshHeight, 108 float* vertices, int* colors, SkPaint* paint); 109 virtual void drawPatch(SkBitmap* bitmap, const int32_t* xDivs, const int32_t* yDivs, 110 const uint32_t* colors, uint32_t width, uint32_t height, int8_t numColors, 111 float left, float top, float right, float bottom, SkPaint* paint); 112 virtual void drawColor(int color, SkXfermode::Mode mode); 113 virtual void drawRect(float left, float top, float right, float bottom, SkPaint* paint); 114 virtual void drawRoundRect(float left, float top, float right, float bottom, 115 float rx, float ry, SkPaint* paint); 116 virtual void drawCircle(float x, float y, float radius, SkPaint* paint); 117 virtual void drawOval(float left, float top, float right, float bottom, SkPaint* paint); 118 virtual void drawArc(float left, float top, float right, float bottom, 119 float startAngle, float sweepAngle, bool useCenter, SkPaint* paint); 120 virtual void drawPath(SkPath* path, SkPaint* paint); 121 virtual void drawLines(float* points, int count, SkPaint* paint); 122 virtual void drawPoints(float* points, int count, SkPaint* paint); 123 virtual void drawText(const char* text, int bytesCount, int count, float x, float y, 124 SkPaint* paint); 125 126 virtual void resetShader(); 127 virtual void setupShader(SkiaShader* shader); 128 129 virtual void resetColorFilter(); 130 virtual void setupColorFilter(SkiaColorFilter* filter); 131 132 virtual void resetShadow(); 133 virtual void setupShadow(float radius, float dx, float dy, int color); 134 135protected: 136 /** 137 * Compose the layer defined in the current snapshot with the layer 138 * defined by the previous snapshot. 139 * 140 * The current snapshot *must* be a layer (flag kFlagIsLayer set.) 141 * 142 * @param curent The current snapshot containing the layer to compose 143 * @param previous The previous snapshot to compose the current layer with 144 */ 145 virtual void composeLayer(sp<Snapshot> current, sp<Snapshot> previous); 146 147 /** 148 * Marks the specified region as dirty at the specified bounds. 149 */ 150 void dirtyLayerUnchecked(Rect& bounds, Region* region); 151 152 /** 153 * Returns the current snapshot. 154 */ 155 sp<Snapshot> getSnapshot() { 156 return mSnapshot; 157 } 158 159 /** 160 * Returns the region of the current layer. 161 */ 162 virtual Region* getRegion() { 163 return mSnapshot->region; 164 } 165 166 /** 167 * Indicates whether rendering is currently targeted at a layer. 168 */ 169 virtual bool hasLayer() { 170 return (mSnapshot->flags & Snapshot::kFlagFboTarget) && mSnapshot->region; 171 } 172 173 /** 174 * Returns the name of the FBO this renderer is rendering into. 175 */ 176 virtual GLint getTargetFbo() { 177 return 0; 178 } 179 180private: 181 /** 182 * Saves the current state of the renderer as a new snapshot. 183 * The new snapshot is saved in mSnapshot and the previous snapshot 184 * is linked from mSnapshot->previous. 185 * 186 * @param flags The save flags; see SkCanvas for more information 187 * 188 * @return The new save count. This value can be passed to #restoreToCount() 189 */ 190 int saveSnapshot(int flags); 191 192 /** 193 * Restores the current snapshot; mSnapshot becomes mSnapshot->previous. 194 * 195 * @return True if the clip was modified. 196 */ 197 bool restoreSnapshot(); 198 199 /** 200 * Sets the clipping rectangle using glScissor. The clip is defined by 201 * the current snapshot's clipRect member. 202 */ 203 void setScissorFromClip(); 204 205 /** 206 * Creates a new layer stored in the specified snapshot. 207 * 208 * @param snapshot The snapshot associated with the new layer 209 * @param left The left coordinate of the layer 210 * @param top The top coordinate of the layer 211 * @param right The right coordinate of the layer 212 * @param bottom The bottom coordinate of the layer 213 * @param alpha The translucency of the layer 214 * @param mode The blending mode of the layer 215 * @param flags The layer save flags 216 * @param previousFbo The name of the current framebuffer 217 * 218 * @return True if the layer was successfully created, false otherwise 219 */ 220 bool createLayer(sp<Snapshot> snapshot, float left, float top, float right, float bottom, 221 int alpha, SkXfermode::Mode mode, int flags, GLuint previousFbo); 222 223 /** 224 * Creates a new layer stored in the specified snapshot as an FBO. 225 * 226 * @param layer The layer to store as an FBO 227 * @param snapshot The snapshot associated with the new layer 228 * @param bounds The bounds of the layer 229 * @param previousFbo The name of the current framebuffer 230 */ 231 bool createFboLayer(Layer* layer, Rect& bounds, sp<Snapshot> snapshot, 232 GLuint previousFbo); 233 234 /** 235 * Compose the specified layer as a region. 236 * 237 * @param layer The layer to compose 238 * @param rect The layer's bounds 239 */ 240 void composeLayerRegion(Layer* layer, const Rect& rect); 241 242 /** 243 * Compose the specified layer as a simple rectangle. 244 * 245 * @param layer The layer to compose 246 * @param rect The layer's bounds 247 * @param swap If true, the source and destination are swapped 248 */ 249 void composeLayerRect(Layer* layer, const Rect& rect, bool swap = false); 250 251 /** 252 * Mark the layer as dirty at the specified coordinates. The coordinates 253 * are transformed with the supplied matrix. 254 */ 255 void dirtyLayer(const float left, const float top, 256 const float right, const float bottom, const mat4 transform); 257 258 /** 259 * Mark the layer as dirty at the specified coordinates. 260 */ 261 void dirtyLayer(const float left, const float top, 262 const float right, const float bottom); 263 264 /** 265 * Draws a colored rectangle with the specified color. The specified coordinates 266 * are transformed by the current snapshot's transform matrix. 267 * 268 * @param left The left coordinate of the rectangle 269 * @param top The top coordinate of the rectangle 270 * @param right The right coordinate of the rectangle 271 * @param bottom The bottom coordinate of the rectangle 272 * @param color The rectangle's ARGB color, defined as a packed 32 bits word 273 * @param mode The Skia xfermode to use 274 * @param ignoreTransform True if the current transform should be ignored 275 * @param ignoreBlending True if the blending is set by the caller 276 */ 277 void drawColorRect(float left, float top, float right, float bottom, 278 int color, SkXfermode::Mode mode, bool ignoreTransform = false); 279 280 void drawShape(float left, float top, const PathTexture* texture, SkPaint* paint); 281 void drawRectAsShape(float left, float top, float right, float bottom, SkPaint* p); 282 283 void drawAlphaBitmap(Texture* texture, float left, float top, SkPaint* paint); 284 285 /** 286 * Draws a line as a quad. Called by drawLines() for all cases except hairline without AA. 287 * 288 * @param points The vertices of the lines. Every four entries specifies the x/y points 289 * of a single line segment. 290 * @param count The number of entries in the points array. 291 * @param isAA Whether the line is anti-aliased 292 * @param isHairline Whether the line has strokeWidth==0, which results in the line being 293 * one pixel wide on the display regardless of scale. 294 */ 295 void drawLinesAsQuads(float *points, int count, bool isAA, bool isHairline, 296 float strokeWidth); 297 298 /** 299 * Draws a textured rectangle with the specified texture. The specified coordinates 300 * are transformed by the current snapshot's transform matrix. 301 * 302 * @param left The left coordinate of the rectangle 303 * @param top The top coordinate of the rectangle 304 * @param right The right coordinate of the rectangle 305 * @param bottom The bottom coordinate of the rectangle 306 * @param texture The texture name to map onto the rectangle 307 * @param alpha An additional translucency parameter, between 0.0f and 1.0f 308 * @param mode The blending mode 309 * @param blend True if the texture contains an alpha channel 310 */ 311 void drawTextureRect(float left, float top, float right, float bottom, GLuint texture, 312 float alpha, SkXfermode::Mode mode, bool blend); 313 314 /** 315 * Draws a textured rectangle with the specified texture. The specified coordinates 316 * are transformed by the current snapshot's transform matrix. 317 * 318 * @param left The left coordinate of the rectangle 319 * @param top The top coordinate of the rectangle 320 * @param right The right coordinate of the rectangle 321 * @param bottom The bottom coordinate of the rectangle 322 * @param texture The texture to use 323 * @param paint The paint containing the alpha, blending mode, etc. 324 */ 325 void drawTextureRect(float left, float top, float right, float bottom, 326 Texture* texture, SkPaint* paint); 327 328 /** 329 * Draws a textured mesh with the specified texture. If the indices are omitted, 330 * the mesh is drawn as a simple quad. The mesh pointers become offsets when a 331 * VBO is bound. 332 * 333 * @param left The left coordinate of the rectangle 334 * @param top The top coordinate of the rectangle 335 * @param right The right coordinate of the rectangle 336 * @param bottom The bottom coordinate of the rectangle 337 * @param texture The texture name to map onto the rectangle 338 * @param alpha An additional translucency parameter, between 0.0f and 1.0f 339 * @param mode The blending mode 340 * @param blend True if the texture contains an alpha channel 341 * @param vertices The vertices that define the mesh 342 * @param texCoords The texture coordinates of each vertex 343 * @param elementsCount The number of elements in the mesh, required by indices 344 * @param swapSrcDst Whether or not the src and dst blending operations should be swapped 345 * @param ignoreTransform True if the current transform should be ignored 346 * @param vbo The VBO used to draw the mesh 347 * @param ignoreScale True if the model view matrix should not be scaled 348 * @param dirty True if calling this method should dirty the current layer 349 */ 350 void drawTextureMesh(float left, float top, float right, float bottom, GLuint texture, 351 float alpha, SkXfermode::Mode mode, bool blend, 352 GLvoid* vertices, GLvoid* texCoords, GLenum drawMode, GLsizei elementsCount, 353 bool swapSrcDst = false, bool ignoreTransform = false, GLuint vbo = 0, 354 bool ignoreScale = false, bool dirty = true); 355 356 /** 357 * Draws text underline and strike-through if needed. 358 * 359 * @param text The text to decor 360 * @param bytesCount The number of bytes in the text 361 * @param length The length in pixels of the text, can be <= 0.0f to force a measurement 362 * @param x The x coordinate where the text will be drawn 363 * @param y The y coordinate where the text will be drawn 364 * @param paint The paint to draw the text with 365 */ 366 void drawTextDecorations(const char* text, int bytesCount, float length, 367 float x, float y, SkPaint* paint); 368 369 void drawPathTexture(const PathTexture* texture, float x, float y, SkPaint* paint); 370 371 /** 372 * Resets the texture coordinates stored in mMeshVertices. Setting the values 373 * back to default is achieved by calling: 374 * 375 * resetDrawTextureTexCoords(0.0f, 0.0f, 1.0f, 1.0f); 376 * 377 * @param u1 The left coordinate of the texture 378 * @param v1 The bottom coordinate of the texture 379 * @param u2 The right coordinate of the texture 380 * @param v2 The top coordinate of the texture 381 */ 382 void resetDrawTextureTexCoords(float u1, float v1, float u2, float v2); 383 384 /** 385 * Gets the alpha and xfermode out of a paint object. If the paint is null 386 * alpha will be 255 and the xfermode will be SRC_OVER. 387 * 388 * @param paint The paint to extract values from 389 * @param alpha Where to store the resulting alpha 390 * @param mode Where to store the resulting xfermode 391 */ 392 inline void getAlphaAndMode(SkPaint* paint, int* alpha, SkXfermode::Mode* mode); 393 394 /** 395 * Binds the specified texture. The texture unit must have been selected 396 * prior to calling this method. 397 */ 398 inline void bindTexture(GLuint texture) { 399 glBindTexture(GL_TEXTURE_2D, texture); 400 } 401 402 /** 403 * Sets the wrap modes for the specified texture. The wrap modes are modified 404 * only when needed. 405 */ 406 inline void setTextureWrapModes(Texture* texture, GLenum wrapS, GLenum wrapT); 407 408 /** 409 * Enable or disable blending as necessary. This function sets the appropriate 410 * blend function based on the specified xfermode. 411 */ 412 inline void chooseBlending(bool blend, SkXfermode::Mode mode, ProgramDescription& description, 413 bool swapSrcDst = false); 414 415 /** 416 * Safely retrieves the mode from the specified xfermode. If the specified 417 * xfermode is null, the mode is assumed to be SkXfermode::kSrcOver_Mode. 418 */ 419 inline SkXfermode::Mode getXfermode(SkXfermode* mode); 420 421 /** 422 * Use the specified program with the current GL context. If the program is already 423 * in use, it will not be bound again. If it is not in use, the current program is 424 * marked unused and the specified program becomes used and becomes the new 425 * current program. 426 * 427 * @param program The program to use 428 * 429 * @return true If the specified program was already in use, false otherwise. 430 */ 431 inline bool useProgram(Program* program); 432 433 /** 434 * Invoked before any drawing operation. This sets required state. 435 */ 436 void setupDraw(); 437 /** 438 * Various methods to setup OpenGL rendering. 439 */ 440 void setupDrawWithTexture(bool isAlpha8 = false); 441 void setupDrawAALine(); 442 void setupDrawPoint(float pointSize); 443 void setupDrawColor(int color); 444 void setupDrawColor(int color, int alpha); 445 void setupDrawColor(float r, float g, float b, float a); 446 void setupDrawAlpha8Color(int color, int alpha); 447 void setupDrawAlpha8Color(float r, float g, float b, float a); 448 void setupDrawShader(); 449 void setupDrawColorFilter(); 450 void setupDrawBlending(SkXfermode::Mode mode = SkXfermode::kSrcOver_Mode, 451 bool swapSrcDst = false); 452 void setupDrawBlending(bool blend = true, SkXfermode::Mode mode = SkXfermode::kSrcOver_Mode, 453 bool swapSrcDst = false); 454 void setupDrawProgram(); 455 void setupDrawDirtyRegionsDisabled(); 456 void setupDrawModelViewIdentity(); 457 void setupDrawModelView(float left, float top, float right, float bottom, 458 bool ignoreTransform = false, bool ignoreModelView = false); 459 void setupDrawModelViewTranslate(float left, float top, float right, float bottom, 460 bool ignoreTransform = false); 461 void setupDrawPointUniforms(); 462 void setupDrawColorUniforms(); 463 void setupDrawPureColorUniforms(); 464 void setupDrawShaderIdentityUniforms(); 465 void setupDrawShaderUniforms(bool ignoreTransform = false); 466 void setupDrawColorFilterUniforms(); 467 void setupDrawSimpleMesh(); 468 void setupDrawTexture(GLuint texture); 469 void setupDrawMesh(GLvoid* vertices, GLvoid* texCoords = NULL, GLuint vbo = 0); 470 void setupDrawVertices(GLvoid* vertices); 471 void setupDrawAALine(GLvoid* vertices, GLvoid* distanceCoords, float strokeWidth); 472 void finishDrawTexture(); 473 474 void drawRegionRects(const Region& region); 475 476 /** 477 * Should be invoked every time the glScissor is modified. 478 */ 479 inline void dirtyClip() { 480 mDirtyClip = true; 481 } 482 483 // Dimensions of the drawing surface 484 int mWidth, mHeight; 485 486 // Matrix used for ortho projection in shaders 487 mat4 mOrthoMatrix; 488 489 // Model-view matrix used to position/size objects 490 mat4 mModelView; 491 492 // Number of saved states 493 int mSaveCount; 494 // Base state 495 sp<Snapshot> mFirstSnapshot; 496 // Current state 497 sp<Snapshot> mSnapshot; 498 499 // Shaders 500 SkiaShader* mShader; 501 502 // Color filters 503 SkiaColorFilter* mColorFilter; 504 505 // Used to draw textured quads 506 TextureVertex mMeshVertices[4]; 507 508 // Drop shadow 509 bool mHasShadow; 510 float mShadowRadius; 511 float mShadowDx; 512 float mShadowDy; 513 int mShadowColor; 514 515 // Various caches 516 Caches& mCaches; 517 518 // Indentity matrix 519 const mat4 mIdentity; 520 521 // Indicates whether the clip must be restored 522 bool mDirtyClip; 523 524 // The following fields are used to setup drawing 525 // Used to describe the shaders to generate 526 ProgramDescription mDescription; 527 // Color description 528 bool mColorSet; 529 float mColorA, mColorR, mColorG, mColorB; 530 // Indicates that the shader should get a color 531 bool mSetShaderColor; 532 // Current texture unit 533 GLuint mTextureUnit; 534 // Track dirty regions, true by default 535 bool mTrackDirtyRegions; 536 // Texture coordinates slot 537 int mTexCoordsSlot; 538 539 friend class DisplayListRenderer; 540 541}; // class OpenGLRenderer 542 543}; // namespace uirenderer 544}; // namespace android 545 546#endif // ANDROID_HWUI_OPENGL_RENDERER_H 547