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 | |
| 23 | #include <utils/RefBase.h> |
Romain Guy | 5b3b352 | 2010-10-27 18:57:51 -0700 | [diff] [blame] | 24 | #include <ui/Region.h> |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 25 | |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 26 | #include <SkRegion.h> |
Romain Guy | 079ba2c | 2010-07-16 14:12:24 -0700 | [diff] [blame] | 27 | |
Romain Guy | dda57020 | 2010-07-06 11:39:32 -0700 | [diff] [blame] | 28 | #include "Layer.h" |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 29 | #include "Matrix.h" |
| 30 | #include "Rect.h" |
| 31 | |
| 32 | namespace android { |
| 33 | namespace uirenderer { |
| 34 | |
| 35 | /** |
| 36 | * A snapshot holds information about the current state of the rendering |
| 37 | * surface. A snapshot is usually created whenever the user calls save() |
| 38 | * and discarded when the user calls restore(). Once a snapshot is created, |
| 39 | * it can hold information for deferred rendering. |
| 40 | * |
| 41 | * Each snapshot has a link to a previous snapshot, indicating the previous |
| 42 | * state of the renderer. |
| 43 | */ |
| 44 | class Snapshot: public LightRefBase<Snapshot> { |
| 45 | public: |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 46 | |
| 47 | Snapshot(); |
| 48 | Snapshot(const sp<Snapshot>& s, int saveFlags); |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 49 | |
| 50 | /** |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 51 | * Various flags set on ::flags. |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 52 | */ |
| 53 | enum Flags { |
| 54 | /** |
| 55 | * Indicates that the clip region was modified. When this |
| 56 | * snapshot is restored so must the clip. |
| 57 | */ |
| 58 | kFlagClipSet = 0x1, |
| 59 | /** |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 60 | * Indicates that this snapshot was created when saving |
| 61 | * a new layer. |
| 62 | */ |
Romain Guy | 079ba2c | 2010-07-16 14:12:24 -0700 | [diff] [blame] | 63 | kFlagIsLayer = 0x2, |
Romain Guy | f86ef57 | 2010-07-01 11:05:42 -0700 | [diff] [blame] | 64 | /** |
Romain Guy | eb99356 | 2010-10-05 18:14:38 -0700 | [diff] [blame] | 65 | * Indicates that this snapshot is a special type of layer |
| 66 | * backed by an FBO. This flag only makes sense when the |
| 67 | * flag kFlagIsLayer is also set. |
| 68 | */ |
| 69 | kFlagIsFboLayer = 0x4, |
| 70 | /** |
Romain Guy | eb99356 | 2010-10-05 18:14:38 -0700 | [diff] [blame] | 71 | * Indicates that this snapshot has changed the ortho matrix. |
| 72 | */ |
Romain Guy | ed7a8fc | 2011-10-04 19:21:27 -0700 | [diff] [blame] | 73 | kFlagDirtyOrtho = 0x8, |
Romain Guy | 5b3b352 | 2010-10-27 18:57:51 -0700 | [diff] [blame] | 74 | /** |
| 75 | * Indicates that this snapshot or an ancestor snapshot is |
| 76 | * an FBO layer. |
| 77 | */ |
Romain Guy | ed7a8fc | 2011-10-04 19:21:27 -0700 | [diff] [blame] | 78 | kFlagFboTarget = 0x10 |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 79 | }; |
| 80 | |
| 81 | /** |
Romain Guy | f607bdc | 2010-09-10 19:20:06 -0700 | [diff] [blame] | 82 | * Modifies the current clip with the new clip rectangle and |
| 83 | * the specified operation. The specified rectangle is transformed |
| 84 | * by this snapshot's trasnformation. |
Romain Guy | 3d58c03 | 2010-07-14 16:34:53 -0700 | [diff] [blame] | 85 | */ |
Romain Guy | f607bdc | 2010-09-10 19:20:06 -0700 | [diff] [blame] | 86 | bool clip(float left, float top, float right, float bottom, |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 87 | SkRegion::Op op = SkRegion::kIntersect_Op); |
Romain Guy | f607bdc | 2010-09-10 19:20:06 -0700 | [diff] [blame] | 88 | |
| 89 | /** |
| 90 | * Modifies the current clip with the new clip rectangle and |
| 91 | * the specified operation. The specified rectangle is considered |
| 92 | * already transformed. |
| 93 | */ |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 94 | bool clipTransformed(const Rect& r, SkRegion::Op op = SkRegion::kIntersect_Op); |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 95 | |
| 96 | /** |
Romain Guy | d27977d | 2010-07-14 19:18:51 -0700 | [diff] [blame] | 97 | * Sets the current clip. |
| 98 | */ |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 99 | void setClip(float left, float top, float right, float bottom); |
Romain Guy | 079ba2c | 2010-07-16 14:12:24 -0700 | [diff] [blame] | 100 | |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 101 | /** |
| 102 | * Returns the current clip in local coordinates. The clip rect is |
| 103 | * transformed by the inverse transform matrix. |
| 104 | */ |
| 105 | const Rect& getLocalClip(); |
Romain Guy | 959c91f | 2010-08-11 19:35:53 -0700 | [diff] [blame] | 106 | |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 107 | /** |
| 108 | * Resets the clip to the specified rect. |
| 109 | */ |
| 110 | void resetClip(float left, float top, float right, float bottom); |
Romain Guy | 959c91f | 2010-08-11 19:35:53 -0700 | [diff] [blame] | 111 | |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 112 | /** |
| 113 | * Resets the current transform to a pure 3D translation. |
| 114 | */ |
| 115 | void resetTransform(float x, float y, float z); |
Romain Guy | 8aef54f | 2010-09-01 15:13:49 -0700 | [diff] [blame] | 116 | |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 117 | /** |
| 118 | * Indicates whether this snapshot should be ignored. A snapshot |
| 119 | * is typicalled ignored if its layer is invisible or empty. |
| 120 | */ |
| 121 | bool isIgnored() const; |
Romain Guy | af636eb | 2010-12-09 17:47:21 -0800 | [diff] [blame] | 122 | |
Romain Guy | 8b55f37 | 2010-08-18 17:10:07 -0700 | [diff] [blame] | 123 | /** |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 124 | * Dirty flags. |
| 125 | */ |
| 126 | int flags; |
| 127 | |
| 128 | /** |
| 129 | * Previous snapshot. |
| 130 | */ |
| 131 | sp<Snapshot> previous; |
| 132 | |
| 133 | /** |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 134 | * Only set when the flag kFlagIsLayer is set. |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 135 | * |
| 136 | * 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] | 137 | */ |
Romain Guy | dda57020 | 2010-07-06 11:39:32 -0700 | [diff] [blame] | 138 | Layer* layer; |
Romain Guy | f86ef57 | 2010-07-01 11:05:42 -0700 | [diff] [blame] | 139 | |
Romain Guy | 8aef54f | 2010-09-01 15:13:49 -0700 | [diff] [blame] | 140 | /** |
Romain Guy | 421458a | 2011-11-21 15:14:37 -0800 | [diff] [blame] | 141 | * Target FBO used for rendering. Set to 0 when rendering directly |
| 142 | * into the framebuffer. |
Romain Guy | eb99356 | 2010-10-05 18:14:38 -0700 | [diff] [blame] | 143 | */ |
| 144 | GLuint fbo; |
| 145 | |
| 146 | /** |
Romain Guy | dbc26d2 | 2010-10-11 17:58:29 -0700 | [diff] [blame] | 147 | * Indicates that this snapshot is invisible and nothing should be drawn |
Romain Guy | af636eb | 2010-12-09 17:47:21 -0800 | [diff] [blame] | 148 | * inside it. This flag is set only when the layer clips drawing to its |
| 149 | * bounds and is passed to subsequent snapshots. |
Romain Guy | dbc26d2 | 2010-10-11 17:58:29 -0700 | [diff] [blame] | 150 | */ |
| 151 | bool invisible; |
| 152 | |
| 153 | /** |
Romain Guy | af636eb | 2010-12-09 17:47:21 -0800 | [diff] [blame] | 154 | * If set to true, the layer will not be composited. This is similar to |
| 155 | * invisible but this flag is not passed to subsequent snapshots. |
| 156 | */ |
| 157 | bool empty; |
| 158 | |
| 159 | /** |
Romain Guy | eb99356 | 2010-10-05 18:14:38 -0700 | [diff] [blame] | 160 | * Current viewport. |
| 161 | */ |
| 162 | Rect viewport; |
| 163 | |
| 164 | /** |
| 165 | * Height of the framebuffer the snapshot is rendering into. |
| 166 | */ |
| 167 | int height; |
| 168 | |
| 169 | /** |
| 170 | * Contains the previous ortho matrix. |
| 171 | */ |
| 172 | mat4 orthoMatrix; |
| 173 | |
| 174 | /** |
Romain Guy | 8aef54f | 2010-09-01 15:13:49 -0700 | [diff] [blame] | 175 | * Local transformation. Holds the current translation, scale and |
| 176 | * rotation values. |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 177 | * |
| 178 | * This is a reference to a matrix owned by this snapshot or another |
| 179 | * snapshot. This pointer must not be freed. See ::mTransformRoot. |
Romain Guy | 8aef54f | 2010-09-01 15:13:49 -0700 | [diff] [blame] | 180 | */ |
| 181 | mat4* transform; |
| 182 | |
| 183 | /** |
Romain Guy | 967e2bf | 2012-02-07 17:04:34 -0800 | [diff] [blame] | 184 | * Current clip rect. The clip is stored in canvas-space coordinates, |
Romain Guy | 8aef54f | 2010-09-01 15:13:49 -0700 | [diff] [blame] | 185 | * (screen-space coordinates in the regular case.) |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 186 | * |
| 187 | * This is a reference to a rect owned by this snapshot or another |
| 188 | * snapshot. This pointer must not be freed. See ::mClipRectRoot. |
Romain Guy | 8aef54f | 2010-09-01 15:13:49 -0700 | [diff] [blame] | 189 | */ |
| 190 | Rect* clipRect; |
| 191 | |
Romain Guy | 5b3b352 | 2010-10-27 18:57:51 -0700 | [diff] [blame] | 192 | /** |
Romain Guy | 967e2bf | 2012-02-07 17:04:34 -0800 | [diff] [blame] | 193 | * Current clip region. The clip is stored in canvas-space coordinates, |
| 194 | * (screen-space coordinates in the regular case.) |
| 195 | * |
| 196 | * This is a reference to a region owned by this snapshot or another |
| 197 | * snapshot. This pointer must not be freed. See ::mClipRegionRoot. |
| 198 | * |
| 199 | * This field is used only if STENCIL_BUFFER_SIZE is > 0. |
| 200 | */ |
| 201 | Region* clipRegion; |
| 202 | |
| 203 | /** |
Romain Guy | f219da5 | 2011-01-16 12:54:25 -0800 | [diff] [blame] | 204 | * The ancestor layer's dirty region. |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 205 | * |
| 206 | * This is a reference to a region owned by a layer. This pointer must |
| 207 | * not be freed. |
Romain Guy | 5b3b352 | 2010-10-27 18:57:51 -0700 | [diff] [blame] | 208 | */ |
| 209 | Region* region; |
| 210 | |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 211 | private: |
Romain Guy | 967e2bf | 2012-02-07 17:04:34 -0800 | [diff] [blame] | 212 | void ensureClipRegion(); |
| 213 | void copyClipRectFromRegion(); |
| 214 | |
| 215 | bool clipRegionOr(float left, float top, float right, float bottom); |
| 216 | bool clipRegionXor(float left, float top, float right, float bottom); |
| 217 | bool clipRegionAnd(float left, float top, float right, float bottom); |
| 218 | bool clipRegionNand(float left, float top, float right, float bottom); |
| 219 | |
Romain Guy | 8aef54f | 2010-09-01 15:13:49 -0700 | [diff] [blame] | 220 | mat4 mTransformRoot; |
| 221 | Rect mClipRectRoot; |
| 222 | Rect mLocalClip; |
Romain Guy | 079ba2c | 2010-07-16 14:12:24 -0700 | [diff] [blame] | 223 | |
Romain Guy | 967e2bf | 2012-02-07 17:04:34 -0800 | [diff] [blame] | 224 | #if STENCIL_BUFFER_SIZE |
| 225 | Region mClipRegionRoot; |
| 226 | #endif |
| 227 | |
Romain Guy | 5cbbce5 | 2010-06-27 22:59:20 -0700 | [diff] [blame] | 228 | }; // class Snapshot |
| 229 | |
| 230 | }; // namespace uirenderer |
| 231 | }; // namespace android |
| 232 | |
Romain Guy | 5b3b352 | 2010-10-27 18:57:51 -0700 | [diff] [blame] | 233 | #endif // ANDROID_HWUI_SNAPSHOT_H |