Snapshot.h revision ae5575b3421c8fbe590ab046d7d5f2b36ecfd821
15cbbce535744b89df5ecea95de21ee3733298260Romain Guy/* 25cbbce535744b89df5ecea95de21ee3733298260Romain Guy * Copyright (C) 2010 The Android Open Source Project 35cbbce535744b89df5ecea95de21ee3733298260Romain Guy * 45cbbce535744b89df5ecea95de21ee3733298260Romain Guy * Licensed under the Apache License, Version 2.0 (the "License"); 55cbbce535744b89df5ecea95de21ee3733298260Romain Guy * you may not use this file except in compliance with the License. 65cbbce535744b89df5ecea95de21ee3733298260Romain Guy * You may obtain a copy of the License at 75cbbce535744b89df5ecea95de21ee3733298260Romain Guy * 85cbbce535744b89df5ecea95de21ee3733298260Romain Guy * http://www.apache.org/licenses/LICENSE-2.0 95cbbce535744b89df5ecea95de21ee3733298260Romain Guy * 105cbbce535744b89df5ecea95de21ee3733298260Romain Guy * Unless required by applicable law or agreed to in writing, software 115cbbce535744b89df5ecea95de21ee3733298260Romain Guy * distributed under the License is distributed on an "AS IS" BASIS, 125cbbce535744b89df5ecea95de21ee3733298260Romain Guy * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 135cbbce535744b89df5ecea95de21ee3733298260Romain Guy * See the License for the specific language governing permissions and 145cbbce535744b89df5ecea95de21ee3733298260Romain Guy * limitations under the License. 155cbbce535744b89df5ecea95de21ee3733298260Romain Guy */ 165cbbce535744b89df5ecea95de21ee3733298260Romain Guy 175cbbce535744b89df5ecea95de21ee3733298260Romain Guy#ifndef ANDROID_UI_SNAPSHOT_H 185cbbce535744b89df5ecea95de21ee3733298260Romain Guy#define ANDROID_UI_SNAPSHOT_H 195cbbce535744b89df5ecea95de21ee3733298260Romain Guy 205cbbce535744b89df5ecea95de21ee3733298260Romain Guy#include <GLES2/gl2.h> 215cbbce535744b89df5ecea95de21ee3733298260Romain Guy#include <GLES2/gl2ext.h> 225cbbce535744b89df5ecea95de21ee3733298260Romain Guy 235cbbce535744b89df5ecea95de21ee3733298260Romain Guy#include <utils/RefBase.h> 245cbbce535744b89df5ecea95de21ee3733298260Romain Guy 25079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy#include <SkRegion.h> 26079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy 27dda570201ac851dd85af3861f7e575721d3345daRomain Guy#include "Layer.h" 285cbbce535744b89df5ecea95de21ee3733298260Romain Guy#include "Matrix.h" 295cbbce535744b89df5ecea95de21ee3733298260Romain Guy#include "Rect.h" 305cbbce535744b89df5ecea95de21ee3733298260Romain Guy 315cbbce535744b89df5ecea95de21ee3733298260Romain Guynamespace android { 325cbbce535744b89df5ecea95de21ee3733298260Romain Guynamespace uirenderer { 335cbbce535744b89df5ecea95de21ee3733298260Romain Guy 345cbbce535744b89df5ecea95de21ee3733298260Romain Guy/** 355cbbce535744b89df5ecea95de21ee3733298260Romain Guy * A snapshot holds information about the current state of the rendering 365cbbce535744b89df5ecea95de21ee3733298260Romain Guy * surface. A snapshot is usually created whenever the user calls save() 375cbbce535744b89df5ecea95de21ee3733298260Romain Guy * and discarded when the user calls restore(). Once a snapshot is created, 385cbbce535744b89df5ecea95de21ee3733298260Romain Guy * it can hold information for deferred rendering. 395cbbce535744b89df5ecea95de21ee3733298260Romain Guy * 405cbbce535744b89df5ecea95de21ee3733298260Romain Guy * Each snapshot has a link to a previous snapshot, indicating the previous 415cbbce535744b89df5ecea95de21ee3733298260Romain Guy * state of the renderer. 425cbbce535744b89df5ecea95de21ee3733298260Romain Guy */ 435cbbce535744b89df5ecea95de21ee3733298260Romain Guyclass Snapshot: public LightRefBase<Snapshot> { 445cbbce535744b89df5ecea95de21ee3733298260Romain Guypublic: 4509147fbdc8206a0cac78bfe9083e7e15b3c5689cRomain Guy Snapshot(): flags(0), previous(NULL), layer(NULL), fbo(0) { } 465cbbce535744b89df5ecea95de21ee3733298260Romain Guy 475cbbce535744b89df5ecea95de21ee3733298260Romain Guy /** 485cbbce535744b89df5ecea95de21ee3733298260Romain Guy * Copies the specified snapshot. Only the transform and clip rectangle 495cbbce535744b89df5ecea95de21ee3733298260Romain Guy * are copied. The layer information is set to 0 and the transform is 505cbbce535744b89df5ecea95de21ee3733298260Romain Guy * assumed to be dirty. The specified snapshot is stored as the previous 515cbbce535744b89df5ecea95de21ee3733298260Romain Guy * snapshot. 525cbbce535744b89df5ecea95de21ee3733298260Romain Guy */ 53ae5575b3421c8fbe590ab046d7d5f2b36ecfd821Romain Guy Snapshot(const sp<Snapshot>& s): 54f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy height(s->height), 555cbbce535744b89df5ecea95de21ee3733298260Romain Guy transform(s->transform), 565cbbce535744b89df5ecea95de21ee3733298260Romain Guy clipRect(s->clipRect), 5709147fbdc8206a0cac78bfe9083e7e15b3c5689cRomain Guy flags(0), 585cbbce535744b89df5ecea95de21ee3733298260Romain Guy previous(s), 59dda570201ac851dd85af3861f7e575721d3345daRomain Guy layer(NULL), 6009147fbdc8206a0cac78bfe9083e7e15b3c5689cRomain Guy fbo(s->fbo), 6109147fbdc8206a0cac78bfe9083e7e15b3c5689cRomain Guy localClip(s->localClip) { 625cbbce535744b89df5ecea95de21ee3733298260Romain Guy } 635cbbce535744b89df5ecea95de21ee3733298260Romain Guy 645cbbce535744b89df5ecea95de21ee3733298260Romain Guy /** 655cbbce535744b89df5ecea95de21ee3733298260Romain Guy * Various flags set on #flags. 665cbbce535744b89df5ecea95de21ee3733298260Romain Guy */ 675cbbce535744b89df5ecea95de21ee3733298260Romain Guy enum Flags { 685cbbce535744b89df5ecea95de21ee3733298260Romain Guy /** 695cbbce535744b89df5ecea95de21ee3733298260Romain Guy * Indicates that the clip region was modified. When this 705cbbce535744b89df5ecea95de21ee3733298260Romain Guy * snapshot is restored so must the clip. 715cbbce535744b89df5ecea95de21ee3733298260Romain Guy */ 725cbbce535744b89df5ecea95de21ee3733298260Romain Guy kFlagClipSet = 0x1, 735cbbce535744b89df5ecea95de21ee3733298260Romain Guy /** 745cbbce535744b89df5ecea95de21ee3733298260Romain Guy * Indicates that this snapshot was created when saving 755cbbce535744b89df5ecea95de21ee3733298260Romain Guy * a new layer. 765cbbce535744b89df5ecea95de21ee3733298260Romain Guy */ 77079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy kFlagIsLayer = 0x2, 78f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy /** 79f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy * Indicates that this snapshot has changed the ortho matrix. 80f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy */ 81079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy kFlagDirtyOrtho = 0x4, 8209147fbdc8206a0cac78bfe9083e7e15b3c5689cRomain Guy /** 8309147fbdc8206a0cac78bfe9083e7e15b3c5689cRomain Guy * Indicates that the local clip should be recomputed. 8409147fbdc8206a0cac78bfe9083e7e15b3c5689cRomain Guy */ 8509147fbdc8206a0cac78bfe9083e7e15b3c5689cRomain Guy kFlagDirtyLocalClip = 0x8, 865cbbce535744b89df5ecea95de21ee3733298260Romain Guy }; 875cbbce535744b89df5ecea95de21ee3733298260Romain Guy 885cbbce535744b89df5ecea95de21ee3733298260Romain Guy /** 893d58c03de0d8877b36cdb78b0ca8b5cac7f600e2Romain Guy * Intersects the current clip with the new clip rectangle. 903d58c03de0d8877b36cdb78b0ca8b5cac7f600e2Romain Guy */ 91079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy bool clip(float left, float top, float right, float bottom, SkRegion::Op op) { 92079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy bool clipped = false; 93079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy 94079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy Rect r(left, top, right, bottom); 95079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy transform.mapRect(r); 96079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy 97079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy switch (op) { 987fac2e18339f765320d759e8d4c090f92431959eRomain Guy case SkRegion::kDifference_Op: 997fac2e18339f765320d759e8d4c090f92431959eRomain Guy break; 1007fac2e18339f765320d759e8d4c090f92431959eRomain Guy case SkRegion::kIntersect_Op: 1017fac2e18339f765320d759e8d4c090f92431959eRomain Guy clipped = clipRect.intersect(r); 1027fac2e18339f765320d759e8d4c090f92431959eRomain Guy break; 1037fac2e18339f765320d759e8d4c090f92431959eRomain Guy case SkRegion::kUnion_Op: 1047fac2e18339f765320d759e8d4c090f92431959eRomain Guy clipped = clipRect.unionWith(r); 1057fac2e18339f765320d759e8d4c090f92431959eRomain Guy break; 1067fac2e18339f765320d759e8d4c090f92431959eRomain Guy case SkRegion::kXOR_Op: 1077fac2e18339f765320d759e8d4c090f92431959eRomain Guy break; 1087fac2e18339f765320d759e8d4c090f92431959eRomain Guy case SkRegion::kReverseDifference_Op: 1097fac2e18339f765320d759e8d4c090f92431959eRomain Guy break; 1107fac2e18339f765320d759e8d4c090f92431959eRomain Guy case SkRegion::kReplace_Op: 1117fac2e18339f765320d759e8d4c090f92431959eRomain Guy clipRect.set(r); 1127fac2e18339f765320d759e8d4c090f92431959eRomain Guy clipped = true; 1137fac2e18339f765320d759e8d4c090f92431959eRomain Guy break; 1145cbbce535744b89df5ecea95de21ee3733298260Romain Guy } 115079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy 116079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy if (clipped) { 11709147fbdc8206a0cac78bfe9083e7e15b3c5689cRomain Guy flags |= Snapshot::kFlagClipSet | Snapshot::kFlagDirtyLocalClip; 118079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy } 119079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy 1203d58c03de0d8877b36cdb78b0ca8b5cac7f600e2Romain Guy return clipped; 1215cbbce535744b89df5ecea95de21ee3733298260Romain Guy } 1225cbbce535744b89df5ecea95de21ee3733298260Romain Guy 1235cbbce535744b89df5ecea95de21ee3733298260Romain Guy /** 124d27977d1a91d5a6b3cc9fa7664ac7e835e7bd895Romain Guy * Sets the current clip. 125d27977d1a91d5a6b3cc9fa7664ac7e835e7bd895Romain Guy */ 126d27977d1a91d5a6b3cc9fa7664ac7e835e7bd895Romain Guy void setClip(float left, float top, float right, float bottom) { 127d27977d1a91d5a6b3cc9fa7664ac7e835e7bd895Romain Guy clipRect.set(left, top, right, bottom); 12809147fbdc8206a0cac78bfe9083e7e15b3c5689cRomain Guy flags |= Snapshot::kFlagClipSet | Snapshot::kFlagDirtyLocalClip; 129079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy } 130079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy 131079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy const Rect& getLocalClip() { 13209147fbdc8206a0cac78bfe9083e7e15b3c5689cRomain Guy if (flags & Snapshot::kFlagDirtyLocalClip) { 13309147fbdc8206a0cac78bfe9083e7e15b3c5689cRomain Guy mat4 inverse; 13409147fbdc8206a0cac78bfe9083e7e15b3c5689cRomain Guy inverse.loadInverse(transform); 13509147fbdc8206a0cac78bfe9083e7e15b3c5689cRomain Guy localClip.set(clipRect); 13609147fbdc8206a0cac78bfe9083e7e15b3c5689cRomain Guy inverse.mapRect(localClip); 13709147fbdc8206a0cac78bfe9083e7e15b3c5689cRomain Guy flags &= ~Snapshot::kFlagDirtyLocalClip; 13809147fbdc8206a0cac78bfe9083e7e15b3c5689cRomain Guy } 139079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy return localClip; 140d27977d1a91d5a6b3cc9fa7664ac7e835e7bd895Romain Guy } 141d27977d1a91d5a6b3cc9fa7664ac7e835e7bd895Romain Guy 142d27977d1a91d5a6b3cc9fa7664ac7e835e7bd895Romain Guy /** 143f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy * Height of the framebuffer the snapshot is rendering into. 144f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy */ 145f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy int height; 146f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy 147f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy /** 1485cbbce535744b89df5ecea95de21ee3733298260Romain Guy * Local transformation. Holds the current translation, scale and 1495cbbce535744b89df5ecea95de21ee3733298260Romain Guy * rotation values. 1505cbbce535744b89df5ecea95de21ee3733298260Romain Guy */ 1515cbbce535744b89df5ecea95de21ee3733298260Romain Guy mat4 transform; 1525cbbce535744b89df5ecea95de21ee3733298260Romain Guy 1535cbbce535744b89df5ecea95de21ee3733298260Romain Guy /** 154079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy * Current clip region. The clip is stored in canvas-space coordinates, 155079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy * (screen-space coordinates in the regular case.) 1565cbbce535744b89df5ecea95de21ee3733298260Romain Guy */ 1575cbbce535744b89df5ecea95de21ee3733298260Romain Guy Rect clipRect; 1585cbbce535744b89df5ecea95de21ee3733298260Romain Guy 1595cbbce535744b89df5ecea95de21ee3733298260Romain Guy /** 1605cbbce535744b89df5ecea95de21ee3733298260Romain Guy * Dirty flags. 1615cbbce535744b89df5ecea95de21ee3733298260Romain Guy */ 1625cbbce535744b89df5ecea95de21ee3733298260Romain Guy int flags; 1635cbbce535744b89df5ecea95de21ee3733298260Romain Guy 1645cbbce535744b89df5ecea95de21ee3733298260Romain Guy /** 1655cbbce535744b89df5ecea95de21ee3733298260Romain Guy * Previous snapshot. 1665cbbce535744b89df5ecea95de21ee3733298260Romain Guy */ 1675cbbce535744b89df5ecea95de21ee3733298260Romain Guy sp<Snapshot> previous; 1685cbbce535744b89df5ecea95de21ee3733298260Romain Guy 1695cbbce535744b89df5ecea95de21ee3733298260Romain Guy /** 1705cbbce535744b89df5ecea95de21ee3733298260Romain Guy * Only set when the flag kFlagIsLayer is set. 1715cbbce535744b89df5ecea95de21ee3733298260Romain Guy */ 172dda570201ac851dd85af3861f7e575721d3345daRomain Guy Layer* layer; 1735cbbce535744b89df5ecea95de21ee3733298260Romain Guy GLuint fbo; 1745cbbce535744b89df5ecea95de21ee3733298260Romain Guy 175f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy /** 176f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy * Contains the previous ortho matrix. 177f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy */ 178260e102162322958cf17dbd895cd6bd30dc87e32Romain Guy mat4 orthoMatrix; 179f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy 1805cbbce535744b89df5ecea95de21ee3733298260Romain Guyprivate: 181079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy Rect localClip; 182079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy 1835cbbce535744b89df5ecea95de21ee3733298260Romain Guy}; // class Snapshot 1845cbbce535744b89df5ecea95de21ee3733298260Romain Guy 1855cbbce535744b89df5ecea95de21ee3733298260Romain Guy}; // namespace uirenderer 1865cbbce535744b89df5ecea95de21ee3733298260Romain Guy}; // namespace android 1875cbbce535744b89df5ecea95de21ee3733298260Romain Guy 1885cbbce535744b89df5ecea95de21ee3733298260Romain Guy#endif // ANDROID_UI_SNAPSHOT_H 189