src/third_party/skia/include/core/SkComposeShader.h

   1
   2 /*
   3  * Copyright 2006 The Android Open Source Project
   4  *
   5  * Use of this source code is governed by a BSD-style license that can be
   6  * found in the LICENSE file.
   7  */
   8
   9
  10 #ifndef SkComposeShader_DEFINED
  11 #define SkComposeShader_DEFINED
  12
  13 #include "SkShader.h"
  14
  15 class SkXfermode;
  16
  17 ///////////////////////////////////////////////////////////////////////////////////////////
  18
  19 /** \class SkComposeShader
  20     This subclass of shader returns the composition of two other shaders, combined by
  21     a xfermode.
  22 */
  23 class SK_API SkComposeShader : public SkShader {
  24 public:
  25     /** Create a new compose shader, given shaders A, B, and a combining xfermode mode.
  26         When the xfermode is called, it will be given the result from shader A as its
  27         "dst", and the result from shader B as its "src".
  28         mode->xfer32(sA_result, sB_result, ...)
  29         @param shaderA  The colors from this shader are seen as the "dst" by the xfermode
  30         @param shaderB  The colors from this shader are seen as the "src" by the xfermode
  31         @param mode     The xfermode that combines the colors from the two shaders. If mode
  32                         is null, then SRC_OVER is assumed.
  33     */
  34     SkComposeShader(SkShader* sA, SkShader* sB, SkXfermode* mode = NULL);
  35     virtual ~SkComposeShader();
  36
  37     virtual size_t contextSize() const SK_OVERRIDE;
  38
  39     class ComposeShaderContext : public SkShader::Context {
  40     public:
  41         // When this object gets destroyed, it will call contextA and contextB's destructor
  42         // but it will NOT free the memory.
  43         ComposeShaderContext(const SkComposeShader&, const ContextRec&,
  44                              SkShader::Context* contextA, SkShader::Context* contextB);
  45
  46         SkShader::Context* getShaderContextA() const { return fShaderContextA; }
  47         SkShader::Context* getShaderContextB() const { return fShaderContextB; }
  48
  49         virtual ~ComposeShaderContext();
  50
  51         virtual void shadeSpan(int x, int y, SkPMColor[], int count) SK_OVERRIDE;
  52
  53     private:
  54         SkShader::Context* fShaderContextA;
  55         SkShader::Context* fShaderContextB;
  56
  57         typedef SkShader::Context INHERITED;
  58     };
  59
  60 #ifdef SK_DEBUG
  61     SkShader* getShaderA() { return fShaderA; }
  62     SkShader* getShaderB() { return fShaderB; }
  63 #endif
  64
  65     SK_TO_STRING_OVERRIDE()
  66     SK_DECLARE_PUBLIC_FLATTENABLE_DESERIALIZATION_PROCS(SkComposeShader)
  67
  68 protected:
  69     SkComposeShader(SkReadBuffer& );
  70     virtual void flatten(SkWriteBuffer&) const SK_OVERRIDE;
  71     virtual Context* onCreateContext(const ContextRec&, void*) const SK_OVERRIDE;
  72
  73 private:
  74     SkShader*   fShaderA;
  75     SkShader*   fShaderB;
  76     SkXfermode* fMode;
  77
  78     typedef SkShader INHERITED;
  79 };
  80
  81 #endif