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