blob: 911b998803349c57ffe46c825fa3e1242888d78f [file] [log] [blame]
Romain Guydda57022010-07-06 11:39:32 -07001/*
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
Romain Guy5b3b3522010-10-27 18:57:51 -070017#ifndef ANDROID_HWUI_LAYER_H
18#define ANDROID_HWUI_LAYER_H
Romain Guydda57022010-07-06 11:39:32 -070019
Derek Sollenberger76d3a1b2013-12-10 12:28:58 -050020#include <cutils/compiler.h>
Romain Guyf7f93552010-07-08 19:17:03 -070021#include <sys/types.h>
John Reck087bc0c2014-04-04 16:20:08 -070022#include <utils/StrongPointer.h>
Romain Guyf7f93552010-07-08 19:17:03 -070023
Romain Guydda57022010-07-06 11:39:32 -070024#include <GLES2/gl2.h>
25
Romain Guy5b3b3522010-10-27 18:57:51 -070026#include <ui/Region.h>
27
Derek Sollenbergerca79cf62012-08-14 16:44:52 -040028#include <SkPaint.h>
Romain Guydda57022010-07-06 11:39:32 -070029#include <SkXfermode.h>
30
Derek Sollenberger76d3a1b2013-12-10 12:28:58 -050031#include "Matrix.h"
Romain Guydda57022010-07-06 11:39:32 -070032#include "Rect.h"
Romain Guy3bbacf22013-02-06 16:51:04 -080033#include "RenderBuffer.h"
Romain Guy9ace8f52011-07-07 20:50:11 -070034#include "Texture.h"
Romain Guyf219da52011-01-16 12:54:25 -080035#include "Vertex.h"
Romain Guydda57022010-07-06 11:39:32 -070036
37namespace android {
38namespace uirenderer {
39
Romain Guy8550c4c2010-10-08 15:49:53 -070040///////////////////////////////////////////////////////////////////////////////
41// Layers
42///////////////////////////////////////////////////////////////////////////////
Romain Guydda57022010-07-06 11:39:32 -070043
Romain Guy2bf68f02012-03-02 13:37:47 -080044// Forward declarations
Romain Guy8aa195d2013-06-04 18:00:09 -070045class Caches;
John Reck3b202512014-06-23 13:13:08 -070046class RenderState;
Romain Guy2bf68f02012-03-02 13:37:47 -080047class OpenGLRenderer;
John Recke18264b2014-03-12 13:56:30 -070048class RenderNode;
Romain Guy96885eb2013-03-26 15:05:58 -070049class DeferredDisplayList;
50class DeferStateStruct;
Romain Guy2bf68f02012-03-02 13:37:47 -080051
Romain Guydda57022010-07-06 11:39:32 -070052/**
Romain Guyeb993562010-10-05 18:14:38 -070053 * A layer has dimensions and is backed by an OpenGL texture or FBO.
Romain Guydda57022010-07-06 11:39:32 -070054 */
Chris Craik564acf72014-01-02 16:46:18 -080055class Layer {
56public:
John Reck3b202512014-06-23 13:13:08 -070057 Layer(RenderState& renderState, const uint32_t layerWidth, const uint32_t layerHeight);
Chet Haased15ebf22012-09-05 11:40:29 -070058 ~Layer();
Romain Guy8550c4c2010-10-08 15:49:53 -070059
Romain Guy2055aba2013-01-18 16:42:51 -080060 static uint32_t computeIdealWidth(uint32_t layerWidth);
61 static uint32_t computeIdealHeight(uint32_t layerHeight);
62
Romain Guy8ce00302013-01-15 18:51:42 -080063 /**
64 * Calling this method will remove (either by recycling or
65 * destroying) the associated FBO, if present, and any render
66 * buffer (stencil for instance.)
67 */
68 void removeFbo(bool flush = true);
Dave Burke56257af2012-09-25 20:30:09 -070069
Romain Guydda57022010-07-06 11:39:32 -070070 /**
Romain Guy9fc27812011-04-27 14:21:41 -070071 * Sets this layer's region to a rectangle. Computes the appropriate
72 * texture coordinates.
73 */
74 void setRegionAsRect() {
75 const android::Rect& bounds = region.getBounds();
76 regionRect.set(bounds.leftTop().x, bounds.leftTop().y,
77 bounds.rightBottom().x, bounds.rightBottom().y);
78
Romain Guy9ace8f52011-07-07 20:50:11 -070079 const float texX = 1.0f / float(texture.width);
80 const float texY = 1.0f / float(texture.height);
Romain Guy9fc27812011-04-27 14:21:41 -070081 const float height = layer.getHeight();
82 texCoords.set(
83 regionRect.left * texX, (height - regionRect.top) * texY,
84 regionRect.right * texX, (height - regionRect.bottom) * texY);
Romain Guy9ace8f52011-07-07 20:50:11 -070085
86 regionRect.translate(layer.left, layer.top);
87 }
88
Chris Craik69e5adf2014-08-14 13:34:01 -070089 void setWindowTransform(Matrix4& windowTransform) {
90 cachedInvTransformInWindow.loadInverse(windowTransform);
91 rendererLightPosDirty = true;
92 }
93
Chris Craika7090e02014-06-20 16:01:00 -070094 void updateDeferred(RenderNode* renderNode, int left, int top, int right, int bottom);
Romain Guy2bf68f02012-03-02 13:37:47 -080095
Romain Guy3bbacf22013-02-06 16:51:04 -080096 inline uint32_t getWidth() const {
Romain Guy9ace8f52011-07-07 20:50:11 -070097 return texture.width;
98 }
99
Romain Guy3bbacf22013-02-06 16:51:04 -0800100 inline uint32_t getHeight() const {
Romain Guy9ace8f52011-07-07 20:50:11 -0700101 return texture.height;
102 }
103
Romain Guy2055aba2013-01-18 16:42:51 -0800104 /**
105 * Resize the layer and its texture if needed.
106 *
107 * @param width The new width of the layer
108 * @param height The new height of the layer
109 *
110 * @return True if the layer was resized or nothing happened, false if
111 * a failure occurred during the resizing operation
112 */
113 bool resize(const uint32_t width, const uint32_t height);
114
Romain Guy9ace8f52011-07-07 20:50:11 -0700115 void setSize(uint32_t width, uint32_t height) {
116 texture.width = width;
117 texture.height = height;
118 }
119
Derek Sollenberger674554f2014-02-19 16:47:32 +0000120 ANDROID_API void setPaint(const SkPaint* paint);
Chet Haased15ebf22012-09-05 11:40:29 -0700121
Romain Guy9ace8f52011-07-07 20:50:11 -0700122 inline void setBlend(bool blend) {
123 texture.blend = blend;
124 }
125
Romain Guy3bbacf22013-02-06 16:51:04 -0800126 inline bool isBlend() const {
Romain Guy9ace8f52011-07-07 20:50:11 -0700127 return texture.blend;
128 }
129
Chris Craik9757ac02014-02-25 18:50:17 -0800130 inline void setForceFilter(bool forceFilter) {
131 this->forceFilter = forceFilter;
132 }
133
134 inline bool getForceFilter() const {
135 return forceFilter;
136 }
137
Romain Guy9ace8f52011-07-07 20:50:11 -0700138 inline void setAlpha(int alpha) {
139 this->alpha = alpha;
140 }
141
142 inline void setAlpha(int alpha, SkXfermode::Mode mode) {
143 this->alpha = alpha;
144 this->mode = mode;
145 }
146
Romain Guy3bbacf22013-02-06 16:51:04 -0800147 inline int getAlpha() const {
Romain Guy9ace8f52011-07-07 20:50:11 -0700148 return alpha;
149 }
150
Romain Guy3bbacf22013-02-06 16:51:04 -0800151 inline SkXfermode::Mode getMode() const {
Romain Guy9ace8f52011-07-07 20:50:11 -0700152 return mode;
153 }
154
155 inline void setEmpty(bool empty) {
156 this->empty = empty;
157 }
158
Romain Guy3bbacf22013-02-06 16:51:04 -0800159 inline bool isEmpty() const {
Romain Guy9ace8f52011-07-07 20:50:11 -0700160 return empty;
161 }
162
163 inline void setFbo(GLuint fbo) {
164 this->fbo = fbo;
165 }
166
Romain Guy3bbacf22013-02-06 16:51:04 -0800167 inline GLuint getFbo() const {
Romain Guy9ace8f52011-07-07 20:50:11 -0700168 return fbo;
169 }
170
Romain Guy3bbacf22013-02-06 16:51:04 -0800171 inline void setStencilRenderBuffer(RenderBuffer* renderBuffer) {
172 if (RenderBuffer::isStencilBuffer(renderBuffer->getFormat())) {
173 this->stencil = renderBuffer;
174 glFramebufferRenderbuffer(GL_FRAMEBUFFER, GL_STENCIL_ATTACHMENT,
175 GL_RENDERBUFFER, stencil->getName());
176 } else {
177 ALOGE("The specified render buffer is not a stencil buffer");
178 }
Romain Guy8ce00302013-01-15 18:51:42 -0800179 }
180
Romain Guy3bbacf22013-02-06 16:51:04 -0800181 inline RenderBuffer* getStencilRenderBuffer() const {
Romain Guy8ce00302013-01-15 18:51:42 -0800182 return stencil;
183 }
184
Romain Guy3bbacf22013-02-06 16:51:04 -0800185 inline GLuint getTexture() const {
Romain Guy9ace8f52011-07-07 20:50:11 -0700186 return texture.id;
187 }
188
Romain Guy3bbacf22013-02-06 16:51:04 -0800189 inline GLenum getRenderTarget() const {
Romain Guy9ace8f52011-07-07 20:50:11 -0700190 return renderTarget;
191 }
192
193 inline void setRenderTarget(GLenum renderTarget) {
194 this->renderTarget = renderTarget;
195 }
196
Romain Guyd21b6e12011-11-30 20:21:23 -0800197 void setWrap(GLenum wrap, bool bindTexture = false, bool force = false) {
198 texture.setWrap(wrap, bindTexture, force, renderTarget);
Romain Guy9ace8f52011-07-07 20:50:11 -0700199 }
200
Romain Guyd21b6e12011-11-30 20:21:23 -0800201 void setFilter(GLenum filter, bool bindTexture = false, bool force = false) {
202 texture.setFilter(filter, bindTexture, force, renderTarget);
Romain Guy9ace8f52011-07-07 20:50:11 -0700203 }
204
Romain Guy3bbacf22013-02-06 16:51:04 -0800205 inline bool isCacheable() const {
Romain Guy9ace8f52011-07-07 20:50:11 -0700206 return cacheable;
207 }
208
209 inline void setCacheable(bool cacheable) {
210 this->cacheable = cacheable;
211 }
212
Romain Guy3bbacf22013-02-06 16:51:04 -0800213 inline bool isDirty() const {
Romain Guy7c25aab2012-10-18 15:05:02 -0700214 return dirty;
215 }
216
217 inline void setDirty(bool dirty) {
218 this->dirty = dirty;
219 }
220
Romain Guy3bbacf22013-02-06 16:51:04 -0800221 inline bool isTextureLayer() const {
Romain Guy9ace8f52011-07-07 20:50:11 -0700222 return textureLayer;
223 }
224
225 inline void setTextureLayer(bool textureLayer) {
226 this->textureLayer = textureLayer;
227 }
228
Derek Sollenberger76d3a1b2013-12-10 12:28:58 -0500229 inline SkColorFilter* getColorFilter() const {
Romain Guy9ace8f52011-07-07 20:50:11 -0700230 return colorFilter;
231 }
232
Derek Sollenberger76d3a1b2013-12-10 12:28:58 -0500233 ANDROID_API void setColorFilter(SkColorFilter* filter);
Romain Guy9ace8f52011-07-07 20:50:11 -0700234
Chris Craik3f0854292014-04-15 16:18:08 -0700235 inline void setConvexMask(const SkPath* convexMask) {
236 this->convexMask = convexMask;
237 }
238
239 inline const SkPath* getConvexMask() {
240 return convexMask;
241 }
242
Romain Guy8aa195d2013-06-04 18:00:09 -0700243 void bindStencilRenderBuffer() const;
Romain Guy9ace8f52011-07-07 20:50:11 -0700244
Romain Guy8aa195d2013-06-04 18:00:09 -0700245 void bindTexture() const;
246 void generateTexture();
247 void allocateTexture();
248 void deleteTexture();
Romain Guyef09a212012-09-25 12:17:14 -0700249
250 /**
251 * When the caller frees the texture itself, the caller
252 * must call this method to tell this layer that it lost
253 * the texture.
254 */
Romain Guy8aa195d2013-06-04 18:00:09 -0700255 ANDROID_API void clearTexture();
Romain Guy2055aba2013-01-18 16:42:51 -0800256
Romain Guy9ace8f52011-07-07 20:50:11 -0700257 inline mat4& getTexTransform() {
258 return texTransform;
Romain Guy9fc27812011-04-27 14:21:41 -0700259 }
260
Romain Guy302a9df2011-08-16 13:55:02 -0700261 inline mat4& getTransform() {
262 return transform;
263 }
264
Chris Craik69e5adf2014-08-14 13:34:01 -0700265 void defer(const OpenGLRenderer& rootRenderer);
Romain Guye93482f2013-06-17 13:14:51 -0700266 void cancelDefer();
Romain Guy96885eb2013-03-26 15:05:58 -0700267 void flush();
Chris Craik69e5adf2014-08-14 13:34:01 -0700268 void render(const OpenGLRenderer& rootRenderer);
Romain Guy96885eb2013-03-26 15:05:58 -0700269
Romain Guy9fc27812011-04-27 14:21:41 -0700270 /**
Romain Guy8550c4c2010-10-08 15:49:53 -0700271 * Bounds of the layer.
Romain Guydda57022010-07-06 11:39:32 -0700272 */
273 Rect layer;
274 /**
Romain Guy8550c4c2010-10-08 15:49:53 -0700275 * Texture coordinates of the layer.
Romain Guydda57022010-07-06 11:39:32 -0700276 */
Romain Guy8550c4c2010-10-08 15:49:53 -0700277 Rect texCoords;
Romain Guyc3fedaf2013-01-29 17:26:25 -0800278 /**
279 * Clipping rectangle.
280 */
281 Rect clipRect;
Romain Guy8550c4c2010-10-08 15:49:53 -0700282
Romain Guydda57022010-07-06 11:39:32 -0700283 /**
Romain Guy5b3b3522010-10-27 18:57:51 -0700284 * Dirty region indicating what parts of the layer
285 * have been drawn.
286 */
287 Region region;
Romain Guy40667672011-03-18 14:34:03 -0700288 /**
289 * If the region is a rectangle, coordinates of the
290 * region are stored here.
291 */
292 Rect regionRect;
Romain Guy171c5922011-01-06 10:04:23 -0800293
294 /**
Romain Guyf219da52011-01-16 12:54:25 -0800295 * If the layer can be rendered as a mesh, this is non-null.
296 */
297 TextureVertex* mesh;
Romain Guyf219da52011-01-16 12:54:25 -0800298 GLsizei meshElementCount;
Romain Guyaa6c24c2011-04-28 18:40:04 -0700299
Romain Guy2bf68f02012-03-02 13:37:47 -0800300 /**
301 * Used for deferred updates.
302 */
303 bool deferredUpdateScheduled;
304 OpenGLRenderer* renderer;
Chris Craika7090e02014-06-20 16:01:00 -0700305 sp<RenderNode> renderNode;
Romain Guy2bf68f02012-03-02 13:37:47 -0800306 Rect dirtyRect;
Romain Guy5bb3c732012-11-29 17:52:58 -0800307 bool debugDrawUpdate;
Chris Craik34416ea2013-04-15 16:08:28 -0700308 bool hasDrawnSinceUpdate;
John Reck443a7142014-09-04 17:40:05 -0700309 bool wasBuildLayered;
Romain Guy2bf68f02012-03-02 13:37:47 -0800310
Romain Guy9ace8f52011-07-07 20:50:11 -0700311private:
John Reck668f0e32014-03-26 15:10:40 -0700312 void requireRenderer();
Chris Craik69e5adf2014-08-14 13:34:01 -0700313 void updateLightPosFromRenderer(const OpenGLRenderer& rootRenderer);
John Reck668f0e32014-03-26 15:10:40 -0700314
Romain Guy8aa195d2013-06-04 18:00:09 -0700315 Caches& caches;
316
John Reck3b202512014-06-23 13:13:08 -0700317 RenderState& renderState;
318
Romain Guy9ace8f52011-07-07 20:50:11 -0700319 /**
320 * Name of the FBO used to render the layer. If the name is 0
321 * this layer is not backed by an FBO, but a simple texture.
322 */
323 GLuint fbo;
324
325 /**
Romain Guy3bbacf22013-02-06 16:51:04 -0800326 * The render buffer used as the stencil buffer.
Romain Guy8ce00302013-01-15 18:51:42 -0800327 */
Romain Guy3bbacf22013-02-06 16:51:04 -0800328 RenderBuffer* stencil;
Romain Guy8ce00302013-01-15 18:51:42 -0800329
330 /**
Romain Guy9ace8f52011-07-07 20:50:11 -0700331 * Indicates whether this layer has been used already.
332 */
333 bool empty;
334
335 /**
336 * The texture backing this layer.
337 */
338 Texture texture;
339
Romain Guyaa6c24c2011-04-28 18:40:04 -0700340 /**
341 * If set to true (by default), the layer can be reused.
342 */
Romain Guy9ace8f52011-07-07 20:50:11 -0700343 bool cacheable;
Romain Guyaa6c24c2011-04-28 18:40:04 -0700344
345 /**
346 * When set to true, this layer must be treated as a texture
347 * layer.
348 */
Romain Guy9ace8f52011-07-07 20:50:11 -0700349 bool textureLayer;
350
351 /**
Romain Guy7c25aab2012-10-18 15:05:02 -0700352 * When set to true, this layer is dirty and should be cleared
353 * before any rendering occurs.
354 */
355 bool dirty;
356
357 /**
Romain Guy9ace8f52011-07-07 20:50:11 -0700358 * Indicates the render target.
359 */
360 GLenum renderTarget;
361
362 /**
363 * Color filter used to draw this layer. Optional.
364 */
Derek Sollenberger76d3a1b2013-12-10 12:28:58 -0500365 SkColorFilter* colorFilter;
Romain Guy9ace8f52011-07-07 20:50:11 -0700366
367 /**
Chris Craik9757ac02014-02-25 18:50:17 -0800368 * Indicates raster data backing the layer is scaled, requiring filtration.
369 */
370 bool forceFilter;
371
372 /**
Romain Guy9ace8f52011-07-07 20:50:11 -0700373 * Opacity of the layer.
374 */
375 int alpha;
Chris Craik9757ac02014-02-25 18:50:17 -0800376
Romain Guy9ace8f52011-07-07 20:50:11 -0700377 /**
378 * Blending mode of the layer.
379 */
380 SkXfermode::Mode mode;
Romain Guyaa6c24c2011-04-28 18:40:04 -0700381
382 /**
383 * Optional texture coordinates transform.
384 */
385 mat4 texTransform;
Romain Guy8f0095c2011-05-02 17:24:22 -0700386
Romain Guy302a9df2011-08-16 13:55:02 -0700387 /**
388 * Optional transform.
389 */
390 mat4 transform;
391
Romain Guy96885eb2013-03-26 15:05:58 -0700392 /**
Chris Craik69e5adf2014-08-14 13:34:01 -0700393 * Cached transform of layer in window, updated only on creation / resize
394 */
395 mat4 cachedInvTransformInWindow;
396 bool rendererLightPosDirty;
397
398 /**
Romain Guy96885eb2013-03-26 15:05:58 -0700399 * Used to defer display lists when the layer is updated with a
400 * display list.
401 */
402 DeferredDisplayList* deferredList;
403
Chris Craik3f0854292014-04-15 16:18:08 -0700404 /**
405 * This convex path should be used to mask the layer's draw to the screen.
406 *
407 * Data not owned/managed by layer object.
408 */
409 const SkPath* convexMask;
410
Romain Guydda57022010-07-06 11:39:32 -0700411}; // struct Layer
412
413}; // namespace uirenderer
414}; // namespace android
415
Romain Guy5b3b3522010-10-27 18:57:51 -0700416#endif // ANDROID_HWUI_LAYER_H