2008-12-17 15:59:43 +00:00
|
|
|
/*
|
2011-07-28 14:26:00 +00:00
|
|
|
* Copyright 2006 The Android Open Source Project
|
2008-12-17 15:59:43 +00:00
|
|
|
*
|
2011-07-28 14:26:00 +00:00
|
|
|
* Use of this source code is governed by a BSD-style license that can be
|
|
|
|
* found in the LICENSE file.
|
2008-12-17 15:59:43 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef SkShader_DEFINED
|
|
|
|
#define SkShader_DEFINED
|
|
|
|
|
2018-01-23 16:24:08 +00:00
|
|
|
#include "SkBlendMode.h"
|
2018-02-06 23:05:36 +00:00
|
|
|
#include "SkColor.h"
|
2016-11-17 15:47:39 +00:00
|
|
|
#include "SkFilterQuality.h"
|
2008-12-17 15:59:43 +00:00
|
|
|
#include "SkFlattenable.h"
|
2016-02-23 01:19:04 +00:00
|
|
|
#include "SkImageInfo.h"
|
2008-12-17 15:59:43 +00:00
|
|
|
#include "SkMatrix.h"
|
|
|
|
|
2017-02-07 19:25:11 +00:00
|
|
|
class SkArenaAlloc;
|
2018-01-23 16:24:08 +00:00
|
|
|
class SkBitmap;
|
2016-01-07 23:47:29 +00:00
|
|
|
class SkColorFilter;
|
2016-05-04 20:09:39 +00:00
|
|
|
class SkColorSpace;
|
2017-04-18 22:29:12 +00:00
|
|
|
class SkColorSpaceXformer;
|
2016-08-01 18:24:14 +00:00
|
|
|
class SkImage;
|
2008-12-17 15:59:43 +00:00
|
|
|
class SkPath;
|
2014-04-08 15:19:34 +00:00
|
|
|
class SkPicture;
|
2016-11-12 15:29:26 +00:00
|
|
|
class SkRasterPipeline;
|
2012-07-20 20:02:43 +00:00
|
|
|
class GrContext;
|
2014-09-23 16:50:21 +00:00
|
|
|
class GrFragmentProcessor;
|
2008-12-17 15:59:43 +00:00
|
|
|
|
|
|
|
/** \class SkShader
|
2011-04-11 19:01:12 +00:00
|
|
|
*
|
2012-05-11 14:47:03 +00:00
|
|
|
* Shaders specify the source color(s) for what is being drawn. If a paint
|
|
|
|
* has no shader, then the paint's color is used. If the paint has a
|
|
|
|
* shader, then the shader's color(s) are use instead, but they are
|
|
|
|
* modulated by the paint's alpha. This makes it easy to create a shader
|
|
|
|
* once (e.g. bitmap tiling or gradient) and then change its transparency
|
|
|
|
* w/o having to modify the original shader... only the paint's alpha needs
|
|
|
|
* to be modified.
|
2011-04-11 19:01:12 +00:00
|
|
|
*/
|
2011-03-15 21:27:08 +00:00
|
|
|
class SK_API SkShader : public SkFlattenable {
|
2008-12-17 15:59:43 +00:00
|
|
|
public:
|
|
|
|
enum TileMode {
|
2018-12-20 14:25:10 +00:00
|
|
|
/**
|
|
|
|
* Replicate the edge color if the shader draws outside of its
|
|
|
|
* original bounds.
|
2012-03-16 14:38:06 +00:00
|
|
|
*/
|
|
|
|
kClamp_TileMode,
|
|
|
|
|
2018-12-20 14:25:10 +00:00
|
|
|
/**
|
|
|
|
* Repeat the shader's image horizontally and vertically.
|
|
|
|
*/
|
2012-03-16 14:38:06 +00:00
|
|
|
kRepeat_TileMode,
|
|
|
|
|
2018-12-20 14:25:10 +00:00
|
|
|
/**
|
|
|
|
* Repeat the shader's image horizontally and vertically, alternating
|
|
|
|
* mirror images so that adjacent images always seam.
|
2012-03-16 14:38:06 +00:00
|
|
|
*/
|
|
|
|
kMirror_TileMode,
|
|
|
|
|
2018-02-16 17:40:18 +00:00
|
|
|
/**
|
|
|
|
* Only draw within the original domain, return transparent-black everywhere else.
|
|
|
|
*/
|
2012-03-16 14:38:06 +00:00
|
|
|
kDecal_TileMode,
|
2018-02-16 17:40:18 +00:00
|
|
|
|
2018-07-28 14:14:27 +00:00
|
|
|
kLast_TileMode = kDecal_TileMode,
|
2015-03-15 21:01:21 +00:00
|
|
|
};
|
2008-12-17 15:59:43 +00:00
|
|
|
|
2018-04-26 12:32:37 +00:00
|
|
|
static constexpr int kTileModeCount = kLast_TileMode + 1;
|
2008-12-17 15:59:43 +00:00
|
|
|
|
2017-05-25 14:38:07 +00:00
|
|
|
/**
|
|
|
|
* Returns the local matrix.
|
|
|
|
*
|
|
|
|
* FIXME: This can be incorrect for a Shader with its own local matrix
|
|
|
|
* that is also wrapped via CreateLocalMatrixShader.
|
|
|
|
*/
|
|
|
|
const SkMatrix& getLocalMatrix() const;
|
2008-12-17 15:59:43 +00:00
|
|
|
|
2011-12-09 15:48:03 +00:00
|
|
|
/**
|
|
|
|
* Returns true if the shader is guaranteed to produce only opaque
|
|
|
|
* colors, subject to the SkPaint using the shader to apply an opaque
|
|
|
|
* alpha value. Subclasses should override this to allow some
|
Revert of Revert of Extract most of the mutable state of SkShader into a separate Context object. (https://codereview.chromium.org/249643002/)
Reason for revert:
Chromium side change landed along side DEPS roll that includes r14323.
Original issue's description:
> Revert of Extract most of the mutable state of SkShader into a separate Context object. (https://codereview.chromium.org/207683004/)
>
> Reason for revert:
> This is blocking the DEPS roll into Chromium. Failures can be seen here:
>
> http://build.chromium.org/p/tryserver.chromium/builders/android_dbg/builds/174333
>
> Original issue's description:
> > Extract most of the mutable state of SkShader into a separate Context object.
> >
> > SkShader currently stores some state during draw calls via setContext(...).
> > Move that mutable state into a separate SkShader::Context class that is
> > constructed on demand for the duration of the draw.
> >
> > Calls to setContext() are replaced with createContext() which returns a context
> > corresponding to the shader object or NULL if the parameters to createContext
> > are invalid.
> >
> > TEST=out/Debug/dm
> > BUG=skia:1976
> >
> > Committed: http://code.google.com/p/skia/source/detail?r=14216
> >
> > Committed: http://code.google.com/p/skia/source/detail?r=14323
>
> TBR=scroggo@google.com,skyostil@chromium.org,tomhudson@chromium.org,senorblanco@chromium.org,reed@google.com,bungeman@google.com,dominikg@chromium.org
> NOTREECHECKS=true
> NOTRY=true
> BUG=skia:1976
>
> Committed: http://code.google.com/p/skia/source/detail?r=14326
R=scroggo@google.com, skyostil@chromium.org, tomhudson@chromium.org, senorblanco@chromium.org, reed@google.com, bungeman@google.com, dominikg@chromium.org
TBR=bungeman@google.com, dominikg@chromium.org, reed@google.com, scroggo@google.com, senorblanco@chromium.org, skyostil@chromium.org, tomhudson@chromium.org
NOTREECHECKS=true
NOTRY=true
BUG=skia:1976
Author: bsalomon@google.com
Review URL: https://codereview.chromium.org/246403013
git-svn-id: http://skia.googlecode.com/svn/trunk@14328 2bbb7eff-a529-9590-31e7-b0007b416f81
2014-04-23 19:10:51 +00:00
|
|
|
* optimizations.
|
2011-12-09 15:48:03 +00:00
|
|
|
*/
|
|
|
|
virtual bool isOpaque() const { return false; }
|
|
|
|
|
2016-08-01 18:24:14 +00:00
|
|
|
/**
|
|
|
|
* Iff this shader is backed by a single SkImage, return its ptr (the caller must ref this
|
|
|
|
* if they want to keep it longer than the lifetime of the shader). If not, return nullptr.
|
|
|
|
*/
|
2017-05-25 14:38:07 +00:00
|
|
|
SkImage* isAImage(SkMatrix* localMatrix, TileMode xy[2]) const;
|
2016-08-01 18:24:14 +00:00
|
|
|
|
|
|
|
bool isAImage() const {
|
|
|
|
return this->isAImage(nullptr, nullptr) != nullptr;
|
|
|
|
}
|
|
|
|
|
2011-02-24 00:21:06 +00:00
|
|
|
/**
|
|
|
|
* If the shader subclass can be represented as a gradient, asAGradient
|
|
|
|
* returns the matching GradientType enum (or kNone_GradientType if it
|
|
|
|
* cannot). Also, if info is not null, asAGradient populates info with
|
|
|
|
* the relevant (see below) parameters for the gradient. fColorCount
|
|
|
|
* is both an input and output parameter. On input, it indicates how
|
|
|
|
* many entries in fColors and fColorOffsets can be used, if they are
|
|
|
|
* non-NULL. After asAGradient has run, fColorCount indicates how
|
|
|
|
* many color-offset pairs there are in the gradient. If there is
|
|
|
|
* insufficient space to store all of the color-offset pairs, fColors
|
|
|
|
* and fColorOffsets will not be altered. fColorOffsets specifies
|
|
|
|
* where on the range of 0 to 1 to transition to the given color.
|
|
|
|
* The meaning of fPoint and fRadius is dependant on the type of gradient.
|
|
|
|
*
|
|
|
|
* None:
|
|
|
|
* info is ignored.
|
|
|
|
* Color:
|
|
|
|
* fColorOffsets[0] is meaningless.
|
|
|
|
* Linear:
|
|
|
|
* fPoint[0] and fPoint[1] are the end-points of the gradient
|
|
|
|
* Radial:
|
|
|
|
* fPoint[0] and fRadius[0] are the center and radius
|
2015-05-04 15:32:51 +00:00
|
|
|
* Conical:
|
2011-02-24 00:21:06 +00:00
|
|
|
* fPoint[0] and fRadius[0] are the center and radius of the 1st circle
|
|
|
|
* fPoint[1] and fRadius[1] are the center and radius of the 2nd circle
|
|
|
|
* Sweep:
|
|
|
|
* fPoint[0] is the center of the sweep.
|
|
|
|
*/
|
|
|
|
|
|
|
|
enum GradientType {
|
|
|
|
kNone_GradientType,
|
|
|
|
kColor_GradientType,
|
|
|
|
kLinear_GradientType,
|
|
|
|
kRadial_GradientType,
|
|
|
|
kSweep_GradientType,
|
2012-06-07 20:26:47 +00:00
|
|
|
kConical_GradientType,
|
2018-07-28 14:14:27 +00:00
|
|
|
kLast_GradientType = kConical_GradientType,
|
2011-02-24 00:21:06 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct GradientInfo {
|
|
|
|
int fColorCount; //!< In-out parameter, specifies passed size
|
|
|
|
// of fColors/fColorOffsets on input, and
|
|
|
|
// actual number of colors/offsets on
|
|
|
|
// output.
|
|
|
|
SkColor* fColors; //!< The colors in the gradient.
|
|
|
|
SkScalar* fColorOffsets; //!< The unit offset for color transitions.
|
|
|
|
SkPoint fPoint[2]; //!< Type specific, see above.
|
|
|
|
SkScalar fRadius[2]; //!< Type specific, see above.
|
|
|
|
TileMode fTileMode; //!< The tile mode used.
|
2013-05-24 14:58:44 +00:00
|
|
|
uint32_t fGradientFlags; //!< see SkGradientShader::Flags
|
2011-02-24 00:21:06 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
virtual GradientType asAGradient(GradientInfo* info) const;
|
|
|
|
|
2017-06-09 14:29:40 +00:00
|
|
|
#ifdef SK_BUILD_FOR_ANDROID_FRAMEWORK
|
2017-05-24 21:15:46 +00:00
|
|
|
struct ComposeRec {
|
|
|
|
const SkShader* fShaderA;
|
|
|
|
const SkShader* fShaderB;
|
|
|
|
SkBlendMode fBlendMode;
|
|
|
|
};
|
|
|
|
virtual bool asACompose(ComposeRec*) const { return false; }
|
2017-06-09 14:29:40 +00:00
|
|
|
#endif
|
2017-05-24 21:15:46 +00:00
|
|
|
|
2008-12-17 15:59:43 +00:00
|
|
|
//////////////////////////////////////////////////////////////////////////
|
2015-12-30 21:39:41 +00:00
|
|
|
// Methods to create combinations or variants of shaders
|
2008-12-17 15:59:43 +00:00
|
|
|
|
2015-12-30 21:39:41 +00:00
|
|
|
/**
|
|
|
|
* Return a shader that will apply the specified localMatrix to this shader.
|
|
|
|
* The specified matrix will be applied before any matrix associated with this shader.
|
|
|
|
*/
|
2016-03-10 14:36:49 +00:00
|
|
|
sk_sp<SkShader> makeWithLocalMatrix(const SkMatrix&) const;
|
2016-01-07 23:47:29 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Create a new shader that produces the same colors as invoking this shader and then applying
|
|
|
|
* the colorfilter.
|
|
|
|
*/
|
2016-03-22 17:17:23 +00:00
|
|
|
sk_sp<SkShader> makeWithColorFilter(sk_sp<SkColorFilter>) const;
|
2016-02-10 16:53:15 +00:00
|
|
|
|
2015-12-30 21:39:41 +00:00
|
|
|
//////////////////////////////////////////////////////////////////////////
|
|
|
|
// Factory methods for stock shaders
|
2016-11-12 15:29:26 +00:00
|
|
|
|
2014-05-05 18:39:18 +00:00
|
|
|
/**
|
|
|
|
* Call this to create a new "empty" shader, that will not draw anything.
|
|
|
|
*/
|
2016-03-09 02:50:00 +00:00
|
|
|
static sk_sp<SkShader> MakeEmptyShader();
|
2014-05-05 18:39:18 +00:00
|
|
|
|
2014-08-22 15:30:20 +00:00
|
|
|
/**
|
|
|
|
* Call this to create a new shader that just draws the specified color. This should always
|
|
|
|
* draw the same as a paint with this color (and no shader).
|
|
|
|
*/
|
2016-03-09 02:50:00 +00:00
|
|
|
static sk_sp<SkShader> MakeColorShader(SkColor);
|
|
|
|
|
2016-05-04 20:09:39 +00:00
|
|
|
/**
|
|
|
|
* Create a shader that draws the specified color (in the specified colorspace).
|
|
|
|
*
|
|
|
|
* This works around the limitation that SkPaint::setColor() only takes byte values, and does
|
|
|
|
* not support specific colorspaces.
|
|
|
|
*/
|
|
|
|
static sk_sp<SkShader> MakeColorShader(const SkColor4f&, sk_sp<SkColorSpace>);
|
|
|
|
|
2017-06-09 14:51:52 +00:00
|
|
|
/**
|
|
|
|
* Compose two shaders together, using two operators: mode and lerp. The resulting colors
|
|
|
|
* are computed by first combining the src and dst shaders using mode, and then linearly
|
|
|
|
* interpolating between the dst and result colors using lerp.
|
|
|
|
*
|
|
|
|
* result = dst * (1 - lerp) + (src (mode) dst) * lerp
|
|
|
|
*
|
|
|
|
* If either shader is nullptr, then this returns nullptr.
|
|
|
|
* If lerp is NaN then this returns nullptr, otherwise lerp is clamped to [0..1].
|
|
|
|
*/
|
|
|
|
static sk_sp<SkShader> MakeCompose(sk_sp<SkShader> dst, sk_sp<SkShader> src,
|
|
|
|
SkBlendMode mode, float lerp = 1);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* DEPRECATED: call MakeCompose.
|
|
|
|
*/
|
|
|
|
static sk_sp<SkShader> MakeComposeShader(sk_sp<SkShader> dst, sk_sp<SkShader> src,
|
|
|
|
SkBlendMode mode) {
|
|
|
|
return MakeCompose(std::move(dst), std::move(src), mode, 1);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Compose two shaders together using a weighted average.
|
|
|
|
*
|
|
|
|
* result = dst * (1 - lerp) + src * lerp
|
|
|
|
*
|
|
|
|
* If either shader is nullptr, then this returns nullptr.
|
|
|
|
* If lerp is NaN then this returns nullptr, otherwise lerp is clamped to [0..1].
|
|
|
|
*/
|
|
|
|
static sk_sp<SkShader> MakeMixer(sk_sp<SkShader> dst, sk_sp<SkShader> src, float lerp) {
|
|
|
|
return MakeCompose(std::move(dst), std::move(src), SkBlendMode::kSrc, lerp);
|
|
|
|
}
|
2016-10-28 19:42:34 +00:00
|
|
|
|
2008-12-17 15:59:43 +00:00
|
|
|
/** Call this to create a new shader that will draw with the specified bitmap.
|
2012-05-03 20:14:26 +00:00
|
|
|
*
|
|
|
|
* If the bitmap cannot be used (e.g. has no pixels, or its dimensions
|
|
|
|
* exceed implementation limits (currently at 64K - 1)) then SkEmptyShader
|
|
|
|
* may be returned.
|
|
|
|
*
|
2013-12-05 15:43:19 +00:00
|
|
|
* If the src is kA8_Config then that mask will be colorized using the color on
|
|
|
|
* the paint.
|
|
|
|
*
|
2012-05-03 20:14:26 +00:00
|
|
|
* @param src The bitmap to use inside the shader
|
|
|
|
* @param tmx The tiling mode to use when sampling the bitmap in the x-direction.
|
|
|
|
* @param tmy The tiling mode to use when sampling the bitmap in the y-direction.
|
|
|
|
* @return Returns a new shader object. Note: this function never returns null.
|
2008-12-17 15:59:43 +00:00
|
|
|
*/
|
2016-03-09 02:50:00 +00:00
|
|
|
static sk_sp<SkShader> MakeBitmapShader(const SkBitmap& src, TileMode tmx, TileMode tmy,
|
|
|
|
const SkMatrix* localMatrix = nullptr);
|
2008-12-17 15:59:43 +00:00
|
|
|
|
2015-09-08 14:12:25 +00:00
|
|
|
// NOTE: You can create an SkImage Shader with SkImage::newShader().
|
|
|
|
|
2014-04-08 15:19:34 +00:00
|
|
|
/** Call this to create a new shader that will draw with the specified picture.
|
|
|
|
*
|
|
|
|
* @param src The picture to use inside the shader (if not NULL, its ref count
|
2014-04-21 19:33:12 +00:00
|
|
|
* is incremented). The SkPicture must not be changed after
|
|
|
|
* successfully creating a picture shader.
|
2014-04-08 15:19:34 +00:00
|
|
|
* @param tmx The tiling mode to use when sampling the bitmap in the x-direction.
|
|
|
|
* @param tmy The tiling mode to use when sampling the bitmap in the y-direction.
|
2014-08-06 20:07:15 +00:00
|
|
|
* @param tile The tile rectangle in picture coordinates: this represents the subset
|
|
|
|
* (or superset) of the picture used when building a tile. It is not
|
|
|
|
* affected by localMatrix and does not imply scaling (only translation
|
|
|
|
* and cropping). If null, the tile rect is considered equal to the picture
|
|
|
|
* bounds.
|
2014-04-08 15:19:34 +00:00
|
|
|
* @return Returns a new shader object. Note: this function never returns null.
|
|
|
|
*/
|
2016-03-11 12:33:52 +00:00
|
|
|
static sk_sp<SkShader> MakePictureShader(sk_sp<SkPicture> src, TileMode tmx, TileMode tmy,
|
2016-03-09 02:50:00 +00:00
|
|
|
const SkMatrix* localMatrix, const SkRect* tile);
|
2014-04-08 15:19:34 +00:00
|
|
|
|
2017-05-24 21:15:46 +00:00
|
|
|
/**
|
|
|
|
* If this shader can be represented by another shader + a localMatrix, return that shader and
|
|
|
|
* the localMatrix. If not, return nullptr and ignore the localMatrix parameter.
|
|
|
|
*/
|
2017-05-25 14:38:07 +00:00
|
|
|
// TODO: clean up clients, move to SkShaderBase.
|
2017-05-24 21:15:46 +00:00
|
|
|
virtual sk_sp<SkShader> makeAsALocalMatrixShader(SkMatrix* localMatrix) const;
|
|
|
|
|
2017-05-26 16:54:32 +00:00
|
|
|
private:
|
2017-05-25 14:38:07 +00:00
|
|
|
SkShader() = default;
|
2017-05-26 16:54:32 +00:00
|
|
|
friend class SkShaderBase;
|
2017-05-15 19:06:39 +00:00
|
|
|
|
2008-12-17 15:59:43 +00:00
|
|
|
typedef SkFlattenable INHERITED;
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|