OpenGLRenderer.h revision 7fbcc0492fca03857e3c45064f4aa040af817d55
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_UI_OPENGL_RENDERER_H 18#define ANDROID_UI_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/ResourceTypes.h> 32 33#include "Extensions.h" 34#include "Matrix.h" 35#include "Program.h" 36#include "Rect.h" 37#include "Snapshot.h" 38#include "TextureCache.h" 39#include "LayerCache.h" 40#include "GradientCache.h" 41#include "PatchCache.h" 42#include "Vertex.h" 43#include "FontRenderer.h" 44#include "ProgramCache.h" 45#include "SkiaShader.h" 46#include "SkiaColorFilter.h" 47#include "PathCache.h" 48 49namespace android { 50namespace uirenderer { 51 52/////////////////////////////////////////////////////////////////////////////// 53// Renderer 54/////////////////////////////////////////////////////////////////////////////// 55 56/** 57 * OpenGL renderer used to draw accelerated 2D graphics. The API is a 58 * simplified version of Skia's Canvas API. 59 */ 60class OpenGLRenderer { 61public: 62 OpenGLRenderer(); 63 ~OpenGLRenderer(); 64 65 void setViewport(int width, int height); 66 void prepare(); 67 68 int getSaveCount() const; 69 int save(int flags); 70 void restore(); 71 void restoreToCount(int saveCount); 72 73 int saveLayer(float left, float top, float right, float bottom, const SkPaint* p, int flags); 74 int saveLayerAlpha(float left, float top, float right, float bottom, int alpha, int flags); 75 76 void translate(float dx, float dy); 77 void rotate(float degrees); 78 void scale(float sx, float sy); 79 80 void setMatrix(SkMatrix* matrix); 81 void getMatrix(SkMatrix* matrix); 82 void concatMatrix(SkMatrix* matrix); 83 84 const Rect& getClipBounds(); 85 bool quickReject(float left, float top, float right, float bottom); 86 bool clipRect(float left, float top, float right, float bottom, SkRegion::Op op); 87 88 void drawBitmap(SkBitmap* bitmap, float left, float top, const SkPaint* paint); 89 void drawBitmap(SkBitmap* bitmap, const SkMatrix* matrix, const SkPaint* paint); 90 void drawBitmap(SkBitmap* bitmap, float srcLeft, float srcTop, float srcRight, float srcBottom, 91 float dstLeft, float dstTop, float dstRight, float dstBottom, const SkPaint* paint); 92 void drawPatch(SkBitmap* bitmap, Res_png_9patch* patch, float left, float top, 93 float right, float bottom, const SkPaint* paint); 94 void drawColor(int color, SkXfermode::Mode mode); 95 void drawRect(float left, float top, float right, float bottom, const SkPaint* paint); 96 void drawPath(SkPath* path, SkPaint* paint); 97 98 void resetShader(); 99 void setupShader(SkiaShader* shader); 100 101 void resetColorFilter(); 102 void setupColorFilter(SkiaColorFilter* filter); 103 104 void drawText(const char* text, int bytesCount, int count, float x, float y, SkPaint* paint); 105 106private: 107 /** 108 * Saves the current state of the renderer as a new snapshot. 109 * The new snapshot is saved in mSnapshot and the previous snapshot 110 * is linked from mSnapshot->previous. 111 * 112 * @return The new save count. This value can be passed to #restoreToCount() 113 */ 114 int saveSnapshot(); 115 116 /** 117 * Restores the current snapshot; mSnapshot becomes mSnapshot->previous. 118 * 119 * @return True if the clip should be also reapplied by calling 120 * #setScissorFromClip(). 121 */ 122 bool restoreSnapshot(); 123 124 /** 125 * Sets the clipping rectangle using glScissor. The clip is defined by 126 * the current snapshot's clipRect member. 127 */ 128 void setScissorFromClip(); 129 130 /** 131 * Compose the layer defined in the current snapshot with the layer 132 * defined by the previous snapshot. 133 * 134 * The current snapshot *must* be a layer (flag kFlagIsLayer set.) 135 * 136 * @param curent The current snapshot containing the layer to compose 137 * @param previous The previous snapshot to compose the current layer with 138 */ 139 void composeLayer(sp<Snapshot> current, sp<Snapshot> previous); 140 141 /** 142 * Creates a new layer stored in the specified snapshot. 143 * 144 * @param snapshot The snapshot associated with the new layer 145 * @param left The left coordinate of the layer 146 * @param top The top coordinate of the layer 147 * @param right The right coordinate of the layer 148 * @param bottom The bottom coordinate of the layer 149 * @param alpha The translucency of the layer 150 * @param mode The blending mode of the layer 151 * @param flags The layer save flags 152 * 153 * @return True if the layer was successfully created, false otherwise 154 */ 155 bool createLayer(sp<Snapshot> snapshot, float left, float top, float right, float bottom, 156 int alpha, SkXfermode::Mode mode, int flags); 157 158 /** 159 * Draws a colored rectangle with the specified color. The specified coordinates 160 * are transformed by the current snapshot's transform matrix. 161 * 162 * @param left The left coordinate of the rectangle 163 * @param top The top coordinate of the rectangle 164 * @param right The right coordinate of the rectangle 165 * @param bottom The bottom coordinate of the rectangle 166 * @param color The rectangle's ARGB color, defined as a packed 32 bits word 167 * @param mode The Skia xfermode to use 168 * @param ignoreTransform True if the current transform should be ignored 169 */ 170 void drawColorRect(float left, float top, float right, float bottom, 171 int color, SkXfermode::Mode mode, bool ignoreTransform = false); 172 173 /** 174 * Draws a textured rectangle with the specified texture. The specified coordinates 175 * are transformed by the current snapshot's transform matrix. 176 * 177 * @param left The left coordinate of the rectangle 178 * @param top The top coordinate of the rectangle 179 * @param right The right coordinate of the rectangle 180 * @param bottom The bottom coordinate of the rectangle 181 * @param texture The texture name to map onto the rectangle 182 * @param alpha An additional translucency parameter, between 0.0f and 1.0f 183 * @param mode The blending mode 184 * @param blend True if the texture contains an alpha channel 185 */ 186 void drawTextureRect(float left, float top, float right, float bottom, GLuint texture, 187 float alpha, SkXfermode::Mode mode, bool blend); 188 189 /** 190 * Draws a textured rectangle with the specified texture. The specified coordinates 191 * are transformed by the current snapshot's transform matrix. 192 * 193 * @param left The left coordinate of the rectangle 194 * @param top The top coordinate of the rectangle 195 * @param right The right coordinate of the rectangle 196 * @param bottom The bottom coordinate of the rectangle 197 * @param texture The texture to use 198 * @param paint The paint containing the alpha, blending mode, etc. 199 */ 200 void drawTextureRect(float left, float top, float right, float bottom, 201 const Texture* texture, const SkPaint* paint); 202 203 /** 204 * Draws a textured mesh with the specified texture. If the indices are omitted, the 205 * mesh is drawn as a simple quad. 206 * 207 * @param left The left coordinate of the rectangle 208 * @param top The top coordinate of the rectangle 209 * @param right The right coordinate of the rectangle 210 * @param bottom The bottom coordinate of the rectangle 211 * @param texture The texture name to map onto the rectangle 212 * @param alpha An additional translucency parameter, between 0.0f and 1.0f 213 * @param mode The blending mode 214 * @param blend True if the texture contains an alpha channel 215 * @param vertices The vertices that define the mesh 216 * @param texCoords The texture coordinates of each vertex 217 * @param indices The indices of the vertices, can be NULL 218 * @param elementsCount The number of elements in the mesh, required by indices 219 */ 220 void drawTextureMesh(float left, float top, float right, float bottom, GLuint texture, 221 float alpha, SkXfermode::Mode mode, bool blend, 222 GLvoid* vertices, GLvoid* texCoords, GLvoid* indices, GLsizei elementsCount = 0); 223 224 /** 225 * Resets the texture coordinates stored in mMeshVertices. Setting the values 226 * back to default is achieved by calling: 227 * 228 * resetDrawTextureTexCoords(0.0f, 0.0f, 1.0f, 1.0f); 229 * 230 * @param u1 The left coordinate of the texture 231 * @param v1 The bottom coordinate of the texture 232 * @param u2 The right coordinate of the texture 233 * @param v2 The top coordinate of the texture 234 */ 235 void resetDrawTextureTexCoords(float u1, float v1, float u2, float v2); 236 237 /** 238 * Gets the alpha and xfermode out of a paint object. If the paint is null 239 * alpha will be 255 and the xfermode will be SRC_OVER. 240 * 241 * @param paint The paint to extract values from 242 * @param alpha Where to store the resulting alpha 243 * @param mode Where to store the resulting xfermode 244 */ 245 inline void getAlphaAndMode(const SkPaint* paint, int* alpha, SkXfermode::Mode* mode); 246 247 /** 248 * Binds the specified texture with the specified wrap modes. 249 */ 250 inline void bindTexture(GLuint texture, GLenum wrapS, GLenum wrapT, GLuint textureUnit = 0); 251 252 /** 253 * Enable or disable blending as necessary. This function sets the appropriate 254 * blend function based on the specified xfermode. 255 */ 256 inline void chooseBlending(bool blend, SkXfermode::Mode mode, bool isPremultiplied = true); 257 258 /** 259 * Use the specified program with the current GL context. If the program is already 260 * in use, it will not be bound again. If it is not in use, the current program is 261 * marked unused and the specified program becomes used and becomes the new 262 * current program. 263 * 264 * @param program The program to use 265 * 266 * @return true If the specified program was already in use, false otherwise. 267 */ 268 inline bool useProgram(Program* program); 269 270 // Dimensions of the drawing surface 271 int mWidth, mHeight; 272 273 // Matrix used for ortho projection in shaders 274 mat4 mOrthoMatrix; 275 276 // Model-view matrix used to position/size objects 277 mat4 mModelView; 278 279 // Number of saved states 280 int mSaveCount; 281 // Base state 282 sp<Snapshot> mFirstSnapshot; 283 // Current state 284 sp<Snapshot> mSnapshot; 285 286 // Shaders 287 Program* mCurrentProgram; 288 SkiaShader* mShader; 289 290 // Color filters 291 SkiaColorFilter* mColorFilter; 292 293 // Used to draw textured quads 294 TextureVertex mMeshVertices[4]; 295 296 // Last known blend state 297 bool mBlend; 298 GLenum mLastSrcMode; 299 GLenum mLastDstMode; 300 301 // GL extensions 302 Extensions mExtensions; 303 304 // Font renderer 305 FontRenderer mFontRenderer; 306 307 // Various caches 308 TextureCache mTextureCache; 309 LayerCache mLayerCache; 310 GradientCache mGradientCache; 311 ProgramCache mProgramCache; 312 PathCache mPathCache; 313 PatchCache mPatchCache; 314}; // class OpenGLRenderer 315 316}; // namespace uirenderer 317}; // namespace android 318 319#endif // ANDROID_UI_OPENGL_RENDERER_H 320