| Flutter Impeller |

tiled_texture_contents.cc
Go to the documentation of this file.
1 // Copyright 2013 The Flutter Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #include "impeller/entity/contents/tiled_texture_contents.h"
6
7 #include "fml/logging.h"
8 #include "impeller/entity/contents/content_context.h"
9 #include "impeller/entity/tiled_texture_fill.frag.h"
10 #include "impeller/entity/tiled_texture_fill_external.frag.h"
11 #include "impeller/renderer/render_pass.h"
12
13 namespace impeller {
14
15 static std::optional<SamplerAddressMode> TileModeToAddressMode(
16 Entity::TileMode tile_mode,
17 const Capabilities& capabilities) {
18 switch (tile_mode) {
19 case Entity::TileMode::kClamp:
20 return SamplerAddressMode::kClampToEdge;
21 break;
22 case Entity::TileMode::kMirror:
23 return SamplerAddressMode::kMirror;
24 break;
25 case Entity::TileMode::kRepeat:
26 return SamplerAddressMode::kRepeat;
27 break;
28 case Entity::TileMode::kDecal:
29 if (capabilities.SupportsDecalSamplerAddressMode()) {
30 return SamplerAddressMode::kDecal;
31 }
32 return std::nullopt;
33 }
34 }
35
36 TiledTextureContents::TiledTextureContents() = default;
37
38 TiledTextureContents::~TiledTextureContents() = default;
39
40 void TiledTextureContents::SetTexture(std::shared_ptr<Texture> texture) {
41 texture_ = std::move(texture);
42 }
43
44 void TiledTextureContents::SetTileModes(Entity::TileMode x_tile_mode,
45 Entity::TileMode y_tile_mode) {
46 x_tile_mode_ = x_tile_mode;
47 y_tile_mode_ = y_tile_mode;
48 }
49
50 void TiledTextureContents::SetSamplerDescriptor(SamplerDescriptor desc) {
51 sampler_descriptor_ = std::move(desc);
52 }
53
54 void TiledTextureContents::SetColorFilter(ColorFilterProc color_filter) {
55 color_filter_ = std::move(color_filter);
56 }
57
58 std::shared_ptr<Texture> TiledTextureContents::CreateFilterTexture(
59 const ContentContext& renderer) const {
60 if (!color_filter_) {
61 return nullptr;
62 }
63 auto color_filter_contents = color_filter_(FilterInput::Make(texture_));
64 auto snapshot = color_filter_contents->RenderToSnapshot(
65 renderer, // renderer
66 Entity(), // entity
67 std::nullopt, // coverage_limit
68 std::nullopt, // sampler_descriptor
69 true, // msaa_enabled
70 /*mip_count=*/1,
71 "TiledTextureContents Snapshot"); // label
72 if (snapshot.has_value()) {
73 return snapshot.value().texture;
74 }
75 return nullptr;
76 }
77
78 SamplerDescriptor TiledTextureContents::CreateSamplerDescriptor(
79 const Capabilities& capabilities) const {
80 SamplerDescriptor descriptor = sampler_descriptor_;
81 auto width_mode = TileModeToAddressMode(x_tile_mode_, capabilities);
82 auto height_mode = TileModeToAddressMode(y_tile_mode_, capabilities);
83 if (width_mode.has_value()) {
84 descriptor.width_address_mode = width_mode.value();
85 }
86 if (height_mode.has_value()) {
87 descriptor.height_address_mode = height_mode.value();
88 }
89 return descriptor;
90 }
91
92 bool TiledTextureContents::UsesEmulatedTileMode(
93 const Capabilities& capabilities) const {
94 return !TileModeToAddressMode(x_tile_mode_, capabilities).has_value() ||
95 !TileModeToAddressMode(y_tile_mode_, capabilities).has_value();
96 }
97
98 // |Contents|
99 bool TiledTextureContents::IsOpaque() const {
100 if (GetOpacityFactor() < 1 || x_tile_mode_ == Entity::TileMode::kDecal ||
101 y_tile_mode_ == Entity::TileMode::kDecal) {
102 return false;
103 }
104 if (color_filter_) {
105 return false;
106 }
107 return texture_->IsOpaque();
108 }
109
110 bool TiledTextureContents::Render(const ContentContext& renderer,
111 const Entity& entity,
112 RenderPass& pass) const {
113 if (texture_ == nullptr) {
114 return true;
115 }
116
117 using VS = TextureUvFillVertexShader;
118 using FS = TiledTextureFillFragmentShader;
119 using FSExternal = TiledTextureFillExternalFragmentShader;
120
121 const auto texture_size = texture_->GetSize();
122 if (texture_size.IsEmpty()) {
123 return true;
124 }
125
126 bool is_external_texture =
127 texture_->GetTextureDescriptor().type == TextureType::kTextureExternalOES;
128
129 VS::FrameInfo frame_info;
130 frame_info.texture_sampler_y_coord_scale = texture_->GetYCoordScale();
131 frame_info.uv_transform =
132 Rect::MakeSize(texture_size).GetNormalizingTransform() *
133 GetInverseEffectTransform();
134
135 PipelineBuilderMethod pipeline_method;
136
137 #ifdef IMPELLER_ENABLE_OPENGLES
138 if (is_external_texture) {
139 pipeline_method = &ContentContext::GetTiledTextureExternalPipeline;
140 } else {
141 pipeline_method = &ContentContext::GetTiledTexturePipeline;
142 }
143 #else
144 pipeline_method = &ContentContext::GetTiledTexturePipeline;
145 #endif // IMPELLER_ENABLE_OPENGLES
146
147 PipelineBuilderCallback pipeline_callback =
148 [&renderer, &pipeline_method](ContentContextOptions options) {
149 return (renderer.*pipeline_method)(options);
150 };
151 return ColorSourceContents::DrawGeometry<VS>(
152 renderer, entity, pass, pipeline_callback, frame_info,
153 [this, &renderer, &is_external_texture, &entity](RenderPass& pass) {
154 auto& host_buffer = renderer.GetTransientsBuffer();
155
156 pass.SetCommandLabel("TextureFill");
157
158 if (is_external_texture) {
159 FSExternal::FragInfo frag_info;
160 frag_info.x_tile_mode = static_cast<Scalar>(x_tile_mode_);
161 frag_info.y_tile_mode = static_cast<Scalar>(y_tile_mode_);
162 frag_info.alpha =
163 GetOpacityFactor() * GetGeometry()->ComputeAlphaCoverage(entity);
164 FSExternal::BindFragInfo(pass, host_buffer.EmplaceUniform(frag_info));
165 } else {
166 FS::FragInfo frag_info;
167 frag_info.x_tile_mode = static_cast<Scalar>(x_tile_mode_);
168 frag_info.y_tile_mode = static_cast<Scalar>(y_tile_mode_);
169 frag_info.alpha =
170 GetOpacityFactor() * GetGeometry()->ComputeAlphaCoverage(entity);
171 FS::BindFragInfo(pass, host_buffer.EmplaceUniform(frag_info));
172 }
173
174 if (is_external_texture) {
175 SamplerDescriptor sampler_desc;
176 // OES_EGL_image_external states that only CLAMP_TO_EDGE is valid, so
177 // we emulate all other tile modes here by remapping the texture
178 // coordinates.
179 sampler_desc.width_address_mode = SamplerAddressMode::kClampToEdge;
180 sampler_desc.height_address_mode = SamplerAddressMode::kClampToEdge;
181
182 // Also, external textures cannot be bound to color filters, so ignore
183 // this case for now.
184 FML_DCHECK(!color_filter_) << "Color filters are not currently "
185 "supported for external textures.";
186
187 FSExternal::BindSAMPLEREXTERNALOESTextureSampler(
188 pass, texture_,
189 renderer.GetContext()->GetSamplerLibrary()->GetSampler(
190 sampler_desc));
191 } else {
192 if (color_filter_) {
193 auto filtered_texture = CreateFilterTexture(renderer);
194 if (!filtered_texture) {
195 return false;
196 }
197 FS::BindTextureSampler(
198 pass, filtered_texture,
199 renderer.GetContext()->GetSamplerLibrary()->GetSampler(
200 CreateSamplerDescriptor(renderer.GetDeviceCapabilities())));
201 } else {
202 FS::BindTextureSampler(
203 pass, texture_,
204 renderer.GetContext()->GetSamplerLibrary()->GetSampler(
205 CreateSamplerDescriptor(renderer.GetDeviceCapabilities())));
206 }
207 }
208
209 return true;
210 });
211 }
212
213 std::optional<Snapshot> TiledTextureContents::RenderToSnapshot(
214 const ContentContext& renderer,
215 const Entity& entity,
216 std::optional<Rect> coverage_limit,
217 const std::optional<SamplerDescriptor>& sampler_descriptor,
218 bool msaa_enabled,
219 int32_t mip_count,
220 const std::string& label) const {
221 std::optional<Rect> geometry_coverage = GetGeometry()->GetCoverage({});
222 if (GetInverseEffectTransform().IsIdentity() &&
223 GetGeometry()->IsAxisAlignedRect() &&
224 (!geometry_coverage.has_value() ||
225 Rect::MakeSize(texture_->GetSize())
226 .Contains(geometry_coverage.value()))) {
227 auto coverage = GetCoverage(entity);
228 if (!coverage.has_value()) {
229 return std::nullopt;
230 }
231 auto scale = Vector2(coverage->GetSize() / Size(texture_->GetSize()));
232
233 return Snapshot{
234 .texture = texture_,
235 .transform = Matrix::MakeTranslation(coverage->GetOrigin()) *
236 Matrix::MakeScale(scale),
237 .sampler_descriptor = sampler_descriptor.value_or(sampler_descriptor_),
238 .opacity = GetOpacityFactor(),
239 };
240 }
241
242 return Contents::RenderToSnapshot(
243 renderer, // renderer
244 entity, // entity
245 std::nullopt, // coverage_limit
246 sampler_descriptor.value_or(sampler_descriptor_), // sampler_descriptor
247 true, // msaa_enabled
248 /*mip_count=*/1,
249 label); // label
250 }
251
252 } // namespace impeller
impeller::TextureType::kTextureExternalOES
@ kTextureExternalOES
impeller::ColorSourceContents::PipelineBuilderCallback
std::function< std::shared_ptr< Pipeline< PipelineDescriptor > >(ContentContextOptions)> PipelineBuilderCallback
Definition: color_source_contents.h:114
impeller::TiledTextureContents::IsOpaque
bool IsOpaque() const override
Whether this Contents only emits opaque source colors from the fragment stage. This value does not ac...
Definition: tiled_texture_contents.cc:99
impeller::Entity::TileMode::kClamp
@ kClamp
impeller::ColorSourceContents::GetOpacityFactor
Scalar GetOpacityFactor() const
Get the opacity factor for this color source.
Definition: color_source_contents.cc:28
impeller::Scalar
float Scalar
Definition: scalar.h:18
impeller::TiledTextureContents::TiledTextureContents
TiledTextureContents()
impeller::FilterInput::Make
static FilterInput::Ref Make(Variant input, bool msaa_enabled=true)
Definition: filter_input.cc:19
impeller::Entity::TileMode::kDecal
@ kDecal
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, const std::string &label="Snapshot") const
Render this contents to a snapshot, respecting the entity's transform, path, clip depth,...
Definition: contents.cc:63
tiled_texture_contents.h
impeller::Vector2
Point Vector2
Definition: point.h:326
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:482
impeller::ColorSourceContents::GetGeometry
const std::shared_ptr< Geometry > & GetGeometry() const
Get the geometry that this contents will use to render.
Definition: color_source_contents.cc:20
impeller::TiledTextureContents::SetSamplerDescriptor
void SetSamplerDescriptor(SamplerDescriptor desc)
Definition: tiled_texture_contents.cc:50
impeller::ContentContext::GetTiledTexturePipeline
std::shared_ptr< Pipeline< PipelineDescriptor > > GetTiledTexturePipeline(ContentContextOptions opts) const
Definition: content_context.h:461
impeller::SamplerAddressMode::kClampToEdge
@ kClampToEdge
impeller::Entity::TileMode::kRepeat
@ kRepeat
impeller::Matrix::MakeTranslation
static constexpr Matrix MakeTranslation(const Vector3 &t)
Definition: matrix.h:95
impeller::RenderPass::SetCommandLabel
virtual void SetCommandLabel(std::string_view label)
The debugging label to use for the command.
Definition: render_pass.cc:97
impeller::Entity::TileMode::kMirror
@ kMirror
impeller::VS
SolidFillVertexShader VS
Definition: stroke_path_geometry.cc:16
impeller::SamplerDescriptor
Definition: sampler_descriptor.h:15
impeller::Entity
Definition: entity.h:20
impeller::Capabilities
Definition: capabilities.h:14
impeller::TSize< Scalar >
render_pass.h
impeller::ContentContext::GetContext
std::shared_ptr< Context > GetContext() const
Definition: content_context.cc:553
impeller::Contents::ColorFilterProc
std::function< Color(Color)> ColorFilterProc
Definition: contents.h:35
impeller::Snapshot
Represents a texture and its intended draw transform/sampler configuration.
Definition: snapshot.h:24
impeller::SamplerDescriptor::width_address_mode
SamplerAddressMode width_address_mode
Definition: sampler_descriptor.h:20
impeller::Entity::TileMode
TileMode
Definition: entity.h:42
impeller::TiledTextureContents::SetColorFilter
void SetColorFilter(ColorFilterProc color_filter)
Set a color filter to apply directly to this tiled texture.
Definition: tiled_texture_contents.cc:54
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:221
impeller::RenderPass
Render passes encode render commands directed as one specific render target into an underlying comman...
Definition: render_pass.h:33
impeller::ColorSourceContents::PipelineBuilderMethod
std::shared_ptr< Pipeline< PipelineDescriptor > >(impeller::ContentContext::*)(ContentContextOptions) const PipelineBuilderMethod
Definition: color_source_contents.h:111
content_context.h
impeller::ContentContext::GetDeviceCapabilities
const Capabilities & GetDeviceCapabilities() const
Definition: content_context.cc:557
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::SamplerAddressMode::kMirror
@ kMirror
impeller::TRect< Scalar >::MakeSize
constexpr static TRect MakeSize(const TSize< U > &size)
Definition: rect.h:146
scale
const Scalar scale
Definition: stroke_path_geometry.cc:308
impeller::TiledTextureContents::RenderToSnapshot
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="Tiled Texture Snapshot") const override
Render this contents to a snapshot, respecting the entity's transform, path, clip depth,...
Definition: tiled_texture_contents.cc:213
impeller::TiledTextureContents::Render
bool Render(const ContentContext &renderer, const Entity &entity, RenderPass &pass) const override
Definition: tiled_texture_contents.cc:110
impeller::TiledTextureContents::SetTileModes
void SetTileModes(Entity::TileMode x_tile_mode, Entity::TileMode y_tile_mode)
Definition: tiled_texture_contents.cc:44
impeller::TiledTextureContents::~TiledTextureContents
~TiledTextureContents() override
impeller::TileModeToAddressMode
static std::optional< SamplerAddressMode > TileModeToAddressMode(Entity::TileMode tile_mode, const Capabilities &capabilities)
Definition: tiled_texture_contents.cc:15
impeller::Snapshot::texture
std::shared_ptr< Texture > texture
Definition: snapshot.h:25
impeller::Capabilities::SupportsDecalSamplerAddressMode
virtual bool SupportsDecalSamplerAddressMode() const =0
Whether the context backend supports SamplerAddressMode::Decal.
impeller::ContentContextOptions
Definition: content_context.h:254
impeller::SamplerDescriptor::height_address_mode
SamplerAddressMode height_address_mode
Definition: sampler_descriptor.h:21
impeller
Definition: aiks_blend_unittests.cc:18
impeller::Matrix::MakeScale
static constexpr Matrix MakeScale(const Vector3 &s)
Definition: matrix.h:104
impeller::ContentContext
Definition: content_context.h:366
impeller::ColorSourceContents::GetInverseEffectTransform
const Matrix & GetInverseEffectTransform() const
Set the inverted effect transform for this color source.
Definition: color_source_contents.cc:36
impeller::ContentContext::GetTransientsBuffer
HostBuffer & GetTransientsBuffer() const
Retrieve the currnent host buffer for transient storage.
Definition: content_context.h:752
impeller::TiledTextureContents::SetTexture
void SetTexture(std::shared_ptr< Texture > texture)
Definition: tiled_texture_contents.cc:40
impeller::SamplerAddressMode::kRepeat
@ kRepeat
impeller::SamplerAddressMode::kDecal
@ kDecal
decal sampling mode is only supported on devices that pass the Capabilities.SupportsDecalSamplerAddre...