#include <SkImageShader.h>

Inheritance diagram for SkImageShader:

Public Member Functions
	SkImageShader (sk_sp< SkImage >, const SkRect &subset, SkTileMode tmx, SkTileMode tmy, const SkSamplingOptions &, bool raw, bool clampAsIfUnpremul)

bool	isOpaque () const override

ShaderType	type () const override

SkTileMode	tileModeX () const

SkTileMode	tileModeY () const

sk_sp< SkImage >	image () const

SkSamplingOptions	sampling () const

SkRect	subset () const

bool	isRaw () const

Public Member Functions inherited from SkShaderBase
	~SkShaderBase () override

sk_sp< SkShader >	makeInvertAlpha () const

sk_sp< SkShader >	makeWithCTM (const SkMatrix &) const

virtual bool	isConstant () const

virtual ShaderType	type () const =0

virtual GradientType	asGradient (GradientInfo info=nullptr, SkMatrix localMatrix=nullptr) const

Context *	makeContext (const ContextRec &, SkArenaAlloc *) const

bool	asLuminanceColor (SkColor4f *) const

bool	appendRootStages (const SkStageRec &rec, const SkMatrix &ctm) const

virtual bool	appendStages (const SkStageRec &, const SkShaders::MatrixRec &) const =0

virtual SkImage *	onIsAImage (SkMatrix *, SkTileMode[2]) const

virtual SkRuntimeEffect *	asRuntimeEffect () const

Type	getFlattenableType () const override

virtual sk_sp< SkShader >	makeAsALocalMatrixShader (SkMatrix *localMatrix) const

Public Member Functions inherited from SkShader
virtual bool	isOpaque () const

SkImage *	isAImage (SkMatrix *localMatrix, SkTileMode xy[2]) const

bool	isAImage () const

sk_sp< SkShader >	makeWithLocalMatrix (const SkMatrix &) const

sk_sp< SkShader >	makeWithColorFilter (sk_sp< SkColorFilter >) const

sk_sp< SkShader >	makeWithWorkingColorSpace (sk_sp< SkColorSpace >) const

Public Member Functions inherited from SkFlattenable
	SkFlattenable ()

virtual Factory	getFactory () const =0

virtual const char *	getTypeName () const =0

virtual void	flatten (SkWriteBuffer &) const

virtual Type	getFlattenableType () const =0

sk_sp< SkData >	serialize (const SkSerialProcs *=nullptr) const

size_t	serialize (void memory, size_t memory_size, const SkSerialProcs =nullptr) const

Public Member Functions inherited from SkRefCntBase
	SkRefCntBase ()

virtual	~SkRefCntBase ()

bool	unique () const

void	ref () const

void	unref () const

Static Public Member Functions
static sk_sp< SkShader >	Make (sk_sp< SkImage >, SkTileMode tmx, SkTileMode tmy, const SkSamplingOptions &, const SkMatrix *localMatrix, bool clampAsIfUnpremul=false)

static sk_sp< SkShader >	MakeRaw (sk_sp< SkImage >, SkTileMode tmx, SkTileMode tmy, const SkSamplingOptions &, const SkMatrix *localMatrix)

static sk_sp< SkShader >	MakeSubset (sk_sp< SkImage >, const SkRect &subset, SkTileMode tmx, SkTileMode tmy, const SkSamplingOptions &, const SkMatrix *localMatrix, bool clampAsIfUnpremul=false)

static SkM44	CubicResamplerMatrix (float B, float C)

Static Public Member Functions inherited from SkShaderBase
static Type	GetFlattenableType ()

static sk_sp< SkShaderBase >	Deserialize (const void data, size_t size, const SkDeserialProcs procs=nullptr)

static void	RegisterFlattenables ()

static SkMatrix	ConcatLocalMatrices (const SkMatrix &parentLM, const SkMatrix &childLM)

Static Public Member Functions inherited from SkFlattenable
static Factory	NameToFactory (const char name[])

static const char *	FactoryToName (Factory)

static void	Register (const char name[], Factory)

static sk_sp< SkFlattenable >	Deserialize (Type, const void data, size_t length, const SkDeserialProcs procs=nullptr)

Friends
class	SkShaderBase

Additional Inherited Members
Public Types inherited from SkShaderBase
enum class	ShaderType { M }

enum class	GradientType { kNone , M }

enum	Flags { kOpaqueAlpha_Flag = 1 << 0 }

Public Types inherited from SkFlattenable
enum	Type { kSkColorFilter_Type , kSkBlender_Type , kSkDrawable_Type , kSkDrawLooper_Type , kSkImageFilter_Type , kSkMaskFilter_Type , kSkPathEffect_Type , kSkShader_Type }

typedef sk_sp< SkFlattenable >(*	Factory) (SkReadBuffer &)

Protected Member Functions inherited from SkShaderBase
	SkShaderBase ()

void	flatten (SkWriteBuffer &) const override

virtual bool	onAsLuminanceColor (SkColor4f *) const

Detailed Description

Definition at line 28 of file SkImageShader.h.

Constructor & Destructor Documentation

◆ SkImageShader()

SkImageShader::SkImageShader	(	sk_sp< SkImage >	img,
		const SkRect &	subset,
		SkTileMode	tmx,
		SkTileMode	tmy,
		const SkSamplingOptions &	sampling,
		bool	raw,
		bool	clampAsIfUnpremul
	)

Definition at line 95 of file SkImageShader.cpp.

        : fImage(std::move(img))
        , fSampling(sampling)
        , fTileModeX(optimize(tmx, fImage->width()))
        , fTileModeY(optimize(tmy, fImage->height()))
        , fSubset(subset)
        , fRaw(raw)
        , fClampAsIfUnpremul(clampAsIfUnpremul) {
    // These options should never appear together:
    SkASSERT(!fRaw || !fClampAsIfUnpremul);
 
    // Bicubic filtering of raw image shaders would add a surprising clamp - so we don't support it
    SkASSERT(!fRaw || !fSampling.useCubic);
}

Member Function Documentation

◆ CubicResamplerMatrix()

SkM44 SkImageShader::CubicResamplerMatrix	(	float	B,
		float	C
	)

static

Definition at line 48 of file SkImageShader.cpp.

                                                          {
#if 0
    constexpr SkM44 kMitchell = SkM44( 1.f/18.f, -9.f/18.f,  15.f/18.f,  -7.f/18.f,
                                      16.f/18.f,  0.f/18.f, -36.f/18.f,  21.f/18.f,
                                       1.f/18.f,  9.f/18.f,  27.f/18.f, -21.f/18.f,
                                       0.f/18.f,  0.f/18.f,  -6.f/18.f,   7.f/18.f);
 
    constexpr SkM44 kCatmull = SkM44(0.0f, -0.5f,  1.0f, -0.5f,
                                     1.0f,  0.0f, -2.5f,  1.5f,
                                     0.0f,  0.5f,  2.0f, -1.5f,
                                     0.0f,  0.0f, -0.5f,  0.5f);
 
    if (B == 1.0f/3 && C == 1.0f/3) {
        return kMitchell;
    }
    if (B == 0 && C == 0.5f) {
        return kCatmull;
    }
#endif
    return SkM44(    (1.f/6)*B, -(3.f/6)*B - C,       (3.f/6)*B + 2*C,    - (1.f/6)*B - C,
                 1 - (2.f/6)*B,              0, -3 + (12.f/6)*B +   C,  2 - (9.f/6)*B - C,
                     (1.f/6)*B,  (3.f/6)*B + C,  3 - (15.f/6)*B - 2*C, -2 + (9.f/6)*B + C,
                             0,              0,                    -C,      (1.f/6)*B + C);
}

◆ image()

sk_sp< SkImage > SkImageShader::image ( ) const

inline

Definition at line 68 of file SkImageShader.h.

68{ return fImage; }

◆ isOpaque()

bool SkImageShader::isOpaque ( ) const

overridevirtual

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 optimizations.

Reimplemented from SkShader.

Definition at line 185 of file SkImageShader.cpp.

                                   {
    return fImage->isOpaque() &&
           fTileModeX != SkTileMode::kDecal && fTileModeY != SkTileMode::kDecal;
}

◆ isRaw()

bool SkImageShader::isRaw ( ) const

inline

Definition at line 71 of file SkImageShader.h.

71{ return fRaw; }

◆ Make()

sk_sp< SkShader > SkImageShader::Make	(	sk_sp< SkImage >	image,
		SkTileMode	tmx,
		SkTileMode	tmy,
		const SkSamplingOptions &	options,
		const SkMatrix *	localMatrix,
		bool	clampAsIfUnpremul = `false`
	)

static

Definition at line 294 of file SkImageShader.cpp.

                                                            {
    SkRect subset = image ? SkRect::Make(image->dimensions()) : SkRect::MakeEmpty();
    return MakeSubset(std::move(image), subset, tmx, tmy, options, localMatrix, clampAsIfUnpremul);
}

◆ MakeRaw()

sk_sp< SkShader > SkImageShader::MakeRaw	(	sk_sp< SkImage >	image,
		SkTileMode	tmx,
		SkTileMode	tmy,
		const SkSamplingOptions &	options,
		const SkMatrix *	localMatrix
	)

static

Definition at line 303 of file SkImageShader.cpp.

                                                                    {
    if (options.useCubic) {
        return nullptr;
    }
    if (!image) {
        return SkShaders::Empty();
    }
    auto subset = SkRect::Make(image->dimensions());
 
    sk_sp<SkShader> s = sk_make_sp<SkImageShader>(image,
                                                  subset,
                                                  tmx, tmy,
                                                  options,
                                                  /*raw=*/true,
                                                  /*clampAsIfUnpremul=*/false);
    return s->makeWithLocalMatrix(localMatrix ? *localMatrix : SkMatrix::I());
}

◆ MakeSubset()

sk_sp< SkShader > SkImageShader::MakeSubset	(	sk_sp< SkImage >	image,
		const SkRect &	subset,
		SkTileMode	tmx,
		SkTileMode	tmy,
		const SkSamplingOptions &	options,
		const SkMatrix *	localMatrix,
		bool	clampAsIfUnpremul = `false`
	)

static

Definition at line 324 of file SkImageShader.cpp.

                                                                  {
    auto is_unit = [](float x) {
        return x >= 0 && x <= 1;
    };
    if (options.useCubic) {
        if (!is_unit(options.cubic.B) || !is_unit(options.cubic.C)) {
            return nullptr;
        }
    }
    if (!image || subset.isEmpty()) {
        return SkShaders::Empty();
    }
 
    // Validate subset and check if we can drop it
    if (!SkRect::Make(image->bounds()).contains(subset)) {
        return nullptr;
    }
 
    sk_sp<SkShader> s = sk_make_sp<SkImageShader>(std::move(image),
                                                  subset,
                                                  tmx, tmy,
                                                  options,
                                                  /*raw=*/false,
                                                  clampAsIfUnpremul);
    return s->makeWithLocalMatrix(localMatrix ? *localMatrix : SkMatrix::I());
}

◆ sampling()

SkSamplingOptions SkImageShader::sampling ( ) const

inline

Definition at line 69 of file SkImageShader.h.

69{ return fSampling; }

◆ subset()

SkRect SkImageShader::subset ( ) const

inline

Definition at line 70 of file SkImageShader.h.

70{ return fSubset; }

◆ tileModeX()

SkTileMode SkImageShader::tileModeX ( ) const

inline

Definition at line 66 of file SkImageShader.h.

66{ return fTileModeX; }

◆ tileModeY()

SkTileMode SkImageShader::tileModeY ( ) const

inline

Definition at line 67 of file SkImageShader.h.

67{ return fTileModeY; }

◆ type()

ShaderType SkImageShader::type ( ) const

inlineoverridevirtual

Implements SkShaderBase.

Definition at line 62 of file SkImageShader.h.

62{ return ShaderType::kImage; }

Friends And Related Function Documentation

◆ SkShaderBase

friend class SkShaderBase

friend

Definition at line 96 of file SkImageShader.h.

The documentation for this class was generated from the following files:

third_party/skia/src/shaders/SkImageShader.h
third_party/skia/src/shaders/SkImageShader.cpp

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SkImageShader()

Member Function Documentation

◆ CubicResamplerMatrix()

◆ image()

◆ isOpaque()

◆ isRaw()

◆ Make()

◆ MakeRaw()

◆ MakeSubset()

◆ sampling()

◆ subset()

◆ tileModeX()

◆ tileModeY()

◆ type()

Friends And Related Function Documentation

◆ SkShaderBase