SkLayerDrawLooper.h revision fbfcd5602128ec010c82cb733c9cdc0a3254f9f3
1ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com 2ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com/* 3ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com * Copyright 2011 Google Inc. 4ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com * 5ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com * Use of this source code is governed by a BSD-style license that can be 6ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com * found in the LICENSE file. 7ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com */ 88a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#ifndef SkLayerDrawLooper_DEFINED 98a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SkLayerDrawLooper_DEFINED 108a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 118a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#include "SkDrawLooper.h" 120716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com#include "SkXfermode.h" 138a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 148a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comstruct SkPoint; 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. 278426058dee0faf75a18b81cfcde47ee8ab8c31d9reed@google.com * 0 means ignore the layer's paint... except that LayerInfo's fFlagsMask 288426058dee0faf75a18b81cfcde47ee8ab8c31d9reed@google.com * and fColorMode are 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. 438426058dee0faf75a18b81cfcde47ee8ab8c31d9reed@google.com * - Flags and Color are always computed using the LayerInfo's 448426058dee0faf75a18b81cfcde47ee8ab8c31d9reed@google.com * fFlagsMask and fColorMode. 458426058dee0faf75a18b81cfcde47ee8ab8c31d9reed@google.com */ 461f90287df3129cb267422e482c52ebeca6a8990ftomhudson@google.com kEntirePaint_Bits = -1 47fbfcd5602128ec010c82cb733c9cdc0a3254f9f3rmistry@google.com 480e2810be95d3f1aa95c341521d3f514eb9e9ebdemike@reedtribe.org }; 490e2810be95d3f1aa95c341521d3f514eb9e9ebdemike@reedtribe.org typedef int32_t BitFlags; 500716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com 510716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com /** 520716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * Info for how to apply the layer's paint and offset. 530716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * 54a8282ef8f9e63e60c5665af0cdfc8fdd11c089f6mike@reedtribe.org * fFlagsMask selects which flags in the layer's paint should be applied. 55a8282ef8f9e63e60c5665af0cdfc8fdd11c089f6mike@reedtribe.org * result = (draw-flags & ~fFlagsMask) | (layer-flags & fFlagsMask) 56a8282ef8f9e63e60c5665af0cdfc8fdd11c089f6mike@reedtribe.org * In the extreme: 57a8282ef8f9e63e60c5665af0cdfc8fdd11c089f6mike@reedtribe.org * If fFlagsMask is 0, we ignore all of the layer's flags 58a8282ef8f9e63e60c5665af0cdfc8fdd11c089f6mike@reedtribe.org * If fFlagsMask is -1, we use all of the layer's flags 59a8282ef8f9e63e60c5665af0cdfc8fdd11c089f6mike@reedtribe.org * 600716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * fColorMode controls how we compute the final color for the layer: 610716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * The layer's paint's color is treated as the SRC 620716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * The draw's paint's color is treated as the DST 630716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * final-color = Mode(layers-color, draws-color); 640716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * Any SkXfermode::Mode will work. Two common choices are: 650716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * kSrc_Mode: to use the layer's color, ignoring the draw's 660716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * kDst_Mode: to just keep the draw's color, ignoring the layer's 670716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com */ 688c3ff17e2cab6f7c798b9f8ff4515c4a3d3fd9d1bsalomon@google.com struct SK_API LayerInfo { 69a8282ef8f9e63e60c5665af0cdfc8fdd11c089f6mike@reedtribe.org uint32_t fFlagsMask; // SkPaint::Flags 700716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com BitFlags fPaintBits; 710716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com SkXfermode::Mode fColorMode; 720716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com SkVector fOffset; 730716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com bool fPostTranslate; //!< applies to fOffset 740716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com 750716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com /** 760716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * Initial the LayerInfo. Defaults to settings that will draw the 770716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * layer with no changes: e.g. 780716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * fPaintBits == 0 790716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * fColorMode == kDst_Mode 800716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com * fOffset == (0, 0) 810716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com */ 820716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com LayerInfo(); 830716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com }; 840716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com 850e2810be95d3f1aa95c341521d3f514eb9e9ebdemike@reedtribe.org /** 860e2810be95d3f1aa95c341521d3f514eb9e9ebdemike@reedtribe.org * Call for each layer you want to add (from top to bottom). 870e2810be95d3f1aa95c341521d3f514eb9e9ebdemike@reedtribe.org * This returns a paint you can modify, but that ptr is only valid until 88a8282ef8f9e63e60c5665af0cdfc8fdd11c089f6mike@reedtribe.org * the next call made to addLayer(). 890716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com */ 900716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com SkPaint* addLayer(const LayerInfo&); 910716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com 920716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com /** 93a8282ef8f9e63e60c5665af0cdfc8fdd11c089f6mike@reedtribe.org * This layer will draw with the original paint, ad the specified offset 948a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 95a8282ef8f9e63e60c5665af0cdfc8fdd11c089f6mike@reedtribe.org void addLayer(SkScalar dx, SkScalar dy); 96fbfcd5602128ec010c82cb733c9cdc0a3254f9f3rmistry@google.com 970e2810be95d3f1aa95c341521d3f514eb9e9ebdemike@reedtribe.org /** 98a8282ef8f9e63e60c5665af0cdfc8fdd11c089f6mike@reedtribe.org * This layer will with the original paint and no offset. 998a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 100a8282ef8f9e63e60c5665af0cdfc8fdd11c089f6mike@reedtribe.org void addLayer() { this->addLayer(0, 0); } 101fbfcd5602128ec010c82cb733c9cdc0a3254f9f3rmistry@google.com 1028a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com // overrides from SkDrawLooper 1034e2b3d3fb1288c6dc0f3ea1c0aa4a0d7c603bd7breed@google.com virtual void init(SkCanvas*); 1044e2b3d3fb1288c6dc0f3ea1c0aa4a0d7c603bd7breed@google.com virtual bool next(SkCanvas*, SkPaint* paint); 1058a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 106ba28d03e94dc221d6a803bf2a84a420b9159255cdjsollen@google.com SK_DECLARE_PUBLIC_FLATTENABLE_DESERIALIZATION_PROCS(SkLayerDrawLooper) 107fbfcd5602128ec010c82cb733c9cdc0a3254f9f3rmistry@google.com 1088a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comprotected: 1098a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkLayerDrawLooper(SkFlattenableReadBuffer&); 11054924243c1b65b3ee6d8fa064b50a9b1bb2a19a5djsollen@google.com virtual void flatten(SkFlattenableWriteBuffer&) const SK_OVERRIDE; 111fbfcd5602128ec010c82cb733c9cdc0a3254f9f3rmistry@google.com 1128a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comprivate: 1138a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com struct Rec { 1148a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com Rec* fNext; 1158a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkPaint fPaint; 1160716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com LayerInfo fInfo; 1170716c63332a64c3cc77a9afb87ae2fd9614f0c4freed@google.com 1188a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com static Rec* Reverse(Rec*); 1198a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com }; 1208a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com Rec* fRecs; 1218a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com int fCount; 1224e2b3d3fb1288c6dc0f3ea1c0aa4a0d7c603bd7breed@google.com 1234e2b3d3fb1288c6dc0f3ea1c0aa4a0d7c603bd7breed@google.com // state-machine during the init/next cycle 1244e2b3d3fb1288c6dc0f3ea1c0aa4a0d7c603bd7breed@google.com Rec* fCurrRec; 1250e2810be95d3f1aa95c341521d3f514eb9e9ebdemike@reedtribe.org 126a8282ef8f9e63e60c5665af0cdfc8fdd11c089f6mike@reedtribe.org static void ApplyInfo(SkPaint* dst, const SkPaint& src, const LayerInfo&); 1270e2810be95d3f1aa95c341521d3f514eb9e9ebdemike@reedtribe.org 1288a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com class MyRegistrar : public SkFlattenable::Registrar { 1298a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com public: 1308a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com MyRegistrar(); 1318a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com }; 132fbfcd5602128ec010c82cb733c9cdc0a3254f9f3rmistry@google.com 1338a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com typedef SkDrawLooper INHERITED; 1348a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com}; 1358a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 1368a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 1378a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#endif 138