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