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