#include <vertices_contents.h>

Inheritance diagram for impeller::VerticesSimpleBlendContents:

Public Types
using	LazyTexture = std::function< std::shared_ptr< Texture >(const ContentContext &renderer)>

Public Types inherited from impeller::Contents
using	ColorFilterProc = std::function< Color(Color)>

using	RenderProc = std::function< bool(const ContentContext &renderer, const Entity &entity, RenderPass &pass)>

using	CoverageProc = std::function< std::optional< Rect >(const Entity &entity)>

Public Member Functions
	VerticesSimpleBlendContents ()

	~VerticesSimpleBlendContents () override

void	SetGeometry (std::shared_ptr< VerticesGeometry > geometry)

void	SetAlpha (Scalar alpha)

void	SetBlendMode (BlendMode blend_mode)

void	SetTexture (std::shared_ptr< Texture > texture)

void	SetLazyTexture (const LazyTexture &lazy_texture)

void	SetSamplerDescriptor (SamplerDescriptor descriptor)

void	SetTileMode (Entity::TileMode tile_mode_x, Entity::TileMode tile_mode_y)

void	SetEffectTransform (Matrix transform)

void	SetLazyTextureCoverage (Rect rect)

std::optional< Rect >	GetCoverage (const Entity &entity) const override
	Get the area of the render pass that will be affected when this contents is rendered. More...

bool	Render (const ContentContext &renderer, const Entity &entity, RenderPass &pass) const override

Public Member Functions inherited from impeller::Contents
	Contents ()

virtual	~Contents ()

virtual void	PopulateGlyphAtlas (const std::shared_ptr< LazyGlyphAtlas > &lazy_glyph_atlas, Scalar scale)
	Add any text data to the specified lazy atlas. The scale parameter must be used again later when drawing the text. More...

void	SetCoverageHint (std::optional< Rect > coverage_hint)
	Hint that specifies the coverage area of this Contents that will actually be used during rendering. This is for optimization purposes only and can not be relied on as a clip. May optionally affect the result of `GetCoverage()`. More...

const std::optional< Rect > &	GetCoverageHint () const

virtual bool	IsOpaque () const
	Whether this Contents only emits opaque source colors from the fragment stage. This value does not account for any entity properties (e.g. the blend mode), clips/visibility culling, or inherited opacity. More...

virtual ClipCoverage	GetClipCoverage (const Entity &entity, const std::optional< Rect > &current_clip_coverage) const
	Given the current pass space bounding rectangle of the clip buffer, return the expected clip coverage after this draw call. This should only be implemented for contents that may write to the clip buffer. More...

virtual std::optional< Snapshot >	RenderToSnapshot (const ContentContext &renderer, const Entity &entity, std::optional< Rect > coverage_limit=std::nullopt, const std::optional< SamplerDescriptor > &sampler_descriptor=std::nullopt, bool msaa_enabled=true, int32_t mip_count=1, const std::string &label="Snapshot") const
	Render this contents to a snapshot, respecting the entity's transform, path, clip depth, and blend mode. The result texture size is always the size of `GetCoverage(entity)`. More...

virtual bool	ShouldRender (const Entity &entity, const std::optional< Rect > clip_coverage) const

std::optional< Size >	GetColorSourceSize () const
	Return the color source's intrinsic size, if available. More...

void	SetColorSourceSize (Size size)

virtual bool	CanInheritOpacity (const Entity &entity) const
	Whether or not this contents can accept the opacity peephole optimization. More...

virtual void	SetInheritedOpacity (Scalar opacity)
	Inherit the provided opacity. More...

virtual std::optional< Color >	AsBackgroundColor (const Entity &entity, ISize target_size) const
	Returns a color if this Contents will flood the given `target_size` with a color. This output color is the "Source" color that will be used for the Entity's blend operation. More...

virtual const FilterContents *	AsFilter () const
	Cast to a filter. Returns `nullptr` if this Contents is not a filter. More...

virtual bool	ApplyColorFilter (const ColorFilterProc &color_filter_proc)
	If possible, applies a color filter to this contents inputs on the CPU. More...

Additional Inherited Members
Static Public Member Functions inherited from impeller::Contents
static std::shared_ptr< Contents >	MakeAnonymous (RenderProc render_proc, CoverageProc coverage_proc)

Detailed Description

A vertices contents for (optional) per-color vertices + texture and any blend mode.

Definition at line 20 of file vertices_contents.h.

Member Typedef Documentation

◆ LazyTexture

using impeller::VerticesSimpleBlendContents::LazyTexture = std::function<std::shared_ptr<Texture>(const ContentContext& renderer)>

Definition at line 27 of file vertices_contents.h.

Constructor & Destructor Documentation

◆ VerticesSimpleBlendContents()

impeller::VerticesSimpleBlendContents::VerticesSimpleBlendContents ( )

Definition at line 46 of file vertices_contents.cc.

46 {}

◆ ~VerticesSimpleBlendContents()

impeller::VerticesSimpleBlendContents::~VerticesSimpleBlendContents ( )

override

Definition at line 48 of file vertices_contents.cc.

48 {}

Member Function Documentation

◆ GetCoverage()

std::optional< Rect > impeller::VerticesSimpleBlendContents::GetCoverage ( const Entity & entity ) const

overridevirtual

Get the area of the render pass that will be affected when this contents is rendered.

During rendering, coverage coordinates count pixels from the top left corner of the framebuffer.

Returns: The coverage rectangle. An std::nullopt result means that rendering this contents has no effect on the output color.

Implements impeller::Contents.

Definition at line 67 of file vertices_contents.cc.

                                 {
   return geometry_->GetCoverage(entity.GetTransform());
 }

References impeller::Entity::GetTransform().

◆ Render()

bool impeller::VerticesSimpleBlendContents::Render	(	const ContentContext &	renderer,
		const Entity &	entity,
		RenderPass &	pass
	)		const

overridevirtual

Implements impeller::Contents.

Definition at line 96 of file vertices_contents.cc.

                                                                  {
   FML_DCHECK(texture_ || lazy_texture_ ||
              blend_mode_ == BlendMode::kDestination);
   BlendMode blend_mode = blend_mode_;
   if (!geometry_->HasVertexColors()) {
     blend_mode = BlendMode::kSource;
   }
  
   std::shared_ptr<Texture> texture;
   if (blend_mode != BlendMode::kDestination) {
     if (!texture_) {
       texture = lazy_texture_(renderer);
     } else {
       texture = texture_;
     }
   } else {
     texture = renderer.GetEmptyTexture();
   }
  
   auto dst_sampler_descriptor = descriptor_;
   dst_sampler_descriptor.width_address_mode =
       TileModeToAddressMode(tile_mode_x_, renderer.GetDeviceCapabilities())
           .value_or(SamplerAddressMode::kClampToEdge);
   dst_sampler_descriptor.height_address_mode =
       TileModeToAddressMode(tile_mode_y_, renderer.GetDeviceCapabilities())
           .value_or(SamplerAddressMode::kClampToEdge);
  
   const std::unique_ptr<const Sampler>& dst_sampler =
       renderer.GetContext()->GetSamplerLibrary()->GetSampler(
           dst_sampler_descriptor);
  
   GeometryResult geometry_result = geometry_->GetPositionUVColorBuffer(
       lazy_texture_coverage_.has_value() ? lazy_texture_coverage_.value()
                                          : Rect::MakeSize(texture->GetSize()),
       inverse_matrix_, renderer, entity, pass);
   if (geometry_result.vertex_buffer.vertex_count == 0) {
     return true;
   }
   FML_DCHECK(geometry_result.mode == GeometryResult::Mode::kNormal);
  
   if (blend_mode <= Entity::kLastPipelineBlendMode) {
     using VS = PorterDuffBlendPipeline::VertexShader;
     using FS = PorterDuffBlendPipeline::FragmentShader;
  
 #ifdef IMPELLER_DEBUG
     pass.SetCommandLabel(SPrintF("DrawVertices Porterduff Blend (%s)",
                                  BlendModeToString(blend_mode)));
 #endif  // IMPELLER_DEBUG
     pass.SetVertexBuffer(std::move(geometry_result.vertex_buffer));
  
     auto options = OptionsFromPassAndEntity(pass, entity);
     options.primitive_type = geometry_result.type;
     pass.SetPipeline(renderer.GetPorterDuffBlendPipeline(options));
  
     FS::BindTextureSamplerDst(pass, texture, dst_sampler);
  
     VS::FrameInfo frame_info;
     FS::FragInfo frag_info;
  
     frame_info.texture_sampler_y_coord_scale = texture->GetYCoordScale();
     frame_info.mvp = geometry_result.transform;
  
     frag_info.output_alpha = alpha_;
     frag_info.input_alpha = 1.0;
  
     auto inverted_blend_mode =
         InvertPorterDuffBlend(blend_mode).value_or(BlendMode::kSource);
     auto blend_coefficients =
         kPorterDuffCoefficients[static_cast<int>(inverted_blend_mode)];
     frag_info.src_coeff = blend_coefficients[0];
     frag_info.src_coeff_dst_alpha = blend_coefficients[1];
     frag_info.dst_coeff = blend_coefficients[2];
     frag_info.dst_coeff_src_alpha = blend_coefficients[3];
     frag_info.dst_coeff_src_color = blend_coefficients[4];
  
     // These values are ignored if the platform supports native decal mode.
     frag_info.tmx = static_cast<int>(tile_mode_x_);
     frag_info.tmy = static_cast<int>(tile_mode_y_);
  
     auto& host_buffer = renderer.GetTransientsBuffer();
     FS::BindFragInfo(pass, host_buffer.EmplaceUniform(frag_info));
     VS::BindFrameInfo(pass, host_buffer.EmplaceUniform(frame_info));
  
     return pass.Draw().ok();
   }
  
   using VS = VerticesUberShader::VertexShader;
   using FS = VerticesUberShader::FragmentShader;
  
 #ifdef IMPELLER_DEBUG
   pass.SetCommandLabel(SPrintF("DrawVertices Advanced Blend (%s)",
                                BlendModeToString(blend_mode)));
 #endif  // IMPELLER_DEBUG
   pass.SetVertexBuffer(std::move(geometry_result.vertex_buffer));
  
   auto options = OptionsFromPassAndEntity(pass, entity);
   options.primitive_type = geometry_result.type;
   pass.SetPipeline(renderer.GetDrawVerticesUberShader(options));
  
   FS::BindTextureSampler(pass, texture, dst_sampler);
  
   VS::FrameInfo frame_info;
   FS::FragInfo frag_info;
  
   frame_info.texture_sampler_y_coord_scale = texture->GetYCoordScale();
   frame_info.mvp = geometry_result.transform;
   frag_info.alpha = alpha_;
   frag_info.blend_mode = static_cast<int>(blend_mode);
  
   // These values are ignored if the platform supports native decal mode.
   frag_info.tmx = static_cast<int>(tile_mode_x_);
   frag_info.tmy = static_cast<int>(tile_mode_y_);
  
   auto& host_buffer = renderer.GetTransientsBuffer();
   FS::BindFragInfo(pass, host_buffer.EmplaceUniform(frag_info));
   VS::BindFrameInfo(pass, host_buffer.EmplaceUniform(frame_info));
  
   return pass.Draw().ok();
 }

References impeller::BlendModeToString(), impeller::RenderPass::Draw(), impeller::ContentContext::GetContext(), impeller::ContentContext::GetDeviceCapabilities(), impeller::ContentContext::GetDrawVerticesUberShader(), impeller::ContentContext::GetEmptyTexture(), impeller::ContentContext::GetPorterDuffBlendPipeline(), impeller::ContentContext::GetTransientsBuffer(), impeller::InvertPorterDuffBlend(), impeller::kClampToEdge, impeller::kDestination, impeller::Entity::kLastPipelineBlendMode, impeller::GeometryResult::kNormal, impeller::kPorterDuffCoefficients, impeller::kSource, impeller::TRect< Scalar >::MakeSize(), impeller::GeometryResult::mode, impeller::OptionsFromPassAndEntity(), impeller::RenderPass::SetCommandLabel(), impeller::RenderPass::SetPipeline(), impeller::RenderPass::SetVertexBuffer(), impeller::SPrintF(), impeller::TileModeToAddressMode(), impeller::GeometryResult::transform, impeller::GeometryResult::type, impeller::GeometryResult::vertex_buffer, impeller::VertexBuffer::vertex_count, and impeller::SamplerDescriptor::width_address_mode.

◆ SetAlpha()

void impeller::VerticesSimpleBlendContents::SetAlpha ( Scalar alpha )

Definition at line 55 of file vertices_contents.cc.

                                                        {
   alpha_ = alpha;
 }

◆ SetBlendMode()

void impeller::VerticesSimpleBlendContents::SetBlendMode ( BlendMode blend_mode )

Definition at line 59 of file vertices_contents.cc.

                                                                    {
   blend_mode_ = blend_mode;
 }

◆ SetEffectTransform()

void impeller::VerticesSimpleBlendContents::SetEffectTransform ( Matrix transform )

Definition at line 83 of file vertices_contents.cc.

                                                                      {
   inverse_matrix_ = transform.Invert();
 }

References transform.

◆ SetGeometry()

void impeller::VerticesSimpleBlendContents::SetGeometry ( std::shared_ptr< VerticesGeometry > geometry )

Definition at line 50 of file vertices_contents.cc.

                                               {
   geometry_ = std::move(geometry);
 }

◆ SetLazyTexture()

void impeller::VerticesSimpleBlendContents::SetLazyTexture ( const LazyTexture & lazy_texture )

Definition at line 87 of file vertices_contents.cc.

                                      {
   lazy_texture_ = lazy_texture;
 }

◆ SetLazyTextureCoverage()

void impeller::VerticesSimpleBlendContents::SetLazyTextureCoverage ( Rect rect )

Definition at line 92 of file vertices_contents.cc.

                                                                   {
   lazy_texture_coverage_ = rect;
 }

◆ SetSamplerDescriptor()

void impeller::VerticesSimpleBlendContents::SetSamplerDescriptor ( SamplerDescriptor descriptor )

Definition at line 72 of file vertices_contents.cc.

                                   {
   descriptor_ = std::move(descriptor);
 }

◆ SetTexture()

void impeller::VerticesSimpleBlendContents::SetTexture ( std::shared_ptr< Texture > texture )

Definition at line 63 of file vertices_contents.cc.

                                                                            {
   texture_ = std::move(texture);
 }

◆ SetTileMode()

void impeller::VerticesSimpleBlendContents::SetTileMode	(	Entity::TileMode	tile_mode_x,
		Entity::TileMode	tile_mode_y
	)

Definition at line 77 of file vertices_contents.cc.

                                                                           {
   tile_mode_x_ = tile_mode_x;
   tile_mode_y_ = tile_mode_y;
 }

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

impeller/entity/contents/vertices_contents.h
impeller/entity/contents/vertices_contents.cc

Public Types

Public Member Functions

Additional Inherited Members