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