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