Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 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 | |
Romain Guy | 5b3b352 | 2010-10-27 18:57:51 -0700 | [diff] [blame] | 17 | #ifndef ANDROID_HWUI_SNAPSHOT_H |
| 18 | #define ANDROID_HWUI_SNAPSHOT_H |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 19 | |
| 20 | #include <GLES2/gl2.h> |
| 21 | #include <GLES2/gl2ext.h> |
| 22 | |
Chris Craik | deeda3d | 2014-05-05 19:09:33 -0700 | [diff] [blame] | 23 | #include <utils/LinearAllocator.h> |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 24 | #include <utils/RefBase.h> |
Romain Guy | 5b3b352 | 2010-10-27 18:57:51 -0700 | [diff] [blame] | 25 | #include <ui/Region.h> |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 26 | |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 27 | #include <SkRegion.h> |
Romain Guy | 079ba2c | 2010-07-16 14:12:24 -0700 | [diff] [blame] | 28 | |
Romain Guy | dda57020 | 2010-07-06 11:39:32 -0700 | [diff] [blame] | 29 | #include "Layer.h" |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 30 | #include "Matrix.h" |
Chris Craik | deeda3d | 2014-05-05 19:09:33 -0700 | [diff] [blame] | 31 | #include "Outline.h" |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 32 | #include "Rect.h" |
Chris Craik | deeda3d | 2014-05-05 19:09:33 -0700 | [diff] [blame] | 33 | #include "utils/Macros.h" |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 34 | |
| 35 | namespace android { |
| 36 | namespace uirenderer { |
| 37 | |
| 38 | /** |
Chris Craik | deeda3d | 2014-05-05 19:09:33 -0700 | [diff] [blame] | 39 | * Temporary structure holding information for a single outline clip. |
| 40 | * |
| 41 | * These structures are treated as immutable once created, and only exist for a single frame, which |
| 42 | * is why they may only be allocated with a LinearAllocator. |
| 43 | */ |
| 44 | class RoundRectClipState { |
| 45 | public: |
| 46 | /** static void* operator new(size_t size); PURPOSELY OMITTED, allocator only **/ |
| 47 | static void* operator new(size_t size, LinearAllocator& allocator) { |
| 48 | return allocator.alloc(size); |
| 49 | } |
| 50 | |
| 51 | bool areaRequiresRoundRectClip(const Rect& rect) const { |
| 52 | return rect.intersects(dangerRects[0]) |
| 53 | || rect.intersects(dangerRects[1]) |
| 54 | || rect.intersects(dangerRects[2]) |
| 55 | || rect.intersects(dangerRects[3]); |
| 56 | } |
| 57 | |
| 58 | Matrix4 matrix; |
| 59 | Rect dangerRects[4]; |
Chris Craik | af4d04c | 2014-07-29 12:50:14 -0700 | [diff] [blame] | 60 | Rect innerRect; |
| 61 | float radius; |
Chris Craik | deeda3d | 2014-05-05 19:09:33 -0700 | [diff] [blame] | 62 | }; |
| 63 | |
| 64 | /** |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 65 | * A snapshot holds information about the current state of the rendering |
| 66 | * surface. A snapshot is usually created whenever the user calls save() |
| 67 | * and discarded when the user calls restore(). Once a snapshot is created, |
| 68 | * it can hold information for deferred rendering. |
| 69 | * |
| 70 | * Each snapshot has a link to a previous snapshot, indicating the previous |
| 71 | * state of the renderer. |
| 72 | */ |
| 73 | class Snapshot: public LightRefBase<Snapshot> { |
| 74 | public: |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 75 | |
| 76 | Snapshot(); |
| 77 | Snapshot(const sp<Snapshot>& s, int saveFlags); |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 78 | |
| 79 | /** |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 80 | * Various flags set on ::flags. |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 81 | */ |
| 82 | enum Flags { |
| 83 | /** |
| 84 | * Indicates that the clip region was modified. When this |
| 85 | * snapshot is restored so must the clip. |
| 86 | */ |
| 87 | kFlagClipSet = 0x1, |
| 88 | /** |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 89 | * Indicates that this snapshot was created when saving |
| 90 | * a new layer. |
| 91 | */ |
Romain Guy | 079ba2c | 2010-07-16 14:12:24 -0700 | [diff] [blame] | 92 | kFlagIsLayer = 0x2, |
Romain Guy | f86ef57 | 2010-07-01 11:05:42 -0700 | [diff] [blame] | 93 | /** |
Romain Guy | eb99356 | 2010-10-05 18:14:38 -0700 | [diff] [blame] | 94 | * Indicates that this snapshot is a special type of layer |
| 95 | * backed by an FBO. This flag only makes sense when the |
| 96 | * flag kFlagIsLayer is also set. |
Chris Craik | a64a2be | 2014-05-14 14:17:01 -0700 | [diff] [blame] | 97 | * |
| 98 | * Viewport has been modified to fit the new Fbo, and must be |
| 99 | * restored when this snapshot is restored. |
Romain Guy | eb99356 | 2010-10-05 18:14:38 -0700 | [diff] [blame] | 100 | */ |
| 101 | kFlagIsFboLayer = 0x4, |
| 102 | /** |
Romain Guy | 5b3b352 | 2010-10-27 18:57:51 -0700 | [diff] [blame] | 103 | * Indicates that this snapshot or an ancestor snapshot is |
| 104 | * an FBO layer. |
| 105 | */ |
Chris Craik | a64a2be | 2014-05-14 14:17:01 -0700 | [diff] [blame] | 106 | kFlagFboTarget = 0x8, |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 107 | }; |
| 108 | |
| 109 | /** |
Romain Guy | f607bdc | 2010-09-10 19:20:06 -0700 | [diff] [blame] | 110 | * Modifies the current clip with the new clip rectangle and |
| 111 | * the specified operation. The specified rectangle is transformed |
| 112 | * by this snapshot's trasnformation. |
Romain Guy | 3d58c03 | 2010-07-14 16:34:53 -0700 | [diff] [blame] | 113 | */ |
Romain Guy | f607bdc | 2010-09-10 19:20:06 -0700 | [diff] [blame] | 114 | bool clip(float left, float top, float right, float bottom, |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 115 | SkRegion::Op op = SkRegion::kIntersect_Op); |
Romain Guy | f607bdc | 2010-09-10 19:20:06 -0700 | [diff] [blame] | 116 | |
| 117 | /** |
| 118 | * Modifies the current clip with the new clip rectangle and |
| 119 | * the specified operation. The specified rectangle is considered |
| 120 | * already transformed. |
| 121 | */ |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 122 | bool clipTransformed(const Rect& r, SkRegion::Op op = SkRegion::kIntersect_Op); |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 123 | |
| 124 | /** |
Romain Guy | 8ce0030 | 2013-01-15 18:51:42 -0800 | [diff] [blame] | 125 | * Modifies the current clip with the specified region and operation. |
| 126 | * The specified region is considered already transformed. |
| 127 | */ |
| 128 | bool clipRegionTransformed(const SkRegion& region, SkRegion::Op op); |
| 129 | |
| 130 | /** |
Romain Guy | d27977d | 2010-07-14 19:18:51 -0700 | [diff] [blame] | 131 | * Sets the current clip. |
| 132 | */ |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 133 | void setClip(float left, float top, float right, float bottom); |
Romain Guy | 079ba2c | 2010-07-16 14:12:24 -0700 | [diff] [blame] | 134 | |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 135 | /** |
| 136 | * Returns the current clip in local coordinates. The clip rect is |
| 137 | * transformed by the inverse transform matrix. |
| 138 | */ |
Ben Cheng | 1a49868 | 2014-05-17 15:37:26 -0700 | [diff] [blame] | 139 | ANDROID_API const Rect& getLocalClip(); |
Chris Craik | 3f085429 | 2014-04-15 16:18:08 -0700 | [diff] [blame] | 140 | |
| 141 | /** |
| 142 | * Returns the current clip in render target coordinates. |
| 143 | */ |
| 144 | const Rect& getRenderTargetClip() { return *clipRect; } |
Romain Guy | 959c91f | 2010-08-11 19:35:53 -0700 | [diff] [blame] | 145 | |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 146 | /** |
| 147 | * Resets the clip to the specified rect. |
| 148 | */ |
| 149 | void resetClip(float left, float top, float right, float bottom); |
Romain Guy | 959c91f | 2010-08-11 19:35:53 -0700 | [diff] [blame] | 150 | |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 151 | /** |
| 152 | * Resets the current transform to a pure 3D translation. |
| 153 | */ |
| 154 | void resetTransform(float x, float y, float z); |
Romain Guy | 8aef54f | 2010-09-01 15:13:49 -0700 | [diff] [blame] | 155 | |
Chris Craik | a64a2be | 2014-05-14 14:17:01 -0700 | [diff] [blame] | 156 | void initializeViewport(int width, int height) { |
| 157 | mViewportData.initialize(width, height); |
| 158 | } |
| 159 | |
| 160 | int getViewportWidth() const { return mViewportData.mWidth; } |
| 161 | int getViewportHeight() const { return mViewportData.mHeight; } |
| 162 | const Matrix4& getOrthoMatrix() const { return mViewportData.mOrthoMatrix; } |
| 163 | |
Chris Craik | 69e5adf | 2014-08-14 13:34:01 -0700 | [diff] [blame^] | 164 | const Vector3& getRelativeLightCenter() const { return mRelativeLightCenter; } |
| 165 | void setRelativeLightCenter(const Vector3& lightCenter) { mRelativeLightCenter = lightCenter; } |
| 166 | |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 167 | /** |
Chris Craik | deeda3d | 2014-05-05 19:09:33 -0700 | [diff] [blame] | 168 | * Sets (and replaces) the current clipping outline |
| 169 | */ |
Chris Craik | af4d04c | 2014-07-29 12:50:14 -0700 | [diff] [blame] | 170 | void setClippingRoundRect(LinearAllocator& allocator, const Rect& bounds, float radius); |
Chris Craik | deeda3d | 2014-05-05 19:09:33 -0700 | [diff] [blame] | 171 | |
| 172 | /** |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 173 | * Indicates whether this snapshot should be ignored. A snapshot |
| 174 | * is typicalled ignored if its layer is invisible or empty. |
| 175 | */ |
| 176 | bool isIgnored() const; |
Romain Guy | af636eb | 2010-12-09 17:47:21 -0800 | [diff] [blame] | 177 | |
Romain Guy | 8b55f37 | 2010-08-18 17:10:07 -0700 | [diff] [blame] | 178 | /** |
Romain Guy | a3dc55f | 2012-09-28 13:55:44 -0700 | [diff] [blame] | 179 | * Indicates whether the current transform has perspective components. |
| 180 | */ |
| 181 | bool hasPerspectiveTransform() const; |
| 182 | |
| 183 | /** |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 184 | * Dirty flags. |
| 185 | */ |
| 186 | int flags; |
| 187 | |
| 188 | /** |
| 189 | * Previous snapshot. |
| 190 | */ |
| 191 | sp<Snapshot> previous; |
| 192 | |
| 193 | /** |
Romain Guy | 8ce0030 | 2013-01-15 18:51:42 -0800 | [diff] [blame] | 194 | * A pointer to the currently active layer. |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 195 | * |
| 196 | * This snapshot does not own the layer, this pointer must not be freed. |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 197 | */ |
Romain Guy | dda57020 | 2010-07-06 11:39:32 -0700 | [diff] [blame] | 198 | Layer* layer; |
Romain Guy | f86ef57 | 2010-07-01 11:05:42 -0700 | [diff] [blame] | 199 | |
Romain Guy | 8aef54f | 2010-09-01 15:13:49 -0700 | [diff] [blame] | 200 | /** |
Romain Guy | 421458a | 2011-11-21 15:14:37 -0800 | [diff] [blame] | 201 | * Target FBO used for rendering. Set to 0 when rendering directly |
| 202 | * into the framebuffer. |
Romain Guy | eb99356 | 2010-10-05 18:14:38 -0700 | [diff] [blame] | 203 | */ |
| 204 | GLuint fbo; |
| 205 | |
| 206 | /** |
Romain Guy | dbc26d2 | 2010-10-11 17:58:29 -0700 | [diff] [blame] | 207 | * Indicates that this snapshot is invisible and nothing should be drawn |
Romain Guy | af636eb | 2010-12-09 17:47:21 -0800 | [diff] [blame] | 208 | * inside it. This flag is set only when the layer clips drawing to its |
| 209 | * bounds and is passed to subsequent snapshots. |
Romain Guy | dbc26d2 | 2010-10-11 17:58:29 -0700 | [diff] [blame] | 210 | */ |
| 211 | bool invisible; |
| 212 | |
| 213 | /** |
Romain Guy | af636eb | 2010-12-09 17:47:21 -0800 | [diff] [blame] | 214 | * If set to true, the layer will not be composited. This is similar to |
| 215 | * invisible but this flag is not passed to subsequent snapshots. |
| 216 | */ |
| 217 | bool empty; |
| 218 | |
| 219 | /** |
Romain Guy | 8aef54f | 2010-09-01 15:13:49 -0700 | [diff] [blame] | 220 | * Local transformation. Holds the current translation, scale and |
| 221 | * rotation values. |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 222 | * |
| 223 | * This is a reference to a matrix owned by this snapshot or another |
| 224 | * snapshot. This pointer must not be freed. See ::mTransformRoot. |
Romain Guy | 8aef54f | 2010-09-01 15:13:49 -0700 | [diff] [blame] | 225 | */ |
| 226 | mat4* transform; |
| 227 | |
| 228 | /** |
Romain Guy | 967e2bf | 2012-02-07 17:04:34 -0800 | [diff] [blame] | 229 | * Current clip rect. The clip is stored in canvas-space coordinates, |
Romain Guy | 8aef54f | 2010-09-01 15:13:49 -0700 | [diff] [blame] | 230 | * (screen-space coordinates in the regular case.) |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 231 | * |
| 232 | * This is a reference to a rect owned by this snapshot or another |
| 233 | * snapshot. This pointer must not be freed. See ::mClipRectRoot. |
Romain Guy | 8aef54f | 2010-09-01 15:13:49 -0700 | [diff] [blame] | 234 | */ |
| 235 | Rect* clipRect; |
| 236 | |
Romain Guy | 5b3b352 | 2010-10-27 18:57:51 -0700 | [diff] [blame] | 237 | /** |
Romain Guy | 967e2bf | 2012-02-07 17:04:34 -0800 | [diff] [blame] | 238 | * Current clip region. The clip is stored in canvas-space coordinates, |
| 239 | * (screen-space coordinates in the regular case.) |
| 240 | * |
| 241 | * This is a reference to a region owned by this snapshot or another |
| 242 | * snapshot. This pointer must not be freed. See ::mClipRegionRoot. |
Romain Guy | 967e2bf | 2012-02-07 17:04:34 -0800 | [diff] [blame] | 243 | */ |
Romain Guy | 0baaac5 | 2012-08-31 20:31:01 -0700 | [diff] [blame] | 244 | SkRegion* clipRegion; |
Romain Guy | 967e2bf | 2012-02-07 17:04:34 -0800 | [diff] [blame] | 245 | |
| 246 | /** |
Romain Guy | f219da5 | 2011-01-16 12:54:25 -0800 | [diff] [blame] | 247 | * The ancestor layer's dirty region. |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 248 | * |
| 249 | * This is a reference to a region owned by a layer. This pointer must |
| 250 | * not be freed. |
Romain Guy | 5b3b352 | 2010-10-27 18:57:51 -0700 | [diff] [blame] | 251 | */ |
| 252 | Region* region; |
| 253 | |
Chet Haase | db8c9a6 | 2012-03-21 18:54:18 -0700 | [diff] [blame] | 254 | /** |
| 255 | * Current alpha value. This value is 1 by default, but may be set by a DisplayList which |
| 256 | * has translucent rendering in a non-overlapping View. This value will be used by |
| 257 | * the renderer to set the alpha in the current color being used for ensuing drawing |
| 258 | * operations. The value is inherited by child snapshots because the same value should |
| 259 | * be applied to descendents of the current DisplayList (for example, a TextView contains |
| 260 | * the base alpha value which should be applied to the child DisplayLists used for drawing |
| 261 | * the actual text). |
| 262 | */ |
| 263 | float alpha; |
| 264 | |
Chris Craik | deeda3d | 2014-05-05 19:09:33 -0700 | [diff] [blame] | 265 | /** |
| 266 | * Current clipping round rect. |
| 267 | * |
| 268 | * Points to data not owned by the snapshot, and may only be replaced by subsequent RR clips, |
| 269 | * never modified. |
| 270 | */ |
| 271 | const RoundRectClipState* roundRectClipState; |
| 272 | |
Chris Craik | 5f80362 | 2013-03-21 14:39:04 -0700 | [diff] [blame] | 273 | void dump() const; |
| 274 | |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 275 | private: |
Chris Craik | a64a2be | 2014-05-14 14:17:01 -0700 | [diff] [blame] | 276 | struct ViewportData { |
Chris Craik | 9241975 | 2014-05-15 13:21:28 -0700 | [diff] [blame] | 277 | ViewportData() : mWidth(0), mHeight(0) {} |
Chris Craik | a64a2be | 2014-05-14 14:17:01 -0700 | [diff] [blame] | 278 | void initialize(int width, int height) { |
| 279 | mWidth = width; |
| 280 | mHeight = height; |
| 281 | mOrthoMatrix.loadOrtho(0, width, height, 0, -1, 1); |
| 282 | } |
| 283 | |
| 284 | /* |
| 285 | * Width and height of current viewport. |
| 286 | * |
| 287 | * The viewport is always defined to be (0, 0, width, height). |
| 288 | */ |
| 289 | int mWidth; |
| 290 | int mHeight; |
| 291 | /** |
| 292 | * Contains the current orthographic, projection matrix. |
| 293 | */ |
| 294 | mat4 mOrthoMatrix; |
| 295 | }; |
| 296 | |
Romain Guy | 967e2bf | 2012-02-07 17:04:34 -0800 | [diff] [blame] | 297 | void ensureClipRegion(); |
| 298 | void copyClipRectFromRegion(); |
| 299 | |
Romain Guy | 0baaac5 | 2012-08-31 20:31:01 -0700 | [diff] [blame] | 300 | bool clipRegionOp(float left, float top, float right, float bottom, SkRegion::Op op); |
Romain Guy | 967e2bf | 2012-02-07 17:04:34 -0800 | [diff] [blame] | 301 | |
Romain Guy | 8aef54f | 2010-09-01 15:13:49 -0700 | [diff] [blame] | 302 | mat4 mTransformRoot; |
| 303 | Rect mClipRectRoot; |
Chris Craik | 3f085429 | 2014-04-15 16:18:08 -0700 | [diff] [blame] | 304 | Rect mLocalClip; // don't use directly, call getLocalClip() which initializes this |
Romain Guy | 079ba2c | 2010-07-16 14:12:24 -0700 | [diff] [blame] | 305 | |
Romain Guy | 0baaac5 | 2012-08-31 20:31:01 -0700 | [diff] [blame] | 306 | SkRegion mClipRegionRoot; |
Chris Craik | a64a2be | 2014-05-14 14:17:01 -0700 | [diff] [blame] | 307 | ViewportData mViewportData; |
Chris Craik | 69e5adf | 2014-08-14 13:34:01 -0700 | [diff] [blame^] | 308 | Vector3 mRelativeLightCenter; |
Romain Guy | 967e2bf | 2012-02-07 17:04:34 -0800 | [diff] [blame] | 309 | |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 310 | }; // class Snapshot |
| 311 | |
| 312 | }; // namespace uirenderer |
| 313 | }; // namespace android |
| 314 | |
Romain Guy | 5b3b352 | 2010-10-27 18:57:51 -0700 | [diff] [blame] | 315 | #endif // ANDROID_HWUI_SNAPSHOT_H |