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