OpenGLRenderer.h revision 8a5cc92a150bae38ec43732d941b38bb381fe153 
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    /**
252     * Mark the layer as dirty at the specified coordinates. The coordinates
253     * are transformed with the supplied matrix.
254     */
255    void dirtyLayer(const float left, const float top,
256            const float right, const float bottom, const mat4 transform);
257
258    /**
259     * Mark the layer as dirty at the specified coordinates.
260     */
261    void dirtyLayer(const float left, const float top,
262            const float right, const float bottom);
263
264    /**
265     * Draws a colored rectangle with the specified color. The specified coordinates
266     * are transformed by the current snapshot's transform matrix.
267     *
268     * @param left The left coordinate of the rectangle
269     * @param top The top coordinate of the rectangle
270     * @param right The right coordinate of the rectangle
271     * @param bottom The bottom coordinate of the rectangle
272     * @param color The rectangle's ARGB color, defined as a packed 32 bits word
273     * @param mode The Skia xfermode to use
274     * @param ignoreTransform True if the current transform should be ignored
275     * @param ignoreBlending True if the blending is set by the caller
276     */
277    void drawColorRect(float left, float top, float right, float bottom,
278            int color, SkXfermode::Mode mode, bool ignoreTransform = false);
279
280    void drawShape(float left, float top, const PathTexture* texture, SkPaint* paint);
281    void drawRectAsShape(float left, float top, float right, float bottom, SkPaint* p);
282
283    void drawAlphaBitmap(Texture* texture, float left, float top, SkPaint* paint);
284
285    /**
286     * Draws a textured rectangle with the specified texture. The specified coordinates
287     * are transformed by the current snapshot's transform matrix.
288     *
289     * @param left The left coordinate of the rectangle
290     * @param top The top coordinate of the rectangle
291     * @param right The right coordinate of the rectangle
292     * @param bottom The bottom coordinate of the rectangle
293     * @param texture The texture name to map onto the rectangle
294     * @param alpha An additional translucency parameter, between 0.0f and 1.0f
295     * @param mode The blending mode
296     * @param blend True if the texture contains an alpha channel
297     */
298    void drawTextureRect(float left, float top, float right, float bottom, GLuint texture,
299            float alpha, SkXfermode::Mode mode, bool blend);
300
301    /**
302     * Draws a textured rectangle with the specified texture. The specified coordinates
303     * are transformed by the current snapshot's transform matrix.
304     *
305     * @param left The left coordinate of the rectangle
306     * @param top The top coordinate of the rectangle
307     * @param right The right coordinate of the rectangle
308     * @param bottom The bottom coordinate of the rectangle
309     * @param texture The texture to use
310     * @param paint The paint containing the alpha, blending mode, etc.
311     */
312    void drawTextureRect(float left, float top, float right, float bottom,
313            Texture* texture, SkPaint* paint);
314
315    /**
316     * Draws a textured mesh with the specified texture. If the indices are omitted,
317     * the mesh is drawn as a simple quad. The mesh pointers become offsets when a
318     * VBO is bound.
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 name to map onto the rectangle
325     * @param alpha An additional translucency parameter, between 0.0f and 1.0f
326     * @param mode The blending mode
327     * @param blend True if the texture contains an alpha channel
328     * @param vertices The vertices that define the mesh
329     * @param texCoords The texture coordinates of each vertex
330     * @param elementsCount The number of elements in the mesh, required by indices
331     * @param swapSrcDst Whether or not the src and dst blending operations should be swapped
332     * @param ignoreTransform True if the current transform should be ignored
333     * @param vbo The VBO used to draw the mesh
334     * @param ignoreScale True if the model view matrix should not be scaled
335     * @param dirty True if calling this method should dirty the current layer
336     */
337    void drawTextureMesh(float left, float top, float right, float bottom, GLuint texture,
338            float alpha, SkXfermode::Mode mode, bool blend,
339            GLvoid* vertices, GLvoid* texCoords, GLenum drawMode, GLsizei elementsCount,
340            bool swapSrcDst = false, bool ignoreTransform = false, GLuint vbo = 0,
341            bool ignoreScale = false, bool dirty = true);
342
343    /**
344     * Draws text underline and strike-through if needed.
345     *
346     * @param text The text to decor
347     * @param bytesCount The number of bytes in the text
348     * @param length The length in pixels of the text, can be <= 0.0f to force a measurement
349     * @param x The x coordinate where the text will be drawn
350     * @param y The y coordinate where the text will be drawn
351     * @param paint The paint to draw the text with
352     */
353    void drawTextDecorations(const char* text, int bytesCount, float length,
354            float x, float y, SkPaint* paint);
355
356    void drawPathTexture(const PathTexture* texture, float x, float y, SkPaint* paint);
357
358    /**
359     * Resets the texture coordinates stored in mMeshVertices. Setting the values
360     * back to default is achieved by calling:
361     *
362     * resetDrawTextureTexCoords(0.0f, 0.0f, 1.0f, 1.0f);
363     *
364     * @param u1 The left coordinate of the texture
365     * @param v1 The bottom coordinate of the texture
366     * @param u2 The right coordinate of the texture
367     * @param v2 The top coordinate of the texture
368     */
369    void resetDrawTextureTexCoords(float u1, float v1, float u2, float v2);
370
371    /**
372     * Gets the alpha and xfermode out of a paint object. If the paint is null
373     * alpha will be 255 and the xfermode will be SRC_OVER.
374     *
375     * @param paint The paint to extract values from
376     * @param alpha Where to store the resulting alpha
377     * @param mode Where to store the resulting xfermode
378     */
379    inline void getAlphaAndMode(SkPaint* paint, int* alpha, SkXfermode::Mode* mode);
380
381    /**
382     * Binds the specified texture. The texture unit must have been selected
383     * prior to calling this method.
384     */
385    inline void bindTexture(GLuint texture) {
386        glBindTexture(GL_TEXTURE_2D, texture);
387    }
388
389    /**
390     * Sets the wrap modes for the specified texture. The wrap modes are modified
391     * only when needed.
392     */
393    inline void setTextureWrapModes(Texture* texture, GLenum wrapS, GLenum wrapT);
394
395    /**
396     * Enable or disable blending as necessary. This function sets the appropriate
397     * blend function based on the specified xfermode.
398     */
399    inline void chooseBlending(bool blend, SkXfermode::Mode mode, ProgramDescription& description,
400            bool swapSrcDst = false);
401
402    /**
403     * Safely retrieves the mode from the specified xfermode. If the specified
404     * xfermode is null, the mode is assumed to be SkXfermode::kSrcOver_Mode.
405     */
406    inline SkXfermode::Mode getXfermode(SkXfermode* mode);
407
408    /**
409     * Use the specified program with the current GL context. If the program is already
410     * in use, it will not be bound again. If it is not in use, the current program is
411     * marked unused and the specified program becomes used and becomes the new
412     * current program.
413     *
414     * @param program The program to use
415     *
416     * @return true If the specified program was already in use, false otherwise.
417     */
418    inline bool useProgram(Program* program);
419
420    /**
421     * Invoked before any drawing operation. This sets required state.
422     */
423    void setupDraw();
424    /**
425     * Various methods to setup OpenGL rendering.
426     */
427    void setupDrawWithTexture(bool isAlpha8 = false);
428    void setupDrawAALine();
429    void setupDrawPoint(float pointSize);
430    void setupDrawColor(int color);
431    void setupDrawColor(int color, int alpha);
432    void setupDrawColor(float r, float g, float b, float a);
433    void setupDrawAlpha8Color(int color, int alpha);
434    void setupDrawAlpha8Color(float r, float g, float b, float a);
435    void setupDrawShader();
436    void setupDrawColorFilter();
437    void setupDrawBlending(SkXfermode::Mode mode = SkXfermode::kSrcOver_Mode,
438            bool swapSrcDst = false);
439    void setupDrawBlending(bool blend = true, SkXfermode::Mode mode = SkXfermode::kSrcOver_Mode,
440            bool swapSrcDst = false);
441    void setupDrawProgram();
442    void setupDrawDirtyRegionsDisabled();
443    void setupDrawModelViewIdentity(bool offset = false);
444    void setupDrawModelView(float left, float top, float right, float bottom,
445            bool ignoreTransform = false, bool ignoreModelView = false);
446    void setupDrawModelViewTranslate(float left, float top, float right, float bottom,
447            bool ignoreTransform = false);
448    void setupDrawPointUniforms();
449    void setupDrawColorUniforms();
450    void setupDrawPureColorUniforms();
451    void setupDrawShaderIdentityUniforms();
452    void setupDrawShaderUniforms(bool ignoreTransform = false);
453    void setupDrawColorFilterUniforms();
454    void setupDrawSimpleMesh();
455    void setupDrawTexture(GLuint texture);
456    void setupDrawMesh(GLvoid* vertices, GLvoid* texCoords = NULL, GLuint vbo = 0);
457    void setupDrawVertices(GLvoid* vertices);
458    void setupDrawAALine(GLvoid* vertices, GLvoid* distanceCoords, float strokeWidth);
459    void finishDrawTexture();
460
461    void drawRegionRects(const Region& region);
462
463    /**
464     * Should be invoked every time the glScissor is modified.
465     */
466    inline void dirtyClip() {
467        mDirtyClip = true;
468    }
469
470    // Dimensions of the drawing surface
471    int mWidth, mHeight;
472
473    // Matrix used for ortho projection in shaders
474    mat4 mOrthoMatrix;
475
476    // Model-view matrix used to position/size objects
477    mat4 mModelView;
478
479    // Number of saved states
480    int mSaveCount;
481    // Base state
482    sp<Snapshot> mFirstSnapshot;
483    // Current state
484    sp<Snapshot> mSnapshot;
485
486    // Shaders
487    SkiaShader* mShader;
488
489    // Color filters
490    SkiaColorFilter* mColorFilter;
491
492    // Used to draw textured quads
493    TextureVertex mMeshVertices[4];
494
495    // Drop shadow
496    bool mHasShadow;
497    float mShadowRadius;
498    float mShadowDx;
499    float mShadowDy;
500    int mShadowColor;
501
502    // Various caches
503    Caches& mCaches;
504
505    // Indentity matrix
506    const mat4 mIdentity;
507
508    // Indicates whether the clip must be restored
509    bool mDirtyClip;
510
511    // The following fields are used to setup drawing
512    // Used to describe the shaders to generate
513    ProgramDescription mDescription;
514    // Color description
515    bool mColorSet;
516    float mColorA, mColorR, mColorG, mColorB;
517    // Indicates that the shader should get a color
518    bool mSetShaderColor;
519    // Current texture unit
520    GLuint mTextureUnit;
521    // Track dirty regions, true by default
522    bool mTrackDirtyRegions;
523    // Texture coordinates slot
524    int mTexCoordsSlot;
525
526    friend class DisplayListRenderer;
527
528}; // class OpenGLRenderer
529
530}; // namespace uirenderer
531}; // namespace android
532
533#endif // ANDROID_HWUI_OPENGL_RENDERER_H
534