flutter::DlImageColorSource Class Reference

#include <dl_image_color_source.h>

Inheritance diagram for flutter::DlImageColorSource:

Public Member Functions
	DlImageColorSource (sk_sp< const DlImage > image, DlTileMode horizontal_tile_mode, DlTileMode vertical_tile_mode, DlImageSampling sampling=DlImageSampling::kLinear, const DlMatrix *matrix=nullptr)
bool	isUIThreadSafe () const override
	If the underlying platform data held by this object is held in a way that it can be stored and potentially released from the UI thread, this method returns true.
const DlImageColorSource *	asImage () const override
std::shared_ptr< DlColorSource >	shared () const override
std::shared_ptr< DlColorSource >	WithSampling (DlImageSampling sampling) const
DlColorSourceType	type () const override
size_t	size () const override
bool	is_opaque () const override
sk_sp< const DlImage >	image () const
DlTileMode	horizontal_tile_mode () const
DlTileMode	vertical_tile_mode () const
DlImageSampling	sampling () const
Public Member Functions inherited from flutter::DlMatrixColorSourceBase
const DlMatrix &	matrix () const
const DlMatrix *	matrix_ptr () const
Public Member Functions inherited from flutter::DlColorSource
virtual bool	isGradient () const
	If the underlying platform data represents a gradient.
virtual const DlLinearGradientColorSource *	asLinearGradient () const
virtual const DlRadialGradientColorSource *	asRadialGradient () const
virtual const DlConicalGradientColorSource *	asConicalGradient () const
virtual const DlSweepGradientColorSource *	asSweepGradient () const
virtual const DlRuntimeEffectColorSource *	asRuntimeEffect () const
Public Member Functions inherited from flutter::DlAttribute< DlColorSource, DlColorSourceType >
bool	operator== (DlColorSource const &other) const
bool	operator!= (DlColorSource const &other) const
virtual	~DlAttribute ()=default

Protected Member Functions
bool	equals_ (DlColorSource const &other) const override
Protected Member Functions inherited from flutter::DlMatrixColorSourceBase
	DlMatrixColorSourceBase (const DlMatrix *matrix)
Protected Member Functions inherited from flutter::DlColorSource
	DlColorSource ()=default

Additional Inherited Members
Static Public Member Functions inherited from flutter::DlColorSource
static std::shared_ptr< DlColorSource >	MakeImage (const sk_sp< const DlImage > &image, DlTileMode horizontal_tile_mode, DlTileMode vertical_tile_mode, DlImageSampling sampling=DlImageSampling::kLinear, const DlMatrix *matrix=nullptr)
static std::shared_ptr< DlColorSource >	MakeLinear (const DlPoint start_point, const DlPoint end_point, uint32_t stop_count, const DlColor *colors, const float *stops, DlTileMode tile_mode, const DlMatrix *matrix=nullptr)
static std::shared_ptr< DlColorSource >	MakeLinear (const DlPoint start_point, const DlPoint end_point, uint32_t stop_count, const DlScalar *colors_argb, const float *stops, DlTileMode tile_mode, const DlMatrix *matrix=nullptr)
	Make a linear gradient.
static std::shared_ptr< DlColorSource >	MakeRadial (DlPoint center, DlScalar radius, uint32_t stop_count, const DlColor *colors, const float *stops, DlTileMode tile_mode, const DlMatrix *matrix=nullptr)
static std::shared_ptr< DlColorSource >	MakeRadial (DlPoint center, DlScalar radius, uint32_t stop_count, const DlScalar *colors_argb, const float *stops, DlTileMode tile_mode, const DlMatrix *matrix=nullptr)
	Make a radial gradient.
static std::shared_ptr< DlColorSource >	MakeConical (DlPoint start_center, DlScalar start_radius, DlPoint end_center, DlScalar end_radius, uint32_t stop_count, const DlColor *colors, const float *stops, DlTileMode tile_mode, const DlMatrix *matrix=nullptr)
static std::shared_ptr< DlColorSource >	MakeConical (DlPoint start_center, DlScalar start_radius, DlPoint end_center, DlScalar end_radius, uint32_t stop_count, const DlScalar *colors_argb, const float *stops, DlTileMode tile_mode, const DlMatrix *matrix=nullptr)
	Make a conical gradient.
static std::shared_ptr< DlColorSource >	MakeSweep (DlPoint center, DlScalar start, DlScalar end, uint32_t stop_count, const DlColor *colors, const float *stops, DlTileMode tile_mode, const DlMatrix *matrix=nullptr)
static std::shared_ptr< DlColorSource >	MakeSweep (DlPoint center, DlScalar start, DlScalar end, uint32_t stop_count, const DlScalar *colors_argb, const float *stops, DlTileMode tile_mode, const DlMatrix *matrix=nullptr)
	Make a sweep gradient.
static std::shared_ptr< DlColorSource >	MakeRuntimeEffect (sk_sp< DlRuntimeEffect > runtime_effect, std::vector< std::shared_ptr< DlColorSource > > samplers, std::shared_ptr< std::vector< uint8_t > > uniform_data)

Detailed Description

Definition at line 12 of file dl_image_color_source.h.

Constructor & Destructor Documentation

DlImageColorSource()

flutter::DlImageColorSource::DlImageColorSource	(	sk_sp< const DlImage >	image,
		DlTileMode	horizontal_tile_mode,
		DlTileMode	vertical_tile_mode,
		DlImageSampling	sampling = DlImageSampling::kLinear,
		const DlMatrix *	matrix = nullptr
	)

Definition at line 9 of file dl_image_color_source.cc.

    : DlMatrixColorSourceBase(matrix),
      image_(std::move(image)),
      horizontal_tile_mode_(horizontal_tile_mode),
      vertical_tile_mode_(vertical_tile_mode),
      sampling_(sampling) {}

Member Function Documentation

asImage()

const DlImageColorSource * flutter::DlImageColorSource::asImage ( ) const

inlineoverridevirtual

Reimplemented from flutter::DlColorSource.

Definition at line 24 of file dl_image_color_source.h.

{ return this; }

Referenced by flutter::testing::TEST().

equals_()

bool flutter::DlImageColorSource::equals_ ( DlColorSource const &  other ) const

overrideprotectedvirtual

Implements flutter::DlAttribute< DlColorSource, DlColorSourceType >.

Definition at line 27 of file dl_image_color_source.cc.

                                                                 {
  FML_DCHECK(other.type() == DlColorSourceType::kImage);
  auto that = static_cast<DlImageColorSource const*>(&other);
  return (image_->Equals(that->image_) && matrix() == that->matrix() &&
          horizontal_tile_mode_ == that->horizontal_tile_mode_ &&
          vertical_tile_mode_ == that->vertical_tile_mode_ &&
          sampling_ == that->sampling_);
}

References FML_DCHECK, flutter::kImage, flutter::DlMatrixColorSourceBase::matrix(), and flutter::DlAttribute< D, T >::type().

horizontal_tile_mode()

DlTileMode flutter::DlImageColorSource::horizontal_tile_mode ( ) const

inline

Definition at line 38 of file dl_image_color_source.h.

{ return horizontal_tile_mode_; }

Referenced by impeller::Paint::CreateContents(), impeller::Canvas::DrawVertices(), flutter::testing::DisplayListStreamDispatcher::setColorSource(), flutter::testing::TEST(), flutter::testing::TEST(), and flutter::ToSk().

image()

sk_sp< const DlImage > flutter::DlImageColorSource::image ( ) const

inline

Definition at line 37 of file dl_image_color_source.h.

{ return image_; }

Referenced by impeller::Paint::CreateContents(), impeller::Canvas::DrawVertices(), flutter::testing::DisplayListStreamDispatcher::setColorSource(), flutter::testing::TEST(), flutter::testing::TEST(), and flutter::ToSk().

is_opaque()

bool flutter::DlImageColorSource::is_opaque ( ) const

inlineoverridevirtual

Implements flutter::DlColorSource.

Definition at line 35 of file dl_image_color_source.h.

{ return image_->isOpaque(); }

Referenced by flutter::testing::TEST(), and flutter::testing::TEST().

isUIThreadSafe()

bool flutter::DlImageColorSource::isUIThreadSafe ( ) const

inlineoverridevirtual

If the underlying platform data held by this object is held in a way that it can be stored and potentially released from the UI thread, this method returns true.

Returns

True if the class has no GPU related resources or if any that it holds are held in a thread-safe manner.

Implements flutter::DlColorSource.

Definition at line 20 of file dl_image_color_source.h.

                                       {
    return image_ ? image_->isUIThreadSafe() : true;
  }

sampling()

DlImageSampling flutter::DlImageColorSource::sampling ( ) const

inline

Definition at line 40 of file dl_image_color_source.h.

{ return sampling_; }

Referenced by impeller::Paint::CreateContents(), impeller::Canvas::DrawVertices(), flutter::testing::DisplayListStreamDispatcher::setColorSource(), flutter::ImageShader::shader(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::ToSk(), and WithSampling().

shared()

std::shared_ptr< DlColorSource > flutter::DlImageColorSource::shared ( ) const

inlineoverridevirtual

Implements flutter::DlAttribute< DlColorSource, DlColorSourceType >.

Definition at line 26 of file dl_image_color_source.h.

                                                       {
    return WithSampling(sampling_);
  }

References WithSampling().

Referenced by flutter::testing::TEST().

size()

size_t flutter::DlImageColorSource::size ( ) const

inlineoverridevirtual

Implements flutter::DlAttribute< DlColorSource, DlColorSourceType >.

Definition at line 33 of file dl_image_color_source.h.

{ return sizeof(*this); }

type()

DlColorSourceType flutter::DlImageColorSource::type ( ) const

inlineoverridevirtual

Implements flutter::DlAttribute< DlColorSource, DlColorSourceType >.

Definition at line 32 of file dl_image_color_source.h.

{ return DlColorSourceType::kImage; }

References flutter::kImage.

vertical_tile_mode()

DlTileMode flutter::DlImageColorSource::vertical_tile_mode ( ) const

inline

Definition at line 39 of file dl_image_color_source.h.

{ return vertical_tile_mode_; }

Referenced by impeller::Paint::CreateContents(), impeller::Canvas::DrawVertices(), flutter::testing::DisplayListStreamDispatcher::setColorSource(), flutter::testing::TEST(), flutter::testing::TEST(), and flutter::ToSk().

WithSampling()

std::shared_ptr< DlColorSource > flutter::DlImageColorSource::WithSampling

(

DlImageSampling

sampling

)

const

Definition at line 20 of file dl_image_color_source.cc.

                                    {
  return std::make_shared<DlImageColorSource>(image_, horizontal_tile_mode_,
                                              vertical_tile_mode_, sampling,
                                              matrix_ptr());
}

References flutter::DlMatrixColorSourceBase::matrix_ptr(), and sampling().

Referenced by flutter::ImageShader::shader(), and shared().

---

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

• display_list/effects/color_sources/dl_image_color_source.h
• display_list/effects/color_sources/dl_image_color_source.cc