DeferredDisplayList.h revision b45c6aa665624013ef3b207fffcfe265041f6bff
1c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik/* 2c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * Copyright (C) 2013 The Android Open Source Project 3c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * 4c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * Licensed under the Apache License, Version 2.0 (the "License"); 5c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * you may not use this file except in compliance with the License. 6c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * You may obtain a copy of the License at 7c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * 8c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * http://www.apache.org/licenses/LICENSE-2.0 9c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * 10c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * Unless required by applicable law or agreed to in writing, software 11c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * distributed under the License is distributed on an "AS IS" BASIS, 12c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * See the License for the specific language governing permissions and 14c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * limitations under the License. 15c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik */ 16c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik 17c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik#ifndef ANDROID_HWUI_DEFERRED_DISPLAY_LIST_H 18c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik#define ANDROID_HWUI_DEFERRED_DISPLAY_LIST_H 19c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik 20c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik#include <utils/Errors.h> 21c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik#include <utils/LinearAllocator.h> 22c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik#include <utils/TinyHashMap.h> 23c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik 24c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik#include "Matrix.h" 25c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik#include "OpenGLRenderer.h" 26c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik#include "Rect.h" 27527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craik 28272a685f17cc4828257e521a6f62b7b17870f75eJohn Reck#include <vector> 29272a685f17cc4828257e521a6f62b7b17870f75eJohn Reck 30527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craikclass SkBitmap; 31c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik 32c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craiknamespace android { 33c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craiknamespace uirenderer { 34c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik 35ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craikclass ClipOp; 36c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craikclass DrawOp; 37ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craikclass SaveOp; 38ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craikclass SaveLayerOp; 39ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craikclass StateOp; 40c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik 41c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craikclass DeferredDisplayState; 42c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik 43527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craikclass Batch; 44527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craikclass DrawBatch; 45527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craikclass MergingDrawBatch; 46527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craik 477f6d6b0370df4b5a9e0f45bffc31ea6caeeb509dRomain Guytypedef const void* mergeid_t; 48527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craik 49c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craikclass DeferredDisplayState { 50c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craikpublic: 51c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik /** static void* operator new(size_t size); PURPOSELY OMITTED **/ 52c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik static void* operator new(size_t size, LinearAllocator& allocator) { 53c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik return allocator.alloc(size); 54c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik } 55c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik 56c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik // global op bounds, mapped by mMatrix to be in screen space coordinates, clipped 57c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik Rect mBounds; 58c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik 59c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik // the below are set and used by the OpenGLRenderer at record and deferred playback 60c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik bool mClipValid; 61c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik Rect mClip; 62c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik int mClipSideFlags; // specifies which sides of the bounds are clipped, unclipped if cleared 63c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik bool mClipped; 64c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik mat4 mMatrix; 65c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik float mAlpha; 66deeda3d337aed1eee218b89a7aba5992ced371f0Chris Craik const RoundRectClipState* mRoundRectClipState; 67fca52b7583d1e5f5ff8ed06554875d2a30ef56faChris Craik const ProjectionPathMask* mProjectionPathMask; 68c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik}; 69c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik 70c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craikclass OpStatePair { 71c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craikpublic: 72c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik OpStatePair() 73e84a208317e0ed388fcdad1e6743c7849acb51b0Chris Craik : op(nullptr), state(nullptr) {} 74c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik OpStatePair(DrawOp* newOp, const DeferredDisplayState* newState) 75c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik : op(newOp), state(newState) {} 76c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik OpStatePair(const OpStatePair& other) 77c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik : op(other.op), state(other.state) {} 78c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik DrawOp* op; 79c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik const DeferredDisplayState* state; 80c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik}; 81c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik 82c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craikclass DeferredDisplayList { 83edaecc1db0584fa017822dfc2da0c968b53967e6Andreas Gampe friend struct DeferStateStruct; // used to give access to allocator 84c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craikpublic: 85b45c6aa665624013ef3b207fffcfe265041f6bffChris Craik DeferredDisplayList(const Rect& bounds) 86b45c6aa665624013ef3b207fffcfe265041f6bffChris Craik : mBounds(bounds) { 8728ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik clear(); 8828ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik } 89c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik ~DeferredDisplayList() { clear(); } 90c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik 91c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik enum OpBatchId { 92527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craik kOpBatch_None = 0, // Don't batch 93c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik kOpBatch_Bitmap, 94c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik kOpBatch_Patch, 95c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik kOpBatch_AlphaVertices, 96c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik kOpBatch_Vertices, 97c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik kOpBatch_AlphaMaskTexture, 98c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik kOpBatch_Text, 99c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik kOpBatch_ColorText, 100c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik 101c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik kOpBatch_Count, // Add other batch ids before this 102c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik }; 103c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik 104272a685f17cc4828257e521a6f62b7b17870f75eJohn Reck bool isEmpty() { return mBatches.empty(); } 105c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik 106c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik /** 107c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * Plays back all of the draw ops recorded into batches to the renderer. 108c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * Adjusts the state of the renderer as necessary, and restores it when complete 109c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik */ 110107843de4507b3511006cb9c77b8d0364374385aTom Hudson void flush(OpenGLRenderer& renderer, Rect& dirty); 111ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craik 112ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craik void addClip(OpenGLRenderer& renderer, ClipOp* op); 113ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craik void addSaveLayer(OpenGLRenderer& renderer, SaveLayerOp* op, int newSaveCount); 114ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craik void addSave(OpenGLRenderer& renderer, SaveOp* op, int newSaveCount); 1157273daace9303f4662444111c40bb83d3ead4a92Chris Craik void addRestoreToCount(OpenGLRenderer& renderer, StateOp* op, int newSaveCount); 116c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik 117c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik /** 118c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * Add a draw op into the DeferredDisplayList, reordering as needed (for performance) if 1195e49b307eb99269db2db257760508b8efd7bb97dChris Craik * disallowReorder is false, respecting draw order when overlaps occur. 120c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik */ 121ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craik void addDrawOp(OpenGLRenderer& renderer, DrawOp* op); 122c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik 123c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craikprivate: 124f57776b2d195f0937906eb88b777bb55ccc36967Chris Craik DeferredDisplayList(const DeferredDisplayList& other); // disallow copy 125f57776b2d195f0937906eb88b777bb55ccc36967Chris Craik 126c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik DeferredDisplayState* createState() { 127c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik return new (mAllocator) DeferredDisplayState(); 128c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik } 129c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik 130c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik void tryRecycleState(DeferredDisplayState* state) { 131b5bc454870c8b7df88a633b18c4c6499361c3a08John Reck mAllocator.rewindIfLastAlloc(state); 132c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik } 133c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik 134d90144db52c7297879b950cbbc85137ed123ab5bChris Craik /** 135ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craik * Resets the batching back-pointers, creating a barrier in the operation stream so that no ops 136ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craik * added in the future will be inserted into a batch that already exist. 137ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craik */ 138ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craik void resetBatchingState(); 139ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craik 1401206b9bba91f7ed899c5c87427cce725fe5aadfcChris Craik void clear(); 1411206b9bba91f7ed899c5c87427cce725fe5aadfcChris Craik 142ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craik void storeStateOpBarrier(OpenGLRenderer& renderer, StateOp* op); 1437273daace9303f4662444111c40bb83d3ead4a92Chris Craik void storeRestoreToCountBarrier(OpenGLRenderer& renderer, StateOp* op, int newSaveCount); 144ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craik 145ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craik bool recordingComplexClip() const { return mComplexClipStackStart >= 0; } 146ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craik 147ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craik int getStateOpDeferFlags() const; 148ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craik int getDrawOpDeferFlags() const; 149ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craik 150f70119cd776f871a82c94be8522dce02e04c73a8Chris Craik void discardDrawingBatches(const unsigned int maxIndex); 15128ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik 15228ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik // layer space bounds of rendering 15328ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik Rect mBounds; 15428ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik 155d90144db52c7297879b950cbbc85137ed123ab5bChris Craik /** 156d90144db52c7297879b950cbbc85137ed123ab5bChris Craik * At defer time, stores the *defer time* savecount of save/saveLayer ops that were deferred, so 157d90144db52c7297879b950cbbc85137ed123ab5bChris Craik * that when an associated restoreToCount is deferred, it can be recorded as a 158d90144db52c7297879b950cbbc85137ed123ab5bChris Craik * RestoreToCountBatch 159ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craik */ 160272a685f17cc4828257e521a6f62b7b17870f75eJohn Reck std::vector<int> mSaveStack; 161ff78583d8a73ca35ce65b5d2592570ff6fb9901bChris Craik int mComplexClipStackStart; 162c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik 163272a685f17cc4828257e521a6f62b7b17870f75eJohn Reck std::vector<Batch*> mBatches; 164527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craik 165527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craik // Maps batch ids to the most recent *non-merging* batch of that id 166527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craik Batch* mBatchLookup[kOpBatch_Count]; 167527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craik 168527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craik // Points to the index after the most recent barrier 169527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craik int mEarliestBatchIndex; 170527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craik 17128ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik // Points to the first index that may contain a pure drawing batch 17228ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik int mEarliestUnclearedIndex; 17328ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik 174527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craik /** 175527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craik * Maps the mergeid_t returned by an op's getMergeId() to the most recently seen 176527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craik * MergingDrawBatch of that id. These ids are unique per draw type and guaranteed to not 177527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craik * collide, which avoids the need to resolve mergeid collisions. 178527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craik */ 179527a3aace1dd72432c2e0472a570e030ad04bf16Chris Craik TinyHashMap<mergeid_t, DrawBatch*> mMergingBatches[kOpBatch_Count]; 180c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik 181c1c5f0870282b56dafe5a4d756e4b9e6884655a7Chris Craik LinearAllocator mAllocator; 182c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik}; 183c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik 18428ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik/** 18528ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik * Struct containing information that instructs the defer 18628ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik */ 18728ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craikstruct DeferInfo { 18828ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craikpublic: 18928ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik DeferInfo() : 19028ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik batchId(DeferredDisplayList::kOpBatch_None), 19128ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik mergeId((mergeid_t) -1), 19228ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik mergeable(false), 19328ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik opaqueOverBounds(false) { 19428ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik }; 19528ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik 19628ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik int batchId; 19728ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik mergeid_t mergeId; 19828ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik bool mergeable; 19928ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik bool opaqueOverBounds; // opaque over bounds in DeferredDisplayState - can skip ops below 20028ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik}; 20128ce94a4ffc7576f40776d212f1ada79fafaa061Chris Craik 202c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik}; // namespace uirenderer 203c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik}; // namespace android 204c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik 205c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik#endif // ANDROID_HWUI_DEFERRED_DISPLAY_LIST_H 206