Snapshot.h revision 079ba2c85b15e882629b8d188f5fbdb42f7f8eea
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: 45079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy Snapshot(): flags(0x0), 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 */ 535cbbce535744b89df5ecea95de21ee3733298260Romain Guy Snapshot(const sp<Snapshot> s): 54f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy height(s->height), 555cbbce535744b89df5ecea95de21ee3733298260Romain Guy transform(s->transform), 565cbbce535744b89df5ecea95de21ee3733298260Romain Guy clipRect(s->clipRect), 57079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy flags(0x0), 585cbbce535744b89df5ecea95de21ee3733298260Romain Guy previous(s), 59dda570201ac851dd85af3861f7e575721d3345daRomain Guy layer(NULL), 60dda570201ac851dd85af3861f7e575721d3345daRomain Guy fbo(s->fbo) { 615cbbce535744b89df5ecea95de21ee3733298260Romain Guy } 625cbbce535744b89df5ecea95de21ee3733298260Romain Guy 635cbbce535744b89df5ecea95de21ee3733298260Romain Guy /** 645cbbce535744b89df5ecea95de21ee3733298260Romain Guy * Various flags set on #flags. 655cbbce535744b89df5ecea95de21ee3733298260Romain Guy */ 665cbbce535744b89df5ecea95de21ee3733298260Romain Guy enum Flags { 675cbbce535744b89df5ecea95de21ee3733298260Romain Guy /** 685cbbce535744b89df5ecea95de21ee3733298260Romain Guy * Indicates that the clip region was modified. When this 695cbbce535744b89df5ecea95de21ee3733298260Romain Guy * snapshot is restored so must the clip. 705cbbce535744b89df5ecea95de21ee3733298260Romain Guy */ 715cbbce535744b89df5ecea95de21ee3733298260Romain Guy kFlagClipSet = 0x1, 725cbbce535744b89df5ecea95de21ee3733298260Romain Guy /** 735cbbce535744b89df5ecea95de21ee3733298260Romain Guy * Indicates that this snapshot was created when saving 745cbbce535744b89df5ecea95de21ee3733298260Romain Guy * a new layer. 755cbbce535744b89df5ecea95de21ee3733298260Romain Guy */ 76079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy kFlagIsLayer = 0x2, 77f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy /** 78f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy * Indicates that this snapshot has changed the ortho matrix. 79f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy */ 80079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy kFlagDirtyOrtho = 0x4, 815cbbce535744b89df5ecea95de21ee3733298260Romain Guy }; 825cbbce535744b89df5ecea95de21ee3733298260Romain Guy 835cbbce535744b89df5ecea95de21ee3733298260Romain Guy /** 843d58c03de0d8877b36cdb78b0ca8b5cac7f600e2Romain Guy * Intersects the current clip with the new clip rectangle. 853d58c03de0d8877b36cdb78b0ca8b5cac7f600e2Romain Guy */ 86079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy bool clip(float left, float top, float right, float bottom, SkRegion::Op op) { 87079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy bool clipped = false; 88079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy 89079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy Rect r(left, top, right, bottom); 90079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy transform.mapRect(r); 91079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy 92079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy switch (op) { 93079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy case SkRegion::kDifference_Op: 94079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy break; 95079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy case SkRegion::kIntersect_Op: 96079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy clipped = clipRect.intersect(r); 97079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy break; 98079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy case SkRegion::kUnion_Op: 99079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy clipped = clipRect.unionWith(r); 100079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy break; 101079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy case SkRegion::kXOR_Op: 102079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy break; 103079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy case SkRegion::kReverseDifference_Op: 104079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy break; 105079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy case SkRegion::kReplace_Op: 106079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy clipRect.set(r); 107079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy clipped = true; 108079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy break; 1095cbbce535744b89df5ecea95de21ee3733298260Romain Guy } 110079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy 111079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy if (clipped) { 112079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy flags |= Snapshot::kFlagClipSet; 113079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy } 114079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy 1153d58c03de0d8877b36cdb78b0ca8b5cac7f600e2Romain Guy return clipped; 1165cbbce535744b89df5ecea95de21ee3733298260Romain Guy } 1175cbbce535744b89df5ecea95de21ee3733298260Romain Guy 1185cbbce535744b89df5ecea95de21ee3733298260Romain Guy /** 119d27977d1a91d5a6b3cc9fa7664ac7e835e7bd895Romain Guy * Sets the current clip. 120d27977d1a91d5a6b3cc9fa7664ac7e835e7bd895Romain Guy */ 121d27977d1a91d5a6b3cc9fa7664ac7e835e7bd895Romain Guy void setClip(float left, float top, float right, float bottom) { 122d27977d1a91d5a6b3cc9fa7664ac7e835e7bd895Romain Guy clipRect.set(left, top, right, bottom); 123079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy flags |= Snapshot::kFlagClipSet; 124079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy } 125079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy 126079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy const Rect& getLocalClip() { 127079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy mat4 inverse; 128079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy inverse.loadInverse(transform); 129079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy localClip.set(clipRect); 130079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy inverse.mapRect(localClip); 131079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy return localClip; 132d27977d1a91d5a6b3cc9fa7664ac7e835e7bd895Romain Guy } 133d27977d1a91d5a6b3cc9fa7664ac7e835e7bd895Romain Guy 134d27977d1a91d5a6b3cc9fa7664ac7e835e7bd895Romain Guy /** 135f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy * Height of the framebuffer the snapshot is rendering into. 136f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy */ 137f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy int height; 138f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy 139f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy /** 1405cbbce535744b89df5ecea95de21ee3733298260Romain Guy * Local transformation. Holds the current translation, scale and 1415cbbce535744b89df5ecea95de21ee3733298260Romain Guy * rotation values. 1425cbbce535744b89df5ecea95de21ee3733298260Romain Guy */ 1435cbbce535744b89df5ecea95de21ee3733298260Romain Guy mat4 transform; 1445cbbce535744b89df5ecea95de21ee3733298260Romain Guy 1455cbbce535744b89df5ecea95de21ee3733298260Romain Guy /** 146079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy * Current clip region. The clip is stored in canvas-space coordinates, 147079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy * (screen-space coordinates in the regular case.) 1485cbbce535744b89df5ecea95de21ee3733298260Romain Guy */ 1495cbbce535744b89df5ecea95de21ee3733298260Romain Guy Rect clipRect; 1505cbbce535744b89df5ecea95de21ee3733298260Romain Guy 1515cbbce535744b89df5ecea95de21ee3733298260Romain Guy /** 1525cbbce535744b89df5ecea95de21ee3733298260Romain Guy * Dirty flags. 1535cbbce535744b89df5ecea95de21ee3733298260Romain Guy */ 1545cbbce535744b89df5ecea95de21ee3733298260Romain Guy int flags; 1555cbbce535744b89df5ecea95de21ee3733298260Romain Guy 1565cbbce535744b89df5ecea95de21ee3733298260Romain Guy /** 1575cbbce535744b89df5ecea95de21ee3733298260Romain Guy * Previous snapshot. 1585cbbce535744b89df5ecea95de21ee3733298260Romain Guy */ 1595cbbce535744b89df5ecea95de21ee3733298260Romain Guy sp<Snapshot> previous; 1605cbbce535744b89df5ecea95de21ee3733298260Romain Guy 1615cbbce535744b89df5ecea95de21ee3733298260Romain Guy /** 1625cbbce535744b89df5ecea95de21ee3733298260Romain Guy * Only set when the flag kFlagIsLayer is set. 1635cbbce535744b89df5ecea95de21ee3733298260Romain Guy */ 164dda570201ac851dd85af3861f7e575721d3345daRomain Guy Layer* layer; 1655cbbce535744b89df5ecea95de21ee3733298260Romain Guy GLuint fbo; 1665cbbce535744b89df5ecea95de21ee3733298260Romain Guy 167f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy /** 168f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy * Contains the previous ortho matrix. 169f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy */ 170260e102162322958cf17dbd895cd6bd30dc87e32Romain Guy mat4 orthoMatrix; 171f86ef57f8bcd8ba43ce222ec6a8b4f67d3600640Romain Guy 1725cbbce535744b89df5ecea95de21ee3733298260Romain Guyprivate: 173079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy Rect localClip; 174079ba2c85b15e882629b8d188f5fbdb42f7f8eeaRomain Guy 1755cbbce535744b89df5ecea95de21ee3733298260Romain Guy}; // class Snapshot 1765cbbce535744b89df5ecea95de21ee3733298260Romain Guy 1775cbbce535744b89df5ecea95de21ee3733298260Romain Guy}; // namespace uirenderer 1785cbbce535744b89df5ecea95de21ee3733298260Romain Guy}; // namespace android 1795cbbce535744b89df5ecea95de21ee3733298260Romain Guy 1805cbbce535744b89df5ecea95de21ee3733298260Romain Guy#endif // ANDROID_UI_SNAPSHOT_H 181