| Flutter Impeller |

Public Types | Public Member Functions | List of all members
impeller::TiledTextureContents Class Referencefinal

`#include <tiled_texture_contents.h>`

Inheritance diagram for impeller::TiledTextureContents:

## Public Types
using | ColorFilterProc = std::function< std::shared_ptr< ColorFilterContents >(FilterInput::Ref)>
Public Types inherited from impeller::ColorSourceContents
using | BindFragmentCallback = std::function< bool(RenderPass &pass)>
using | PipelineBuilderCallback = std::function< PipelineRef(ContentContextOptions)>
using | CreateGeometryCallback = std::function< GeometryResult(const ContentContext &renderer, const Entity &entity, RenderPass &pass, const Geometry *geom)>
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
| TiledTextureContents ()
| ~TiledTextureContents () override
bool | IsOpaque (const Matrix &transform) const override
| 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...
bool | Render (const ContentContext &renderer, const Entity &entity, RenderPass &pass) const override
void | SetTexture (std::shared_ptr< Texture > texture)
void | SetTileModes (Entity::TileMode x_tile_mode, Entity::TileMode y_tile_mode)
void | SetSamplerDescriptor (const SamplerDescriptor &desc)
void | SetColorFilter (ColorFilterProc color_filter)
| Set a color filter to apply directly to this tiled texture. More...
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, std::string_view label="Tiled Texture Snapshot") const override
| 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...
Public Member Functions inherited from impeller::ColorSourceContents
| ColorSourceContents ()
| ~ColorSourceContents () override
void | SetGeometry (const Geometry *geometry)
| Set the geometry that this contents will use to render. More...
const Geometry * | GetGeometry () const
| Get the geometry that this contents will use to render. More...
void | SetEffectTransform (Matrix matrix)
| Set the effect transform for this color source. More...
const Matrix & | GetInverseEffectTransform () const
| Set the inverted effect transform for this color source. More...
void | SetOpacityFactor (Scalar opacity)
| Set the opacity factor for this color source. More...
Scalar | GetOpacityFactor () const
| Get the opacity factor for this color source. More...
virtual bool | IsSolidColor () const
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...
void | SetInheritedOpacity (Scalar opacity) override
| Inherit the provided opacity. More...
Public Member Functions inherited from impeller::Contents
| Contents ()
virtual | ~Contents ()
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
std::optional< Size > | GetColorSourceSize () const
| Return the color source's intrinsic size, if available. More...
void | SetColorSourceSize (Size size)
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 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::ColorSourceContents
template<typename VertexShaderT >
static bool | DrawGeometry (const Contents *contents, const Geometry *geometry, const ContentContext &renderer, const Entity &entity, RenderPass &pass, const PipelineBuilderCallback &pipeline_callback, typename VertexShaderT::FrameInfo frame_info, const BindFragmentCallback &bind_fragment_callback, bool force_stencil=false, const CreateGeometryCallback &create_geom_callback=DefaultCreateGeometryCallback)
Static Public Member Functions inherited from impeller::Contents
static std::shared_ptr< Contents > | MakeAnonymous (RenderProc render_proc, CoverageProc coverage_proc)
Protected Member Functions inherited from impeller::ColorSourceContents
bool | AppliesAlphaForStrokeCoverage (const Matrix &transform) const
| Whether the entity should be treated as non-opaque due to stroke geometry requiring alpha for coverage. More...
template<typename VertexShaderT >
bool | DrawGeometry (const ContentContext &renderer, const Entity &entity, RenderPass &pass, const PipelineBuilderCallback &pipeline_callback, typename VertexShaderT::FrameInfo frame_info, const BindFragmentCallback &bind_fragment_callback, bool force_stencil=false, const CreateGeometryCallback &create_geom_callback=DefaultCreateGeometryCallback) const
Static Protected Member Functions inherited from impeller::ColorSourceContents
static GeometryResult | DefaultCreateGeometryCallback (const ContentContext &renderer, const Entity &entity, RenderPass &pass, const Geometry *geom)

## Detailed Description

Definition at line 19 of file tiled_texture_contents.h.

## Member Typedef Documentation

## ◆ ColorFilterProc

using impeller::TiledTextureContents::ColorFilterProc = std::function<std::shared_ptr<ColorFilterContents>(FilterInput::Ref)>

Definition at line 25 of file tiled_texture_contents.h.

## Constructor & Destructor Documentation

## ◆ TiledTextureContents()

impeller::TiledTextureContents::TiledTextureContents | ( |  | ) |
| default

## ◆ ~TiledTextureContents()

impeller::TiledTextureContents::~TiledTextureContents | ( |  | ) |
| override default

## Member Function Documentation

## ◆ IsOpaque()

bool impeller::TiledTextureContents::IsOpaque | ( | const Matrix & | transform | ) | const
| override virtual

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.

Parameters

  transform | The current transform matrix of the entity that will render this contents.

Reimplemented from impeller::Contents.

Definition at line 100 of file tiled_texture_contents.cc.

100 {
101 if (GetOpacityFactor() < 1 || x_tile_mode_ == Entity::TileMode::kDecal ||
102 y_tile_mode_ == Entity::TileMode::kDecal) {
103 return false;
104 }
105 if (color_filter_) {
106 return false;
107 }
108 return texture_->IsOpaque() && !AppliesAlphaForStrokeCoverage(transform);
109 }
impeller::ColorSourceContents::GetOpacityFactor
Scalar GetOpacityFactor() const
Get the opacity factor for this color source.
Definition: color_source_contents.cc:28
impeller::ColorSourceContents::AppliesAlphaForStrokeCoverage
bool AppliesAlphaForStrokeCoverage(const Matrix &transform) const
Whether the entity should be treated as non-opaque due to stroke geometry requiring alpha for coverag...
Definition: color_source_contents.cc:53
impeller::Entity::TileMode::kDecal
@ kDecal
transform
Matrix transform
Definition: gaussian_blur_filter_contents.cc:214

References impeller::ColorSourceContents::AppliesAlphaForStrokeCoverage(), impeller::ColorSourceContents::GetOpacityFactor(), impeller::Entity::kDecal, and transform.

Referenced by impeller::testing::TEST_P().

## ◆ Render()

bool impeller::TiledTextureContents::Render | ( | const ContentContext & | renderer,
|  | const Entity & | entity,
|  | RenderPass & | pass
| ) |  | const
| override virtual

Implements impeller::Contents.

Definition at line 111 of file tiled_texture_contents.cc.

113 {
114 if (texture_ == nullptr) {
115 return true;
116 }
117
118 using VS = TextureUvFillVertexShader;
119 using FS = TiledTextureFillFragmentShader;
120
121 const auto texture_size = texture_->GetSize();
122 if (texture_size.IsEmpty()) {
123 return true;
124 }
125
126 VS::FrameInfo frame_info;
127 frame_info.texture_sampler_y_coord_scale = texture_->GetYCoordScale();
128 frame_info.uv_transform =
129 Rect::MakeSize(texture_size).GetNormalizingTransform() *
130 GetInverseEffectTransform();
131
132 #ifdef IMPELLER_ENABLE_OPENGLES
133 using FSExternal = TiledTextureFillExternalFragmentShader;
134 if (texture_->GetTextureDescriptor().type ==
135 TextureType::kTextureExternalOES) {
136 return ColorSourceContents::DrawGeometry<VS>(
137 renderer, entity, pass,
138 [&renderer](ContentContextOptions options) {
139 return renderer.GetTiledTextureUvExternalPipeline(options);
140 },
141 frame_info,
142 [this, &renderer](RenderPass& pass) {
143 auto& data_host_buffer = renderer.GetTransientsDataBuffer();
144 #ifdef IMPELLER_DEBUG
145 pass.SetCommandLabel("TextureFill External");
146 #endif // IMPELLER_DEBUG
147
148 FML_DCHECK(!color_filter_);
149 FSExternal::FragInfo frag_info;
150 frag_info.x_tile_mode =
151 static_cast<Scalar>(sampler_descriptor_.width_address_mode);
152 frag_info.y_tile_mode =
153 static_cast<Scalar>(sampler_descriptor_.height_address_mode);
154 frag_info.alpha = GetOpacityFactor();
155 FSExternal::BindFragInfo(pass,
156 data_host_buffer.EmplaceUniform(frag_info));
157
158 SamplerDescriptor sampler_desc;
159 // OES_EGL_image_external states that only CLAMP_TO_EDGE is valid,
160 // so we emulate all other tile modes here by remapping the texture
161 // coordinates.
162 sampler_desc.width_address_mode = SamplerAddressMode::kClampToEdge;
163 sampler_desc.height_address_mode = SamplerAddressMode::kClampToEdge;
164 sampler_desc.min_filter = sampler_descriptor_.min_filter;
165 sampler_desc.mag_filter = sampler_descriptor_.mag_filter;
166 sampler_desc.mip_filter = MipFilter::kBase;
167
168 FSExternal::BindSAMPLEREXTERNALOESTextureSampler(
169 pass, texture_,
170 renderer.GetContext()->GetSamplerLibrary()->GetSampler(
171 sampler_desc));
172 return true;
173 });
174 }
175 #endif // IMPELLER_ENABLE_OPENGLES
176
177 PipelineBuilderCallback pipeline_callback =
178 [&renderer](ContentContextOptions options) {
179 return renderer.GetTiledTexturePipeline(options);
180 };
181 return ColorSourceContents::DrawGeometry<VS>(
182 renderer, entity, pass, pipeline_callback, frame_info,
183 [this, &renderer, &entity](RenderPass& pass) {
184 auto& data_host_buffer = renderer.GetTransientsDataBuffer();
185 #ifdef IMPELLER_DEBUG
186 pass.SetCommandLabel("TextureFill");
187 #endif // IMPELLER_DEBUG
188
189 FS::FragInfo frag_info;
190 frag_info.x_tile_mode = static_cast<Scalar>(x_tile_mode_);
191 frag_info.y_tile_mode = static_cast<Scalar>(y_tile_mode_);
192 frag_info.alpha =
193 GetOpacityFactor() *
194 GetGeometry()->ComputeAlphaCoverage(entity.GetTransform());
195 FS::BindFragInfo(pass, data_host_buffer.EmplaceUniform(frag_info));
196
197 if (color_filter_) {
198 auto filtered_texture = CreateFilterTexture(renderer);
199 if (!filtered_texture) {
200 return false;
201 }
202 FS::BindTextureSampler(
203 pass, filtered_texture,
204 renderer.GetContext()->GetSamplerLibrary()->GetSampler(
205 CreateSamplerDescriptor(renderer.GetDeviceCapabilities())));
206 } else {
207 FS::BindTextureSampler(
208 pass, texture_,
209 renderer.GetContext()->GetSamplerLibrary()->GetSampler(
210 CreateSamplerDescriptor(renderer.GetDeviceCapabilities())));
211 }
212
213 return true;
214 });
215 }
impeller::ColorSourceContents::GetGeometry
const Geometry * GetGeometry() const
Get the geometry that this contents will use to render.
Definition: color_source_contents.cc:20
impeller::ColorSourceContents::GetInverseEffectTransform
const Matrix & GetInverseEffectTransform() const
Set the inverted effect transform for this color source.
Definition: color_source_contents.cc:36
impeller::ColorSourceContents::PipelineBuilderCallback
std::function< PipelineRef(ContentContextOptions)> PipelineBuilderCallback
Definition: color_source_contents.h:42
impeller::Geometry::ComputeAlphaCoverage
virtual Scalar ComputeAlphaCoverage(const Matrix &transform) const
Definition: geometry.h:125
impeller::Scalar
float Scalar
Definition: scalar.h:19
impeller::SamplerAddressMode::kClampToEdge
@ kClampToEdge
impeller::FS
LinePipeline::FragmentShader FS
Definition: line_contents.cc:14
impeller::MipFilter::kBase
@ kBase
The texture is sampled as if it only had a single mipmap level.
impeller::TextureType::kTextureExternalOES
@ kTextureExternalOES
impeller::VS
LinePipeline::VertexShader VS
Definition: line_contents.cc:13
impeller::SamplerDescriptor::width_address_mode
SamplerAddressMode width_address_mode
Definition: sampler_descriptor.h:19
impeller::SamplerDescriptor::height_address_mode
SamplerAddressMode height_address_mode
Definition: sampler_descriptor.h:20
impeller::SamplerDescriptor::mag_filter
MinMagFilter mag_filter
Definition: sampler_descriptor.h:16
impeller::SamplerDescriptor::min_filter
MinMagFilter min_filter
Definition: sampler_descriptor.h:15
impeller::TRect::GetNormalizingTransform
constexpr Matrix GetNormalizingTransform() const
Constructs a Matrix that will map all points in the coordinate space of the rectangle into a new norm...
Definition: rect.h:491
impeller::TRect< Scalar >::MakeSize
constexpr static TRect MakeSize(const TSize< U > &size)
Definition: rect.h:150

References impeller::Geometry::ComputeAlphaCoverage(), impeller::ContentContext::GetContext(), impeller::ContentContext::GetDeviceCapabilities(), impeller::ColorSourceContents::GetGeometry(), impeller::ColorSourceContents::GetInverseEffectTransform(), impeller::TRect< T >::GetNormalizingTransform(), impeller::ColorSourceContents::GetOpacityFactor(), impeller::ContentContext::GetTiledTexturePipeline(), impeller::Entity::GetTransform(), impeller::ContentContext::GetTransientsDataBuffer(), impeller::SamplerDescriptor::height_address_mode, impeller::kBase, impeller::kClampToEdge, impeller::kTextureExternalOES, impeller::SamplerDescriptor::mag_filter, impeller::TRect< Scalar >::MakeSize(), impeller::SamplerDescriptor::min_filter, impeller::SamplerDescriptor::mip_filter, impeller::RenderPass::SetCommandLabel(), and impeller::SamplerDescriptor::width_address_mode.

Referenced by impeller::testing::TEST_P().

## ◆ RenderToSnapshot()

std::optional< Snapshot > impeller::TiledTextureContents::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`,
|  | std::string_view | label = `"Tiled Texture Snapshot"`
| ) |  | const
| override virtual

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)`.

Reimplemented from impeller::Contents.

Definition at line 217 of file tiled_texture_contents.cc.

224 {
225 std::optional<Rect> geometry_coverage = GetGeometry()->GetCoverage({});
226 if (GetInverseEffectTransform().IsIdentity() &&
227 GetGeometry()->IsAxisAlignedRect() &&
228 (!geometry_coverage.has_value() ||
229 Rect::MakeSize(texture_->GetSize())
230 .Contains(geometry_coverage.value()))) {
231 auto coverage = GetCoverage(entity);
232 if (!coverage.has_value()) {
233 return std::nullopt;
234 }
235 auto scale = Vector2(coverage->GetSize() / Size(texture_->GetSize()));
236
237 return Snapshot{
238 .texture = texture_,
239 .transform = Matrix::MakeTranslation(coverage->GetOrigin()) *
240 Matrix::MakeScale(scale),
241 .sampler_descriptor = sampler_descriptor.value_or(sampler_descriptor_),
242 .opacity = GetOpacityFactor(),
243 };
244 }
245
246 return Contents::RenderToSnapshot(
247 renderer, // renderer
248 entity, // entity
249 std::nullopt, // coverage_limit
250 sampler_descriptor.value_or(sampler_descriptor_), // sampler_descriptor
251 true, // msaa_enabled
252 /*mip_count=*/1,
253 label); // label
254 }
impeller::ColorSourceContents::GetCoverage
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.
Definition: color_source_contents.cc:44
impeller::Contents::RenderToSnapshot
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, std::string_view label="Snapshot") const
Render this contents to a snapshot, respecting the entity's transform, path, clip depth,...
Definition: contents.cc:56
impeller::Geometry::GetCoverage
virtual std::optional< Rect > GetCoverage(const Matrix &transform) const =0
impeller::Vector2
Point Vector2
Definition: point.h:331
impeller::Size
TSize< Scalar > Size
Definition: size.h:159
impeller::Matrix::MakeTranslation
static constexpr Matrix MakeTranslation(const Vector3 &t)
Definition: matrix.h:95
impeller::Matrix::MakeScale
static constexpr Matrix MakeScale(const Vector3 &s)
Definition: matrix.h:104
impeller::TRect::Contains
constexpr bool Contains(const TPoint< Type > &p) const
Returns true iff the provided point |p| is inside the half-open interior of this rectangle.
Definition: rect.h:231

References impeller::TRect< T >::Contains(), impeller::ColorSourceContents::GetCoverage(), impeller::Geometry::GetCoverage(), impeller::ColorSourceContents::GetGeometry(), impeller::ColorSourceContents::GetInverseEffectTransform(), impeller::ColorSourceContents::GetOpacityFactor(), impeller::Matrix::MakeScale(), impeller::TRect< Scalar >::MakeSize(), impeller::Matrix::MakeTranslation(), impeller::Contents::RenderToSnapshot(), and impeller::Snapshot::texture.

## ◆ SetColorFilter()

void impeller::TiledTextureContents::SetColorFilter | ( | ColorFilterProc | color_filter | ) |

Set a color filter to apply directly to this tiled texture.

Parameters

  color_filter | When applying a color filter to a tiled texture, we can reduce the size and number of the subpasses required and the shader workload by applying the filter to the untiled image and absorbing the opacity before tiling it into the final location.

This may not be a performance improvement if the image is tiled into a much smaller size that its original texture size.

Definition at line 55 of file tiled_texture_contents.cc.

55 {
56 color_filter_ = std::move(color_filter);
57 }

## ◆ SetSamplerDescriptor()

void impeller::TiledTextureContents::SetSamplerDescriptor | ( | const SamplerDescriptor & | desc | ) |

Definition at line 51 of file tiled_texture_contents.cc.

51 {
52 sampler_descriptor_ = desc;
53 }

## ◆ SetTexture()

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

Definition at line 41 of file tiled_texture_contents.cc.

41 {
42 texture_ = std::move(texture);
43 }

Referenced by impeller::testing::TEST_P().

## ◆ SetTileModes()

void impeller::TiledTextureContents::SetTileModes | ( | Entity::TileMode | x_tile_mode,
|  | Entity::TileMode | y_tile_mode
| ) |  |

Definition at line 45 of file tiled_texture_contents.cc.

46 {
47 x_tile_mode_ = x_tile_mode;
48 y_tile_mode_ = y_tile_mode;
49 }

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

- impeller/entity/contents/tiled_texture_contents.h
- impeller/entity/contents/tiled_texture_contents.cc