Flutter Engine Uber Docs
Docs for the entire Flutter Engine repo.
 
Loading...
Searching...
No Matches
flutter::FragmentProgram Class Reference

#include <fragment_program.h>

Inheritance diagram for flutter::FragmentProgram:
flutter::RefCountedDartWrappable< FragmentProgram > fml::RefCountedThreadSafe< T > tonic::DartWrappable fml::internal::RefCountedThreadSafeBase

Public Member Functions

 ~FragmentProgram () override
 
std::string initFromAsset (const std::string &asset_name)
 
fml::RefPtr< FragmentShader > shader (Dart_Handle shader, Dart_Handle uniforms_handle, Dart_Handle samplers)
 
std::shared_ptr< DlColorSourceMakeDlColorSource (std::shared_ptr< std::vector< uint8_t > > float_uniforms, const std::vector< std::shared_ptr< DlColorSource > > &children)
 
std::shared_ptr< DlImageFilterMakeDlImageFilter (std::shared_ptr< std::vector< uint8_t > > float_uniforms, const std::vector< std::shared_ptr< DlColorSource > > &children)
 
- Public Member Functions inherited from flutter::RefCountedDartWrappable< FragmentProgram >
virtual void RetainDartWrappableReference () const override
 
virtual void ReleaseDartWrappableReference () const override
 
- Public Member Functions inherited from fml::RefCountedThreadSafe< T >
void Release () const
 
- Public Member Functions inherited from fml::internal::RefCountedThreadSafeBase
void AddRef () const
 
bool HasOneRef () const
 
void AssertHasOneRef () const
 
- Public Member Functions inherited from tonic::DartWrappable
 DartWrappable ()
 
virtual const DartWrapperInfoGetDartWrapperInfo () const =0
 
Dart_Handle CreateDartWrapper (DartState *dart_state)
 
void AssociateWithDartWrapper (Dart_Handle wrappable)
 
void ClearDartWrapper ()
 
Dart_WeakPersistentHandle dart_wrapper () const
 

Static Public Member Functions

static void Create (Dart_Handle wrapper)
 

Additional Inherited Members

- Public Types inherited from tonic::DartWrappable
enum  DartNativeFields {
  kPeerIndex ,
  kNumberOfNativeFields
}
 
- Protected Member Functions inherited from fml::RefCountedThreadSafe< T >
 RefCountedThreadSafe ()
 
 ~RefCountedThreadSafe ()
 
- Protected Member Functions inherited from fml::internal::RefCountedThreadSafeBase
 RefCountedThreadSafeBase ()
 
 ~RefCountedThreadSafeBase ()
 
bool Release () const
 
void Adopt ()
 
- Protected Member Functions inherited from tonic::DartWrappable
virtual ~DartWrappable ()
 
- Static Protected Member Functions inherited from tonic::DartWrappable
static Dart_PersistentHandle GetTypeForWrapper (tonic::DartState *dart_state, const tonic::DartWrapperInfo &wrapper_info)
 

Detailed Description

Definition at line 24 of file fragment_program.h.

Constructor & Destructor Documentation

◆ ~FragmentProgram()

flutter::FragmentProgram::~FragmentProgram ( )
overridedefault

Member Function Documentation

◆ Create()

void flutter::FragmentProgram::Create ( Dart_Handle  wrapper)
static

Definition at line 241 of file fragment_program.cc.

241 {
242 auto res = fml::MakeRefCounted<FragmentProgram>();
243 res->AssociateWithDartWrapper(wrapper);
244}

◆ initFromAsset()

std::string flutter::FragmentProgram::initFromAsset ( const std::string &  asset_name)

Definition at line 100 of file fragment_program.cc.

100 {
101 FML_TRACE_EVENT("flutter", "FragmentProgram::initFromAsset", "asset",
102 asset_name);
103 UIDartState* ui_dart_state = UIDartState::Current();
104 std::shared_ptr<AssetManager> asset_manager =
105 ui_dart_state->platform_configuration()->client()->GetAssetManager();
106
107 std::unique_ptr<fml::Mapping> data = asset_manager->GetAsMapping(asset_name);
108 if (data == nullptr) {
109 return std::string("Asset '") + asset_name + std::string("' not found");
110 }
111
112 auto runtime_stages =
114
115 if (!runtime_stages.ok()) {
116 return std::string("Asset '") + asset_name +
117 std::string("' manifest could not be decoded: ") +
118 runtime_stages.status().ToString();
119 }
120
121 if (runtime_stages->empty()) {
122 return std::string("Asset '") + asset_name +
123 std::string("' does not contain any shader data.");
124 }
125
127 ui_dart_state->GetRuntimeStageBackend();
128 std::shared_ptr<impeller::RuntimeStage> runtime_stage =
129 (*runtime_stages)[backend];
130 if (!runtime_stage) {
131 std::ostringstream stream;
132 stream << "Asset '" << asset_name
133 << "' does not contain appropriate runtime stage data for current "
134 "backend ("
135 << RuntimeStageBackendToString(backend) << ")." << std::endl
136 << "Found stages: ";
137 for (const auto& kvp : *runtime_stages) {
138 if (kvp.second) {
139 stream << RuntimeStageBackendToString(kvp.first) << " ";
140 }
141 }
142 return stream.str();
143 }
144
145 int sampled_image_count = 0;
146 size_t other_uniforms_bytes = 0;
147 const std::vector<impeller::RuntimeUniformDescription>& uniforms =
148 runtime_stage->GetUniforms();
149 Dart_Handle uniform_info = Dart_NewList(uniforms.size());
150 FML_DCHECK(!Dart_IsError(uniform_info));
151 for (size_t i = 0; i < uniforms.size(); ++i) {
152 const impeller::RuntimeUniformDescription& uniform_description =
153 uniforms[i];
154
155 Dart_Handle map = ConvertUniformDescriptionToMap(uniform_description);
156 [[maybe_unused]] Dart_Handle dart_result =
157 Dart_ListSetAt(uniform_info, i, map);
158 FML_DCHECK(!Dart_IsError(dart_result));
159
160 if (uniform_description.type ==
162 sampled_image_count++;
163 } else {
164 other_uniforms_bytes += uniform_description.GetSize();
165 }
166 }
167
168 if (UIDartState::Current()->IsImpellerEnabled()) {
169 // Spawn (but do not block on) a task that will load the runtime stage and
170 // populate an initial shader variant.
171 auto snapshot_controller = UIDartState::Current()->GetSnapshotDelegate();
172 ui_dart_state->GetTaskRunners().GetRasterTaskRunner()->PostTask(
173 [runtime_stage, snapshot_controller]() {
174 if (!snapshot_controller) {
175 return;
176 }
177 snapshot_controller->CacheRuntimeStage(runtime_stage);
178 });
179#if IMPELLER_SUPPORTS_RENDERING
180 runtime_effect_ = DlRuntimeEffectImpeller::Make(std::move(runtime_stage));
181#endif
182 } else {
183 const auto& code_mapping = runtime_stage->GetCodeMapping();
184 auto code_size = code_mapping->GetSize();
185 const char* sksl =
186 reinterpret_cast<const char*>(code_mapping->GetMapping());
187 // SkString makes a copy.
188 SkRuntimeEffect::Result result =
189 SkRuntimeEffect::MakeForShader(SkString(sksl, code_size));
190 if (result.effect == nullptr) {
191 return std::string("Invalid SkSL:\n") + sksl +
192 std::string("\nSkSL Error:\n") + result.errorText.c_str();
193 }
194 runtime_effect_ = DlRuntimeEffectSkia::Make(result.effect);
195 }
196
197 Dart_Handle ths = Dart_HandleFromWeakPersistent(dart_wrapper());
198 if (Dart_IsError(ths)) {
199 Dart_PropagateError(ths);
200 }
201
202 Dart_Handle result = Dart_SetField(ths, tonic::ToDart("_samplerCount"),
203 Dart_NewInteger(sampled_image_count));
204 if (Dart_IsError(result)) {
205 return "Failed to set sampler count for fragment program.";
206 }
207
208 size_t rounded_uniform_bytes =
209 (other_uniforms_bytes + sizeof(float) - 1) & ~(sizeof(float) - 1);
210 size_t float_count = rounded_uniform_bytes / sizeof(float);
211
212 result = Dart_SetField(ths, tonic::ToDart("_uniformFloatCount"),
213 Dart_NewInteger(float_count));
214 if (Dart_IsError(result)) {
215 return "Failed to set uniform float count for fragment program.";
216 }
217
218 result = Dart_SetField(ths, tonic::ToDart("_uniformInfo"), uniform_info);
219 if (Dart_IsError(result)) {
220 FML_DLOG(ERROR) << Dart_GetError(result);
221 return "Failed to set uniform info for fragment program.";
222 }
223
224 return "";
225}
static sk_sp< DlRuntimeEffect > Make(std::shared_ptr< impeller::RuntimeStage > runtime_stage)
static sk_sp< DlRuntimeEffect > Make(const sk_sp< SkRuntimeEffect > &runtime_effect)
fml::TaskRunnerAffineWeakPtr< SnapshotDelegate > GetSnapshotDelegate() const
static UIDartState * Current()
static absl::StatusOr< Map > DecodeRuntimeStages(const std::shared_ptr< fml::Mapping > &payload)
Dart_WeakPersistentHandle dart_wrapper() const
#define FML_DLOG(severity)
Definition logging.h:121
#define FML_DCHECK(condition)
Definition logging.h:122
DEF_SWITCHES_START aot vmservice shared library Name of the *so containing AOT compiled Dart assets for launching the service isolate vm snapshot data
Definition switch_defs.h:36
static std::string RuntimeStageBackendToString(impeller::RuntimeStageBackend backend)
Dart_Handle ToDart(const T &object)
size_t GetSize() const
Computes the total number of bytes that this uniform requires.
#define FML_TRACE_EVENT(category_group, name,...)

References flutter::PlatformConfiguration::client(), flutter::UIDartState::Current(), tonic::DartWrappable::dart_wrapper(), flutter::data, impeller::RuntimeStage::DecodeRuntimeStages(), FML_DCHECK, FML_DLOG, FML_TRACE_EVENT, flutter::PlatformConfigurationClient::GetAssetManager(), flutter::TaskRunners::GetRasterTaskRunner(), flutter::UIDartState::GetRuntimeStageBackend(), impeller::RuntimeUniformDescription::GetSize(), flutter::UIDartState::GetSnapshotDelegate(), flutter::UIDartState::GetTaskRunners(), i, impeller::kSampledImage, flutter::DlRuntimeEffectSkia::Make(), flutter::DlRuntimeEffectImpeller::Make(), flutter::UIDartState::platform_configuration(), fml::TaskRunner::PostTask(), flutter::RuntimeStageBackendToString(), tonic::ToDart(), and impeller::RuntimeUniformDescription::type.

◆ MakeDlColorSource()

std::shared_ptr< DlColorSource > flutter::FragmentProgram::MakeDlColorSource ( std::shared_ptr< std::vector< uint8_t > >  float_uniforms,
const std::vector< std::shared_ptr< DlColorSource > > &  children 
)

Definition at line 227 of file fragment_program.cc.

229 {
230 return DlColorSource::MakeRuntimeEffect(runtime_effect_, children,
231 std::move(float_uniforms));
232}
static std::shared_ptr< DlColorSource > MakeRuntimeEffect(sk_sp< DlRuntimeEffect > runtime_effect, std::vector< std::shared_ptr< DlColorSource > > samplers, std::shared_ptr< std::vector< uint8_t > > uniform_data)

References flutter::DlColorSource::MakeRuntimeEffect().

◆ MakeDlImageFilter()

std::shared_ptr< DlImageFilter > flutter::FragmentProgram::MakeDlImageFilter ( std::shared_ptr< std::vector< uint8_t > >  float_uniforms,
const std::vector< std::shared_ptr< DlColorSource > > &  children 
)

Definition at line 234 of file fragment_program.cc.

236 {
237 return DlImageFilter::MakeRuntimeEffect(runtime_effect_, children,
238 std::move(float_uniforms));
239}
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)

References flutter::DlImageFilter::MakeRuntimeEffect().

◆ shader()

fml::RefPtr< FragmentShader > flutter::FragmentProgram::shader ( Dart_Handle  shader,
Dart_Handle  uniforms_handle,
Dart_Handle  samplers 
)

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