SkLayerDrawLooper.h revision 79fbb40bca9d815ef79b896b31ba6ee736817e0f
1ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com/* 2ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com * Copyright 2011 Google Inc. 3ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com * 4ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com * Use of this source code is governed by a BSD-style license that can be 5ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com * found in the LICENSE file. 6ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com */ 76806fe87e0b39e283291c1a1c7d1d864230aa2aatfarina@chromium.org 88a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#ifndef SkLayerDrawLooper_DEFINED 98a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SkLayerDrawLooper_DEFINED 108a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 118a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#include "SkDrawLooper.h" 125da3f220034f89f3234b16b98bd86e7246941ffecommit-bot@chromium.org#include "SkPaint.h" 135da3f220034f89f3234b16b98bd86e7246941ffecommit-bot@chromium.org#include "SkPoint.h" 140716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com#include "SkXfermode.h" 158a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 168c3ff17e2cab6f7c798b9f8ff4515c4a3d3fd9d1bsalomon@google.comclass SK_API SkLayerDrawLooper : public SkDrawLooper { 178a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.compublic: 180456e0b7b85060e9b9597ce414c4c2b19aff4f58robertphillips@google.com SK_DECLARE_INST_COUNT(SkLayerDrawLooper) 190456e0b7b85060e9b9597ce414c4c2b19aff4f58robertphillips@google.com 208a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkLayerDrawLooper(); 218a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual ~SkLayerDrawLooper(); 220e2810be95d3f1aa95c341521d3f514eb9e9ebdemike@reedtribe.org 230716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com /** 240716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * Bits specifies which aspects of the layer's paint should replace the 250716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * corresponding aspects on the draw's paint. 260716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * kEntirePaint_Bits means use the layer's paint completely. 27842292f10fc08bc8701114f7eec00944b6ea26d2reed@google.com * 0 means ignore the layer's paint... except for fColorMode, which is 28842292f10fc08bc8701114f7eec00944b6ea26d2reed@google.com * always applied. 290716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com */ 300e2810be95d3f1aa95c341521d3f514eb9e9ebdemike@reedtribe.org enum Bits { 310716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com kStyle_Bit = 1 << 0, //!< use this layer's Style/stroke settings 320716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com kTextSkewX_Bit = 1 << 1, //!< use this layer's textskewx 330716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com kPathEffect_Bit = 1 << 2, //!< use this layer's patheffect 340716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com kMaskFilter_Bit = 1 << 3, //!< use this layer's maskfilter 350716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com kShader_Bit = 1 << 4, //!< use this layer's shader 360716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com kColorFilter_Bit = 1 << 5, //!< use this layer's colorfilter 370716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com kXfermode_Bit = 1 << 6, //!< use this layer's xfermode 38fbfcd5602128ec010c82cb733c9cdc0a3254f9f3rmistry@google.com 398426058dee0faf75a18b81cfcde47ee8ab8c31d9reed@google.com /** 408426058dee0faf75a18b81cfcde47ee8ab8c31d9reed@google.com * Use the layer's paint entirely, with these exceptions: 418426058dee0faf75a18b81cfcde47ee8ab8c31d9reed@google.com * - We never override the draw's paint's text_encoding, since that is 428426058dee0faf75a18b81cfcde47ee8ab8c31d9reed@google.com * used to interpret the text/len parameters in draw[Pos]Text. 43842292f10fc08bc8701114f7eec00944b6ea26d2reed@google.com * - Color is always computed using the LayerInfo's fColorMode. 448426058dee0faf75a18b81cfcde47ee8ab8c31d9reed@google.com */ 451f90287df3129cb267422e482c52ebeca6a8990ftomhudson@google.com kEntirePaint_Bits = -1 46fbfcd5602128ec010c82cb733c9cdc0a3254f9f3rmistry@google.com 470e2810be95d3f1aa95c341521d3f514eb9e9ebdemike@reedtribe.org }; 480e2810be95d3f1aa95c341521d3f514eb9e9ebdemike@reedtribe.org typedef int32_t BitFlags; 490716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com 500716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com /** 510716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * Info for how to apply the layer's paint and offset. 520716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * 530716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * fColorMode controls how we compute the final color for the layer: 540716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * The layer's paint's color is treated as the SRC 550716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * The draw's paint's color is treated as the DST 560716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * final-color = Mode(layers-color, draws-color); 570716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * Any SkXfermode::Mode will work. Two common choices are: 580716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * kSrc_Mode: to use the layer's color, ignoring the draw's 590716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * kDst_Mode: to just keep the draw's color, ignoring the layer's 600716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com */ 618c3ff17e2cab6f7c798b9f8ff4515c4a3d3fd9d1bsalomon@google.com struct SK_API LayerInfo { 620716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com BitFlags fPaintBits; 630716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com SkXfermode::Mode fColorMode; 640716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com SkVector fOffset; 650716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com bool fPostTranslate; //!< applies to fOffset 660716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com 670716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com /** 680716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * Initial the LayerInfo. Defaults to settings that will draw the 690716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * layer with no changes: e.g. 700716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * fPaintBits == 0 710716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * fColorMode == kDst_Mode 720716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * fOffset == (0, 0) 730716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com */ 740716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com LayerInfo(); 750716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com }; 760716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com 770e2810be95d3f1aa95c341521d3f514eb9e9ebdemike@reedtribe.org /** 780e2810be95d3f1aa95c341521d3f514eb9e9ebdemike@reedtribe.org * Call for each layer you want to add (from top to bottom). 790e2810be95d3f1aa95c341521d3f514eb9e9ebdemike@reedtribe.org * This returns a paint you can modify, but that ptr is only valid until 80a8282ef8f9e63e60c5665af0cdfc8fdd11c089f6mike@reedtribe.org * the next call made to addLayer(). 810716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com */ 820716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com SkPaint* addLayer(const LayerInfo&); 830716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com 840716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com /** 854991b8f23482afc1494fd17647421ce68de53331robertphillips@google.com * This layer will draw with the original paint, at the specified offset 868a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 87a8282ef8f9e63e60c5665af0cdfc8fdd11c089f6mike@reedtribe.org void addLayer(SkScalar dx, SkScalar dy); 88fbfcd5602128ec010c82cb733c9cdc0a3254f9f3rmistry@google.com 890e2810be95d3f1aa95c341521d3f514eb9e9ebdemike@reedtribe.org /** 90a8282ef8f9e63e60c5665af0cdfc8fdd11c089f6mike@reedtribe.org * This layer will with the original paint and no offset. 918a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 92a8282ef8f9e63e60c5665af0cdfc8fdd11c089f6mike@reedtribe.org void addLayer() { this->addLayer(0, 0); } 93fbfcd5602128ec010c82cb733c9cdc0a3254f9f3rmistry@google.com 948f838259ab65e44562902679fa88cb00575b99cecommit-bot@chromium.org /// Similar to addLayer, but adds a layer to the top. 958f838259ab65e44562902679fa88cb00575b99cecommit-bot@chromium.org SkPaint* addLayerOnTop(const LayerInfo&); 968f838259ab65e44562902679fa88cb00575b99cecommit-bot@chromium.org 9779fbb40bca9d815ef79b896b31ba6ee736817e0fcommit-bot@chromium.org virtual SkDrawLooper::Context* createContext(SkCanvas*, void* storage) const SK_OVERRIDE; 9879fbb40bca9d815ef79b896b31ba6ee736817e0fcommit-bot@chromium.org 9979fbb40bca9d815ef79b896b31ba6ee736817e0fcommit-bot@chromium.org virtual size_t contextSize() const SK_OVERRIDE { return sizeof(LayerDrawLooperContext); } 1008a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 1014991b8f23482afc1494fd17647421ce68de53331robertphillips@google.com SK_DEVELOPER_TO_STRING() 10274ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org 10374ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org /// Implements Flattenable. 10474ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org virtual Factory getFactory() const SK_OVERRIDE { return CreateProc; } 10574ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org static SkFlattenable* CreateProc(SkReadBuffer& buffer); 106fbfcd5602128ec010c82cb733c9cdc0a3254f9f3rmistry@google.com 1078a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comprotected: 1088b0e8ac5f582de80356019406e2975079bf0829dcommit-bot@chromium.org virtual void flatten(SkWriteBuffer&) const SK_OVERRIDE; 109fbfcd5602128ec010c82cb733c9cdc0a3254f9f3rmistry@google.com 1108a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comprivate: 1118a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com struct Rec { 1128a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com Rec* fNext; 1138a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkPaint fPaint; 1140716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com LayerInfo fInfo; 1158a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com }; 1168a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com Rec* fRecs; 1178f838259ab65e44562902679fa88cb00575b99cecommit-bot@chromium.org Rec* fTopRec; 1188a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com int fCount; 1194e2b3d3fb1288c6dc0f3ea1c0aa4a0d7c603bd7breed@google.com 1204e2b3d3fb1288c6dc0f3ea1c0aa4a0d7c603bd7breed@google.com // state-machine during the init/next cycle 12179fbb40bca9d815ef79b896b31ba6ee736817e0fcommit-bot@chromium.org class LayerDrawLooperContext : public SkDrawLooper::Context { 12279fbb40bca9d815ef79b896b31ba6ee736817e0fcommit-bot@chromium.org public: 12379fbb40bca9d815ef79b896b31ba6ee736817e0fcommit-bot@chromium.org explicit LayerDrawLooperContext(const SkLayerDrawLooper* looper); 12479fbb40bca9d815ef79b896b31ba6ee736817e0fcommit-bot@chromium.org 12579fbb40bca9d815ef79b896b31ba6ee736817e0fcommit-bot@chromium.org protected: 12679fbb40bca9d815ef79b896b31ba6ee736817e0fcommit-bot@chromium.org virtual bool next(SkCanvas*, SkPaint* paint) SK_OVERRIDE; 1270e2810be95d3f1aa95c341521d3f514eb9e9ebdemike@reedtribe.org 12879fbb40bca9d815ef79b896b31ba6ee736817e0fcommit-bot@chromium.org private: 12979fbb40bca9d815ef79b896b31ba6ee736817e0fcommit-bot@chromium.org Rec* fCurrRec; 13079fbb40bca9d815ef79b896b31ba6ee736817e0fcommit-bot@chromium.org 13179fbb40bca9d815ef79b896b31ba6ee736817e0fcommit-bot@chromium.org static void ApplyInfo(SkPaint* dst, const SkPaint& src, const LayerInfo&); 13279fbb40bca9d815ef79b896b31ba6ee736817e0fcommit-bot@chromium.org }; 1330e2810be95d3f1aa95c341521d3f514eb9e9ebdemike@reedtribe.org 1348a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com class MyRegistrar : public SkFlattenable::Registrar { 1358a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com public: 1368a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com MyRegistrar(); 1378a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com }; 138fbfcd5602128ec010c82cb733c9cdc0a3254f9f3rmistry@google.com 1398a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com typedef SkDrawLooper INHERITED; 14074ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org 14174ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.orgpublic: 14274ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org class SK_API Builder { 14374ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org public: 14474ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org Builder(); 14574ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org ~Builder(); 14674ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org 14774ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org /** 14874ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org * Call for each layer you want to add (from top to bottom). 14974ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org * This returns a paint you can modify, but that ptr is only valid until 15074ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org * the next call made to addLayer(). 15174ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org */ 15274ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org SkPaint* addLayer(const LayerInfo&); 15374ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org 15474ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org /** 15574ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org * This layer will draw with the original paint, at the specified offset 15674ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org */ 15774ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org void addLayer(SkScalar dx, SkScalar dy); 15874ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org 15974ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org /** 16074ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org * This layer will with the original paint and no offset. 16174ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org */ 16274ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org void addLayer() { this->addLayer(0, 0); } 16374ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org 16474ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org /// Similar to addLayer, but adds a layer to the top. 16574ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org SkPaint* addLayerOnTop(const LayerInfo&); 16674ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org 16774ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org /** 16874ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org * Pass list of layers on to newly built looper and return it. This will 16974ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org * also reset the builder, so it can be used to build another looper. 17074ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org */ 17174ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org SkLayerDrawLooper* detachLooper(); 17274ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org 17374ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org private: 17474ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org Rec* fRecs; 17574ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org Rec* fTopRec; 17674ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org int fCount; 17774ba2f62dce1998bd6555291ab0a5330c276301dcommit-bot@chromium.org }; 1788a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com}; 1798a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 1808a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#endif 181