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