Flutter Impeller
radial_gradient_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 
6 
10 #include "impeller/entity/entity.h"
14 
15 namespace impeller {
16 
18  : geometry_(geometry) {}
19 
21 
23  return geometry_;
24 }
25 
27  center_ = center;
28  radius_ = radius;
29 }
30 
32  tile_mode_ = tile_mode;
33 }
34 
35 void RadialGradientContents::SetColors(std::vector<Color> colors) {
36  colors_ = std::move(colors);
37 }
38 
39 void RadialGradientContents::SetStops(std::vector<Scalar> stops) {
40  stops_ = std::move(stops);
41 }
42 
43 const std::vector<Color>& RadialGradientContents::GetColors() const {
44  return colors_;
45 }
46 
47 const std::vector<Scalar>& RadialGradientContents::GetStops() const {
48  return stops_;
49 }
50 
52  if (GetOpacityFactor() < 1 || tile_mode_ == Entity::TileMode::kDecal) {
53  return false;
54  }
55  for (auto color : colors_) {
56  if (!color.IsOpaque()) {
57  return false;
58  }
59  }
61 }
62 
63 #define ARRAY_LEN(a) (sizeof(a) / sizeof(a[0]))
64 #define UNIFORM_FRAG_INFO(t) \
65  t##GradientUniformFillPipeline::FragmentShader::FragInfo
66 #define UNIFORM_COLOR_SIZE ARRAY_LEN(UNIFORM_FRAG_INFO(Radial)::colors)
67 #define UNIFORM_STOP_SIZE ARRAY_LEN(UNIFORM_FRAG_INFO(Radial)::stop_pairs)
69 static_assert(UNIFORM_STOP_SIZE == kMaxUniformGradientStops / 2);
70 
72  const Entity& entity,
73  RenderPass& pass) const {
74  if (renderer.GetDeviceCapabilities().SupportsSSBO()) {
75  return RenderSSBO(renderer, entity, pass);
76  }
77  if (colors_.size() <= kMaxUniformGradientStops &&
78  stops_.size() <= kMaxUniformGradientStops) {
79  return RenderUniform(renderer, entity, pass);
80  }
81  return RenderTexture(renderer, entity, pass);
82 }
83 
84 bool RadialGradientContents::RenderSSBO(const ContentContext& renderer,
85  const Entity& entity,
86  RenderPass& pass) const {
89 
90  VS::FrameInfo frame_info;
91  frame_info.matrix = GetInverseEffectTransform();
92 
93  PipelineBuilderCallback pipeline_callback =
94  [&renderer](ContentContextOptions options) {
95  return renderer.GetRadialGradientSSBOFillPipeline(options);
96  };
97  return ColorSourceContents::DrawGeometry<VS>(
98  renderer, entity, pass, pipeline_callback, frame_info,
99  [this, &renderer, &entity](RenderPass& pass) {
100  FS::FragInfo frag_info;
101  frag_info.center = center_;
102  frag_info.radius = radius_;
103  frag_info.tile_mode = static_cast<Scalar>(tile_mode_);
104  frag_info.decal_border_color = decal_border_color_;
105  frag_info.alpha =
106  GetOpacityFactor() *
108 
109  auto& data_host_buffer = renderer.GetTransientsDataBuffer();
110  auto colors = CreateGradientColors(colors_, stops_);
111 
112  frag_info.colors_length = colors.size();
113  auto color_buffer = data_host_buffer.Emplace(
114  colors.data(), colors.size() * sizeof(StopData),
115  renderer.GetDeviceCapabilities()
117 
118  pass.SetCommandLabel("RadialGradientSSBOFill");
119  FS::BindFragInfo(pass, data_host_buffer.EmplaceUniform(frag_info));
120  FS::BindColorData(pass, color_buffer);
121 
122  return true;
123  });
124 }
125 
126 bool RadialGradientContents::RenderUniform(const ContentContext& renderer,
127  const Entity& entity,
128  RenderPass& pass) const {
131 
132  VS::FrameInfo frame_info;
133  frame_info.matrix = GetInverseEffectTransform();
134 
135  PipelineBuilderCallback pipeline_callback =
136  [&renderer](ContentContextOptions options) {
137  return renderer.GetRadialGradientUniformFillPipeline(options);
138  };
139  return ColorSourceContents::DrawGeometry<VS>(
140  renderer, entity, pass, pipeline_callback, frame_info,
141  [this, &renderer, &entity](RenderPass& pass) {
142  FS::FragInfo frag_info;
143  frag_info.center = center_;
144  frag_info.radius = radius_;
145  frag_info.tile_mode = static_cast<Scalar>(tile_mode_);
146  frag_info.alpha =
147  GetOpacityFactor() *
148  GetGeometry()->ComputeAlphaCoverage(entity.GetTransform());
149  frag_info.colors_length = PopulateUniformGradientColors(
150  colors_, stops_, frag_info.colors, frag_info.stop_pairs);
151  frag_info.decal_border_color = decal_border_color_;
152 
153  pass.SetCommandLabel("RadialGradientUniformFill");
154 
155  FS::BindFragInfo(
156  pass, renderer.GetTransientsDataBuffer().EmplaceUniform(frag_info));
157 
158  return true;
159  });
160 }
161 
162 bool RadialGradientContents::RenderTexture(const ContentContext& renderer,
163  const Entity& entity,
164  RenderPass& pass) const {
167 
168  auto gradient_data = CreateGradientBuffer(colors_, stops_);
169  auto gradient_texture =
170  CreateGradientTexture(gradient_data, renderer.GetContext());
171  if (gradient_texture == nullptr) {
172  return false;
173  }
174 
175  VS::FrameInfo frame_info;
176  frame_info.matrix = GetInverseEffectTransform();
177 
178  PipelineBuilderCallback pipeline_callback =
179  [&renderer](ContentContextOptions options) {
180  return renderer.GetRadialGradientFillPipeline(options);
181  };
182  return ColorSourceContents::DrawGeometry<VS>(
183  renderer, entity, pass, pipeline_callback, frame_info,
184  [this, &renderer, &gradient_texture, &entity](RenderPass& pass) {
185  FS::FragInfo frag_info;
186  frag_info.center = center_;
187  frag_info.radius = radius_;
188  frag_info.tile_mode = static_cast<Scalar>(tile_mode_);
189  frag_info.decal_border_color = decal_border_color_;
190  frag_info.texture_sampler_y_coord_scale =
191  gradient_texture->GetYCoordScale();
192  frag_info.alpha =
193  GetOpacityFactor() *
194  GetGeometry()->ComputeAlphaCoverage(entity.GetTransform());
195  frag_info.half_texel =
196  Vector2(0.5 / gradient_texture->GetSize().width,
197  0.5 / gradient_texture->GetSize().height);
198 
199  SamplerDescriptor sampler_desc;
200  sampler_desc.min_filter = MinMagFilter::kLinear;
201  sampler_desc.mag_filter = MinMagFilter::kLinear;
202 
203  pass.SetCommandLabel("RadialGradientFill");
204 
205  FS::BindFragInfo(
206  pass, renderer.GetTransientsDataBuffer().EmplaceUniform(frag_info));
207  FS::BindTextureSampler(
208  pass, gradient_texture,
209  renderer.GetContext()->GetSamplerLibrary()->GetSampler(
210  sampler_desc));
211 
212  return true;
213  });
214 }
215 
217  const ColorFilterProc& color_filter_proc) {
218  for (Color& color : colors_) {
219  color = color_filter_proc(color);
220  }
221  decal_border_color_ = color_filter_proc(decal_border_color_);
222  return true;
223 }
224 
225 } // namespace impeller
virtual size_t GetMinimumStorageBufferAlignment() const
The minimum alignment of storage buffer value offsets in bytes.
Definition: capabilities.cc:14
virtual bool SupportsSSBO() const =0
Whether the context backend supports binding Shader Storage Buffer Objects (SSBOs) to pipelines.
Scalar GetOpacityFactor() const
Get the opacity factor for this color source.
bool AppliesAlphaForStrokeCoverage(const Matrix &transform) const
Whether the entity should be treated as non-opaque due to stroke geometry requiring alpha for coverag...
const Matrix & GetInverseEffectTransform() const
Set the inverted effect transform for this color source.
std::function< PipelineRef(ContentContextOptions)> PipelineBuilderCallback
const Capabilities & GetDeviceCapabilities() const
PipelineRef GetRadialGradientSSBOFillPipeline(ContentContextOptions opts) const
HostBuffer & GetTransientsDataBuffer() const
Retrieve the current host buffer for transient storage of other non-index data.
std::function< Color(Color)> ColorFilterProc
Definition: contents.h:35
const Matrix & GetTransform() const
Get the global transform matrix for this Entity.
Definition: entity.cc:46
virtual Scalar ComputeAlphaCoverage(const Matrix &transform) const
Definition: geometry.h:125
bool IsOpaque(const Matrix &transform) const override
Whether this Contents only emits opaque source colors from the fragment stage. This value does not ac...
void SetTileMode(Entity::TileMode tile_mode)
bool Render(const ContentContext &renderer, const Entity &entity, RenderPass &pass) const override
void SetCenterAndRadius(Point center, Scalar radius)
const Geometry * GetGeometry() const override
Get the geometry that this contents will use to render.
RadialGradientContents(const Geometry *geometry)
void SetStops(std::vector< Scalar > stops)
bool ApplyColorFilter(const ColorFilterProc &color_filter_proc) override
If possible, applies a color filter to this contents inputs on the CPU.
void SetColors(std::vector< Color > colors)
const std::vector< Scalar > & GetStops() const
const std::vector< Color > & GetColors() const
Render passes encode render commands directed as one specific render target into an underlying comman...
Definition: render_pass.h:30
FragmentShader_ FragmentShader
Definition: pipeline.h:169
Point Vector2
Definition: point.h:430
float Scalar
Definition: scalar.h:19
LinePipeline::FragmentShader FS
int PopulateUniformGradientColors(const std::vector< Color > &colors, const std::vector< Scalar > &stops, Vector4 frag_info_colors[kMaxUniformGradientStops], Vector4 frag_info_stop_pairs[kMaxUniformGradientStops/2])
Populate 2 arrays with the colors and stop data for a gradient.
std::vector< StopData > CreateGradientColors(const std::vector< Color > &colors, const std::vector< Scalar > &stops)
Populate a vector with the color and stop data for a gradient.
LinePipeline::VertexShader VS
std::shared_ptr< Texture > CreateGradientTexture(const GradientData &gradient_data, const std::shared_ptr< impeller::Context > &context)
Create a host visible texture that contains the gradient defined by the provided gradient data.
GradientData CreateGradientBuffer(const std::vector< Color > &colors, const std::vector< Scalar > &stops)
Populate a vector with the interpolated color bytes for the linear gradient described by colors and s...
Definition: gradient.cc:20
static constexpr uint32_t kMaxUniformGradientStops
#define UNIFORM_STOP_SIZE
#define UNIFORM_COLOR_SIZE
Scalar alpha
Definition: color.h:143
A 4x4 matrix using column-major storage.
Definition: matrix.h:37