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