#include <dl_image_filter.h>

Inheritance diagram for flutter::DlImageFilter:

Public Types
enum class	MatrixCapability { kTranslate , kScaleTranslate , kComplex }

Public Member Functions
virtual const DlBlurImageFilter *	asBlur () const

virtual const DlDilateImageFilter *	asDilate () const

virtual const DlErodeImageFilter *	asErode () const

virtual const DlMatrixImageFilter *	asMatrix () const

virtual const DlLocalMatrixImageFilter *	asLocalMatrix () const

virtual std::shared_ptr< DlImageFilter >	makeWithLocalMatrix (const DlMatrix &matrix) const

virtual const DlComposeImageFilter *	asCompose () const

virtual const DlColorFilterImageFilter *	asColorFilter () const

virtual const DlRuntimeEffectImageFilter *	asRuntimeEffectFilter () const

virtual bool	modifies_transparent_black () const =0

virtual DlRect *	map_local_bounds (const DlRect &input_bounds, DlRect &output_bounds) const =0

virtual DlIRect *	map_device_bounds (const DlIRect &input_bounds, const DlMatrix &ctm, DlIRect &output_bounds) const =0

virtual DlIRect *	get_input_device_bounds (const DlIRect &output_bounds, const DlMatrix &ctm, DlIRect &input_bounds) const =0

virtual MatrixCapability	matrix_capability () const

Public Member Functions inherited from flutter::DlAttribute< DlImageFilter, DlImageFilterType >
virtual DlImageFilterType	type () const=0

virtual size_t	size () const=0

virtual std::shared_ptr< DlImageFilter >	shared () const=0

bool	operator== (DlImageFilter const &other) const

bool	operator!= (DlImageFilter const &other) const

virtual	~DlAttribute ()=default

Static Public Member Functions
static std::shared_ptr< DlImageFilter >	MakeBlur (DlScalar sigma_x, DlScalar sigma_y, DlTileMode tile_mode)

static std::shared_ptr< DlImageFilter >	MakeDilate (DlScalar radius_x, DlScalar radius_y)

static std::shared_ptr< DlImageFilter >	MakeErode (DlScalar radius_x, DlScalar radius_y)

static std::shared_ptr< DlImageFilter >	MakeMatrix (const DlMatrix &matrix, DlImageSampling sampling)

static std::shared_ptr< DlImageFilter >	MakeRuntimeEffect (sk_sp< DlRuntimeEffect > runtime_effect, std::vector< std::shared_ptr< DlColorSource > > samplers, std::shared_ptr< std::vector< uint8_t > > uniform_data)

static std::shared_ptr< DlImageFilter >	MakeColorFilter (const std::shared_ptr< const DlColorFilter > &filter)

static std::shared_ptr< DlImageFilter >	MakeCompose (const std::shared_ptr< DlImageFilter > &outer, const std::shared_ptr< DlImageFilter > &inner)

Static Protected Member Functions
static DlVector2	map_vectors_affine (const DlMatrix &ctm, DlScalar x, DlScalar y)

static DlIRect *	inset_device_bounds (const DlIRect &input_bounds, DlScalar radius_x, DlScalar radius_y, const DlMatrix &ctm, DlIRect &output_bounds)

static DlIRect *	outset_device_bounds (const DlIRect &input_bounds, DlScalar radius_x, DlScalar radius_y, const DlMatrix &ctm, DlIRect &output_bounds)

Additional Inherited Members
Protected Member Functions inherited from flutter::DlAttribute< DlImageFilter, DlImageFilterType >
virtual bool	equals_ (DlImageFilter const &other) const=0

Detailed Description

Definition at line 46 of file dl_image_filter.h.

Member Enumeration Documentation

◆ MatrixCapability

enum class flutter::DlImageFilter::MatrixCapability

strong

Enumerator
kTranslate
kScaleTranslate
kComplex

Definition at line 48 of file dl_image_filter.h.

                              {
    kTranslate,
    kScaleTranslate,
    kComplex,
  };

Member Function Documentation

◆ asBlur()

virtual const DlBlurImageFilter * flutter::DlImageFilter::asBlur ( ) const

inlinevirtual

Reimplemented in flutter::DlBlurImageFilter.

Definition at line 81 of file dl_image_filter.h.

81{ return nullptr; }

Referenced by flutter::testing::DisplayListStreamDispatcher::out(), flutter::DlSkCanvasDispatcher::saveLayer(), flutter::DlSkCanvasAdapter::SaveLayer(), flutter::ToSk(), and impeller::WrapInput().

◆ asColorFilter()

virtual const DlColorFilterImageFilter * flutter::DlImageFilter::asColorFilter ( ) const

inlinevirtual

Reimplemented in flutter::DlColorFilterImageFilter.

Definition at line 108 of file dl_image_filter.h.

                                                                {
    return nullptr;
  }

Referenced by flutter::testing::DisplayListStreamDispatcher::out(), flutter::ToSk(), and impeller::WrapInput().

◆ asCompose()

virtual const DlComposeImageFilter * flutter::DlImageFilter::asCompose ( ) const

inlinevirtual

Reimplemented in flutter::DlComposeImageFilter.

Definition at line 104 of file dl_image_filter.h.

104{ return nullptr; }

Referenced by flutter::testing::DisplayListStreamDispatcher::out(), flutter::ToSk(), and impeller::WrapInput().

◆ asDilate()

virtual const DlDilateImageFilter * flutter::DlImageFilter::asDilate ( ) const

inlinevirtual

Reimplemented in flutter::DlDilateImageFilter.

Definition at line 85 of file dl_image_filter.h.

85{ return nullptr; }

Referenced by flutter::testing::DisplayListStreamDispatcher::out(), flutter::ToSk(), and impeller::WrapInput().

◆ asErode()

virtual const DlErodeImageFilter * flutter::DlImageFilter::asErode ( ) const

inlinevirtual

Reimplemented in flutter::DlErodeImageFilter.

Definition at line 89 of file dl_image_filter.h.

89{ return nullptr; }

Referenced by flutter::testing::DisplayListStreamDispatcher::out(), flutter::ToSk(), and impeller::WrapInput().

◆ asLocalMatrix()

virtual const DlLocalMatrixImageFilter * flutter::DlImageFilter::asLocalMatrix ( ) const

inlinevirtual

Reimplemented in flutter::DlLocalMatrixImageFilter.

Definition at line 95 of file dl_image_filter.h.

                                                                {
    return nullptr;
  }

Referenced by flutter::testing::DisplayListStreamDispatcher::out(), flutter::ToSk(), and impeller::WrapInput().

◆ asMatrix()

virtual const DlMatrixImageFilter * flutter::DlImageFilter::asMatrix ( ) const

inlinevirtual

Reimplemented in flutter::DlMatrixImageFilter.

Definition at line 93 of file dl_image_filter.h.

93{ return nullptr; }

Referenced by flutter::testing::DisplayListStreamDispatcher::out(), flutter::ToSk(), and impeller::WrapInput().

◆ asRuntimeEffectFilter()

virtual const DlRuntimeEffectImageFilter * flutter::DlImageFilter::asRuntimeEffectFilter ( ) const

inlinevirtual

Reimplemented in flutter::DlRuntimeEffectImageFilter.

Definition at line 114 of file dl_image_filter.h.

                                                                          {
    return nullptr;
  }

Referenced by flutter::testing::DisplayListStreamDispatcher::out(), and impeller::WrapInput().

◆ get_input_device_bounds()

virtual DlIRect * flutter::DlImageFilter::get_input_device_bounds	(	const DlIRect &	output_bounds,
		const DlMatrix &	ctm,
		DlIRect &	input_bounds
	)		const

pure virtual

Implemented in flutter::DlBlurImageFilter, flutter::DlColorFilterImageFilter, flutter::DlComposeImageFilter, flutter::DlDilateImageFilter, flutter::DlErodeImageFilter, flutter::DlLocalMatrixImageFilter, flutter::DlMatrixImageFilter, and flutter::DlRuntimeEffectImageFilter.

Referenced by flutter::testing::TestBoundsWithMatrix(), flutter::testing::TestInvalidBounds(), and flutter::testing::TestUnboundedBounds().

◆ inset_device_bounds()

DlIRect * flutter::DlImageFilter::inset_device_bounds	(	const DlIRect &	input_bounds,
		DlScalar	radius_x,
		DlScalar	radius_y,
		const DlMatrix &	ctm,
		DlIRect &	output_bounds
	)

staticprotected

Definition at line 84 of file dl_image_filter.cc.

                                                                    {
  if (ctm.IsFinite() && ctm.IsInvertible()) {
    if (ctm.HasPerspective2D()) {
      // Ideally this code would use Impeller classes to do the math, see:
      // https://github.com/flutter/flutter/issues/159175
      SkMatrix sk_ctm = ToSkMatrix(ctm);
      FML_DCHECK(sk_ctm.hasPerspective());
      SkIRect sk_input_bounds =
          SkIRect::MakeLTRB(input_bounds.GetLeft(), input_bounds.GetTop(),
                            input_bounds.GetRight(), input_bounds.GetBottom());
 
      SkMatrix inverse;
      if (sk_ctm.invert(&inverse)) {
        SkRect local_bounds = inverse.mapRect(SkRect::Make(sk_input_bounds));
        local_bounds.inset(radius_x, radius_y);
        output_bounds = ToDlIRect(sk_ctm.mapRect(local_bounds).roundOut());
        return &output_bounds;
      }
    } else {
      DlVector2 device_radius = map_vectors_affine(ctm, radius_x, radius_y);
      output_bounds =
          input_bounds.Expand(-floor(device_radius.x), -floor(device_radius.y));
      return &output_bounds;
    }
  }
  output_bounds = input_bounds;
  return nullptr;
}

References impeller::TRect< T >::Expand(), FML_DCHECK, impeller::TRect< T >::GetBottom(), impeller::TRect< T >::GetLeft(), impeller::TRect< T >::GetRight(), impeller::TRect< T >::GetTop(), impeller::Matrix::HasPerspective2D(), impeller::Matrix::IsFinite(), impeller::Matrix::IsInvertible(), map_vectors_affine(), flutter::ToDlIRect(), flutter::ToSkMatrix(), impeller::TPoint< T >::x, and impeller::TPoint< T >::y.

Referenced by flutter::DlDilateImageFilter::get_input_device_bounds(), and flutter::DlErodeImageFilter::map_device_bounds().

◆ MakeBlur()

std::shared_ptr< DlImageFilter > flutter::DlImageFilter::MakeBlur	(	DlScalar	sigma_x,
		DlScalar	sigma_y,
		DlTileMode	tile_mode
	)

static

Definition at line 12 of file dl_image_filter.cc.

                                                                             {
  return DlBlurImageFilter::Make(sigma_x, sigma_y, tile_mode);
}

References flutter::DlBlurImageFilter::Make().

◆ MakeColorFilter()

std::shared_ptr< DlImageFilter > flutter::DlImageFilter::MakeColorFilter ( const std::shared_ptr< const DlColorFilter > & filter )

static

Definition at line 42 of file dl_image_filter.cc.

                                                      {
  return DlColorFilterImageFilter::Make(filter);
}

References flutter::DlColorFilterImageFilter::Make().

◆ MakeCompose()

std::shared_ptr< DlImageFilter > flutter::DlImageFilter::MakeCompose	(	const std::shared_ptr< DlImageFilter > &	outer,
		const std::shared_ptr< DlImageFilter > &	inner
	)

static

Definition at line 47 of file dl_image_filter.cc.

                                               {
  return DlComposeImageFilter::Make(outer, inner);
}

References flutter::DlComposeImageFilter::Make().

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

◆ MakeDilate()

std::shared_ptr< DlImageFilter > flutter::DlImageFilter::MakeDilate	(	DlScalar	radius_x,
		DlScalar	radius_y
	)

static

Definition at line 18 of file dl_image_filter.cc.

                                                                            {
  return DlDilateImageFilter::Make(radius_x, radius_y);
}

References flutter::DlDilateImageFilter::Make().

Referenced by flutter::testing::TEST(), flutter::testing::TEST_F(), and impeller::testing::TEST_P().

◆ MakeErode()

std::shared_ptr< DlImageFilter > flutter::DlImageFilter::MakeErode	(	DlScalar	radius_x,
		DlScalar	radius_y
	)

static

Definition at line 23 of file dl_image_filter.cc.

                                                                           {
  return DlErodeImageFilter::Make(radius_x, radius_y);
}

References flutter::DlErodeImageFilter::Make().

Referenced by flutter::testing::TEST_F(), and impeller::testing::TEST_P().

◆ MakeMatrix()

std::shared_ptr< DlImageFilter > flutter::DlImageFilter::MakeMatrix	(	const DlMatrix &	matrix,
		DlImageSampling	sampling
	)

static

Definition at line 28 of file dl_image_filter.cc.

                              {
  return DlMatrixImageFilter::Make(matrix, sampling);
}

References flutter::DlMatrixImageFilter::Make().

◆ MakeRuntimeEffect()

std::shared_ptr< DlImageFilter > flutter::DlImageFilter::MakeRuntimeEffect	(	sk_sp< DlRuntimeEffect >	runtime_effect,
		std::vector< std::shared_ptr< DlColorSource > >	samplers,
		std::shared_ptr< std::vector< uint8_t > >	uniform_data
	)

static

Definition at line 34 of file dl_image_filter.cc.

                                                    {
  return DlRuntimeEffectImageFilter::Make(
      std::move(runtime_effect), std::move(samplers), std::move(uniform_data));
}

References flutter::DlRuntimeEffectImageFilter::Make().

Referenced by flutter::FragmentProgram::MakeDlImageFilter(), flutter::testing::TEST(), flutter::testing::TEST_F(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), and impeller::testing::TEST_P().

◆ makeWithLocalMatrix()

std::shared_ptr< DlImageFilter > flutter::DlImageFilter::makeWithLocalMatrix ( const DlMatrix & matrix ) const

virtual

Definition at line 150 of file dl_image_filter.cc.

                                  {
  if (matrix.IsIdentity()) {
    return shared();
  }
  // Matrix
  switch (this->matrix_capability()) {
    case MatrixCapability::kTranslate: {
      if (!matrix.IsTranslationOnly()) {
        // Nothing we can do at this point
        return nullptr;
      }
      break;
    }
    case MatrixCapability::kScaleTranslate: {
      if (!matrix.IsTranslationScaleOnly()) {
        // Nothing we can do at this point
        return nullptr;
      }
      break;
    }
    default:
      break;
  }
  return DlLocalMatrixImageFilter::Make(matrix, shared());
}

References impeller::Matrix::IsIdentity(), impeller::Matrix::IsTranslationOnly(), impeller::Matrix::IsTranslationScaleOnly(), kScaleTranslate, kTranslate, flutter::DlLocalMatrixImageFilter::Make(), matrix_capability(), and flutter::DlAttribute< DlImageFilter, DlImageFilterType >::shared().

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

◆ map_device_bounds()

virtual DlIRect * flutter::DlImageFilter::map_device_bounds	(	const DlIRect &	input_bounds,
		const DlMatrix &	ctm,
		DlIRect &	output_bounds
	)		const

pure virtual

Implemented in flutter::DlBlurImageFilter, flutter::DlColorFilterImageFilter, flutter::DlComposeImageFilter, flutter::DlDilateImageFilter, flutter::DlErodeImageFilter, flutter::DlLocalMatrixImageFilter, flutter::DlMatrixImageFilter, and flutter::DlRuntimeEffectImageFilter.

Referenced by flutter::testing::TestBoundsWithMatrix(), flutter::testing::TestInvalidBounds(), and flutter::testing::TestUnboundedBounds().

◆ map_local_bounds()

virtual DlRect * flutter::DlImageFilter::map_local_bounds	(	const DlRect &	input_bounds,
		DlRect &	output_bounds
	)		const

pure virtual

Implemented in flutter::DlBlurImageFilter, flutter::DlColorFilterImageFilter, flutter::DlComposeImageFilter, flutter::DlDilateImageFilter, flutter::DlErodeImageFilter, flutter::DlLocalMatrixImageFilter, flutter::DlMatrixImageFilter, and flutter::DlRuntimeEffectImageFilter.

Referenced by flutter::testing::TestBounds(), flutter::testing::TestInvalidBounds(), and flutter::testing::TestUnboundedBounds().

◆ map_vectors_affine()

DlVector2 flutter::DlImageFilter::map_vectors_affine	(	const DlMatrix &	ctm,
		DlScalar	x,
		DlScalar	y
	)

staticprotected

Definition at line 53 of file dl_image_filter.cc.

                                                        {
  FML_DCHECK(std::isfinite(x) && x >= 0);
  FML_DCHECK(std::isfinite(y) && y >= 0);
  FML_DCHECK(ctm.IsFinite() && !ctm.HasPerspective2D());
 
  // The x and y scalars would have been used to expand a local space
  // rectangle which is then transformed by ctm. In order to do the
  // expansion correctly, we should look at the relevant math. The
  // 4 corners will be moved outward by the following vectors:
  //     (UL,UR,LR,LL) = ((-x, -y), (+x, -y), (+x, +y), (-x, +y))
  // After applying the transform, each of these vectors could be
  // pointing in any direction so we need to examine each transformed
  // delta vector and how it affected the bounds.
  // Looking at just the affine 2x3 entries of the CTM we can delta
  // transform these corner offsets and get the following:
  //     UL = dCTM(-x, -y) = (- x*m00 - y*m01, - x*m10 - y*m11)
  //     UR = dCTM(+x, -y) = (  x*m00 - y*m01,   x*m10 - y*m11)
  //     LR = dCTM(+x, +y) = (  x*m00 + y*m01,   x*m10 + y*m11)
  //     LL = dCTM(-x, +y) = (- x*m00 + y*m01, - x*m10 + y*m11)
  // The X vectors are all some variation of adding or subtracting
  // the sum of x*m00 and y*m01 or their difference. Similarly the Y
  // vectors are +/- the associated sum/difference of x*m10 and y*m11.
  // The largest displacements, both left/right or up/down, will
  // happen when the signs of the m00/m01/m10/m11 matrix entries
  // coincide with the signs of the scalars, i.e. are all positive.
  return {x * abs(ctm.m[0]) + y * abs(ctm.m[4]),
          x * abs(ctm.m[1]) + y * abs(ctm.m[5])};
}

References FML_DCHECK, impeller::Matrix::HasPerspective2D(), impeller::Matrix::IsFinite(), impeller::Matrix::m, x, and y.

Referenced by inset_device_bounds(), and outset_device_bounds().

◆ matrix_capability()

virtual MatrixCapability flutter::DlImageFilter::matrix_capability ( ) const

inlinevirtual

Reimplemented in flutter::DlColorFilterImageFilter, and flutter::DlComposeImageFilter.

Definition at line 163 of file dl_image_filter.h.

                                                     {
    return MatrixCapability::kScaleTranslate;
  }

References kScaleTranslate.

Referenced by makeWithLocalMatrix().

◆ modifies_transparent_black()

virtual bool flutter::DlImageFilter::modifies_transparent_black ( ) const

pure virtual

Implemented in flutter::DlBlurImageFilter, flutter::DlColorFilterImageFilter, flutter::DlComposeImageFilter, flutter::DlDilateImageFilter, flutter::DlErodeImageFilter, flutter::DlLocalMatrixImageFilter, flutter::DlMatrixImageFilter, and flutter::DlRuntimeEffectImageFilter.

Referenced by flutter::testing::DisplayListNopTest::test_attributes_image().

◆ outset_device_bounds()

DlIRect * flutter::DlImageFilter::outset_device_bounds	(	const DlIRect &	input_bounds,
		DlScalar	radius_x,
		DlScalar	radius_y,
		const DlMatrix &	ctm,
		DlIRect &	output_bounds
	)

staticprotected

Definition at line 117 of file dl_image_filter.cc.

                                                                     {
  if (ctm.IsFinite() && ctm.IsInvertible()) {
    if (ctm.HasPerspective2D()) {
      // Ideally this code would use Impeller classes to do the math, see:
      // https://github.com/flutter/flutter/issues/159175
      SkMatrix sk_ctm = ToSkMatrix(ctm);
      FML_DCHECK(sk_ctm.hasPerspective());
      SkIRect sk_input_bounds =
          SkIRect::MakeLTRB(input_bounds.GetLeft(), input_bounds.GetTop(),
                            input_bounds.GetRight(), input_bounds.GetBottom());
 
      SkMatrix inverse;
      if (sk_ctm.invert(&inverse)) {
        SkRect local_bounds = inverse.mapRect(SkRect::Make(sk_input_bounds));
        local_bounds.outset(radius_x, radius_y);
        output_bounds = ToDlIRect(sk_ctm.mapRect(local_bounds).roundOut());
        return &output_bounds;
      }
    } else {
      DlVector2 device_radius = map_vectors_affine(ctm, radius_x, radius_y);
      output_bounds =
          input_bounds.Expand(ceil(device_radius.x), ceil(device_radius.y));
      return &output_bounds;
    }
  }
  output_bounds = input_bounds;
  return nullptr;
}

References impeller::TRect< T >::Expand(), FML_DCHECK, impeller::TRect< T >::GetBottom(), impeller::TRect< T >::GetLeft(), impeller::TRect< T >::GetRight(), impeller::TRect< T >::GetTop(), impeller::Matrix::HasPerspective2D(), impeller::Matrix::IsFinite(), impeller::Matrix::IsInvertible(), map_vectors_affine(), flutter::ToDlIRect(), flutter::ToSkMatrix(), impeller::TPoint< T >::x, and impeller::TPoint< T >::y.

Referenced by flutter::DlErodeImageFilter::get_input_device_bounds(), flutter::DlBlurImageFilter::map_device_bounds(), and flutter::DlDilateImageFilter::map_device_bounds().

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

display_list/effects/dl_image_filter.h
display_list/effects/dl_image_filter.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ MatrixCapability

Member Function Documentation

◆ asBlur()

◆ asColorFilter()

◆ asCompose()

◆ asDilate()

◆ asErode()

◆ asLocalMatrix()

◆ asMatrix()

◆ asRuntimeEffectFilter()

◆ get_input_device_bounds()

◆ inset_device_bounds()

◆ MakeBlur()

◆ MakeColorFilter()

◆ MakeCompose()

◆ MakeDilate()

◆ MakeErode()

◆ MakeMatrix()

◆ MakeRuntimeEffect()

◆ makeWithLocalMatrix()

◆ map_device_bounds()

◆ map_local_bounds()

◆ map_vectors_affine()

◆ matrix_capability()

◆ modifies_transparent_black()

◆ outset_device_bounds()