Layer.h revision 97dc9172b0e58979c63de0dedbab656399a62281 
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_LAYER_H
18#define ANDROID_HWUI_LAYER_H
19
20#include <sys/types.h>
21
22#include <GLES2/gl2.h>
23
24#include <ui/Region.h>
25
26#include <SkXfermode.h>
27
28#include "Rect.h"
29#include "SkiaColorFilter.h"
30#include "Texture.h"
31#include "Vertex.h"
32
33namespace android {
34namespace uirenderer {
35
36///////////////////////////////////////////////////////////////////////////////
37// Layers
38///////////////////////////////////////////////////////////////////////////////
39
40// Forward declarations
41class OpenGLRenderer;
42class DisplayList;
43
44/**
45 * A layer has dimensions and is backed by an OpenGL texture or FBO.
46 */
47struct Layer {
48    Layer(const uint32_t layerWidth, const uint32_t layerHeight);
49    ~Layer();
50
51    void freeResourcesLocked();
52
53    /**
54     * Sets this layer's region to a rectangle. Computes the appropriate
55     * texture coordinates.
56     */
57    void setRegionAsRect() {
58        const android::Rect& bounds = region.getBounds();
59        regionRect.set(bounds.leftTop().x, bounds.leftTop().y,
60               bounds.rightBottom().x, bounds.rightBottom().y);
61
62        const float texX = 1.0f / float(texture.width);
63        const float texY = 1.0f / float(texture.height);
64        const float height = layer.getHeight();
65        texCoords.set(
66               regionRect.left * texX, (height - regionRect.top) * texY,
67               regionRect.right * texX, (height - regionRect.bottom) * texY);
68
69        regionRect.translate(layer.left, layer.top);
70    }
71
72    void updateDeferred(OpenGLRenderer* renderer, DisplayList* displayList,
73            int left, int top, int right, int bottom) {
74        this->renderer = renderer;
75        this->displayList = displayList;
76        const Rect r(left, top, right, bottom);
77        dirtyRect.unionWith(r);
78        deferredUpdateScheduled = true;
79    }
80
81    inline uint32_t getWidth() {
82        return texture.width;
83    }
84
85    inline uint32_t getHeight() {
86        return texture.height;
87    }
88
89    void setSize(uint32_t width, uint32_t height) {
90        texture.width = width;
91        texture.height = height;
92    }
93
94    ANDROID_API void setPaint(SkPaint* paint);
95
96    inline void setBlend(bool blend) {
97        texture.blend = blend;
98    }
99
100    inline bool isBlend() {
101        return texture.blend;
102    }
103
104    inline void setAlpha(int alpha) {
105        this->alpha = alpha;
106    }
107
108    inline void setAlpha(int alpha, SkXfermode::Mode mode) {
109        this->alpha = alpha;
110        this->mode = mode;
111    }
112
113    inline int getAlpha() {
114        return alpha;
115    }
116
117    inline SkXfermode::Mode getMode() {
118        return mode;
119    }
120
121    inline void setEmpty(bool empty) {
122        this->empty = empty;
123    }
124
125    inline bool isEmpty() {
126        return empty;
127    }
128
129    inline void setFbo(GLuint fbo) {
130        this->fbo = fbo;
131    }
132
133    inline GLuint getFbo() {
134        return fbo;
135    }
136
137    inline GLuint* getTexturePointer() {
138        return &texture.id;
139    }
140
141    inline GLuint getTexture() {
142        return texture.id;
143    }
144
145    inline GLenum getRenderTarget() {
146        return renderTarget;
147    }
148
149    inline void setRenderTarget(GLenum renderTarget) {
150        this->renderTarget = renderTarget;
151    }
152
153    void setWrap(GLenum wrap, bool bindTexture = false, bool force = false) {
154        texture.setWrap(wrap, bindTexture, force, renderTarget);
155    }
156
157    void setFilter(GLenum filter, bool bindTexture = false, bool force = false) {
158        texture.setFilter(filter, bindTexture, force, renderTarget);
159    }
160
161    inline bool isCacheable() {
162        return cacheable;
163    }
164
165    inline void setCacheable(bool cacheable) {
166        this->cacheable = cacheable;
167    }
168
169    inline bool isTextureLayer() {
170        return textureLayer;
171    }
172
173    inline void setTextureLayer(bool textureLayer) {
174        this->textureLayer = textureLayer;
175    }
176
177    inline SkiaColorFilter* getColorFilter() {
178        return colorFilter;
179    }
180
181    ANDROID_API void setColorFilter(SkiaColorFilter* filter);
182
183    inline void bindTexture() {
184        glBindTexture(renderTarget, texture.id);
185    }
186
187    inline void generateTexture() {
188        glGenTextures(1, &texture.id);
189    }
190
191    inline void deleteTexture() {
192        if (texture.id) glDeleteTextures(1, &texture.id);
193    }
194
195    inline void deleteFbo() {
196        if (fbo) glDeleteFramebuffers(1, &fbo);
197    }
198
199    inline void allocateTexture(GLenum format, GLenum storage) {
200        glTexImage2D(renderTarget, 0, format, getWidth(), getHeight(), 0, format, storage, NULL);
201    }
202
203    inline mat4& getTexTransform() {
204        return texTransform;
205    }
206
207    inline mat4& getTransform() {
208        return transform;
209    }
210
211    /**
212     * Bounds of the layer.
213     */
214    Rect layer;
215    /**
216     * Texture coordinates of the layer.
217     */
218    Rect texCoords;
219
220    /**
221     * Dirty region indicating what parts of the layer
222     * have been drawn.
223     */
224    Region region;
225    /**
226     * If the region is a rectangle, coordinates of the
227     * region are stored here.
228     */
229    Rect regionRect;
230
231    /**
232     * If the layer can be rendered as a mesh, this is non-null.
233     */
234    TextureVertex* mesh;
235    uint16_t* meshIndices;
236    GLsizei meshElementCount;
237
238    /**
239     * Used for deferred updates.
240     */
241    bool deferredUpdateScheduled;
242    OpenGLRenderer* renderer;
243    DisplayList* displayList;
244    Rect dirtyRect;
245
246private:
247    /**
248     * Name of the FBO used to render the layer. If the name is 0
249     * this layer is not backed by an FBO, but a simple texture.
250     */
251    GLuint fbo;
252
253    /**
254     * Indicates whether this layer has been used already.
255     */
256    bool empty;
257
258    /**
259     * The texture backing this layer.
260     */
261    Texture texture;
262
263    /**
264     * If set to true (by default), the layer can be reused.
265     */
266    bool cacheable;
267
268    /**
269     * When set to true, this layer must be treated as a texture
270     * layer.
271     */
272    bool textureLayer;
273
274    /**
275     * Indicates the render target.
276     */
277    GLenum renderTarget;
278
279    /**
280     * Color filter used to draw this layer. Optional.
281     */
282    SkiaColorFilter* colorFilter;
283
284    /**
285     * Opacity of the layer.
286     */
287    int alpha;
288    /**
289     * Blending mode of the layer.
290     */
291    SkXfermode::Mode mode;
292
293    /**
294     * Optional texture coordinates transform.
295     */
296    mat4 texTransform;
297
298    /**
299     * Optional transform.
300     */
301    mat4 transform;
302
303}; // struct Layer
304
305}; // namespace uirenderer
306}; // namespace android
307
308#endif // ANDROID_HWUI_LAYER_H
309