Flutter Engine
 
Loading...
Searching...
No Matches
flutter::Settings Struct Reference

#include <settings.h>

Public Types

enum class  MergedPlatformUIThread {
  kDisabled ,
  kEnabled ,
  kMergeAfterLaunch
}
 

Public Member Functions

 Settings ()
 
 Settings (const Settings &other)
 
 ~Settings ()
 

Public Attributes

std::string vm_snapshot_data_path
 
MappingCallback vm_snapshot_data
 
std::string vm_snapshot_instr_path
 
MappingCallback vm_snapshot_instr
 
std::string isolate_snapshot_data_path
 
MappingCallback isolate_snapshot_data
 
std::string isolate_snapshot_instr_path
 
MappingCallback isolate_snapshot_instr
 
std::string route
 
MappingCallback dart_library_sources_kernel
 
std::vector< std::string > application_library_paths
 
std::vector< std::string > vmservice_snapshot_library_path
 
std::string application_kernel_asset
 
std::string application_kernel_list_asset
 
MappingsCallback application_kernels
 
std::string temp_directory_path
 
std::vector< std::string > dart_flags
 
bool enable_checked_mode = false
 
bool start_paused = false
 
bool trace_skia = false
 
std::vector< std::string > trace_allowlist
 
std::optional< std::vector< std::string > > trace_skia_allowlist
 
bool trace_startup = false
 
bool trace_systrace = false
 
std::string trace_to_file
 
bool enable_timeline_event_handler = true
 
bool dump_skp_on_shader_compilation = false
 
bool cache_sksl = false
 
bool purge_persistent_cache = false
 
bool endless_trace_buffer = false
 
bool enable_dart_profiling = false
 
bool profile_startup = false
 
bool disable_dart_asserts = false
 
bool enable_serial_gc = false
 
bool profile_microtasks = false
 
bool may_insecurely_connect_to_all_domains = true
 
std::string domain_network_policy
 
std::string advisory_script_uri = "main.dart"
 
std::string advisory_script_entrypoint = "main"
 
std::string executable_name = "Flutter"
 
bool enable_vm_service = false
 
bool enable_vm_service_publication = true
 
std::string vm_service_host
 
uint32_t vm_service_port = 0
 
bool disable_service_auth_codes = true
 
bool enable_service_port_fallback = false
 
bool use_test_fonts = false
 
bool use_asset_fonts = true
 
bool prefetched_default_font_manager = false
 
bool enable_wide_gamut = false
 
bool enable_impeller = false
 
bool enable_flutter_gpu = false
 
bool enable_surface_control = false
 
bool impeller_enable_lazy_shader_mode = false
 
bool impeller_antialiased_lines = false
 
bool warn_on_impeller_opt_out = false
 
std::optional< std::string > requested_rendering_backend
 
bool enable_vulkan_validation = false
 
bool enable_opengl_gpu_tracing = false
 
bool enable_vulkan_gpu_tracing = false
 
uint32_t font_initialization_data = 0
 
bool leak_vm = true
 
TaskObserverAdd task_observer_add
 
TaskObserverRemove task_observer_remove
 
std::function< void(const DartIsolate &)> root_isolate_create_callback
 
fml::closure isolate_create_callback
 
fml::closure root_isolate_shutdown_callback
 
fml::closure isolate_shutdown_callback
 
fml::closure service_isolate_create_callback
 
std::function< void(int64_t)> idle_notification_callback
 
UnhandledExceptionCallback unhandled_exception_callback
 
LogMessageCallback log_message_callback
 
bool enable_software_rendering = false
 
bool skia_deterministic_rendering_on_cpu = false
 
bool verbose_logging = false
 
std::string log_tag = "flutter"
 
bool icu_initialization_required = true
 
std::string icu_data_path
 
MappingCallback icu_mapper
 
fml::UniqueFD::element_type assets_dir
 
std::string assets_path
 
FrameRasterizedCallback frame_rasterized_callback
 
std::shared_ptr< const fml::Mappingpersistent_isolate_data
 
int64_t old_gen_heap_size = -1
 
size_t resource_cache_max_bytes_threshold = 0
 
bool enable_embedder_api = false
 
bool enable_platform_isolates = false
 
MergedPlatformUIThread merged_platform_ui_thread
 

Static Public Attributes

static constexpr bool kSurfaceDataAccessible
 

Detailed Description

Definition at line 98 of file settings.h.

Member Enumeration Documentation

◆ MergedPlatformUIThread

Enumerator
kDisabled 
kEnabled 
kMergeAfterLaunch 

Definition at line 367 of file settings.h.

367 {
368 // Use separate threads for the UI and platform task runners.
369 kDisabled,
370 // Use the platform thread for both the UI and platform task runners.
371 kEnabled,
372 // Start the engine on a separate UI thread and then move the UI task
373 // runner to the platform thread after the engine is initialized.
374 // This can improve app launch latency by allowing other work to run on
375 // the platform thread during engine startup.
377 };

Constructor & Destructor Documentation

◆ Settings() [1/2]

flutter::Settings::Settings ( )
default

◆ Settings() [2/2]

flutter::Settings::Settings ( const Settings other)
default

◆ ~Settings()

flutter::Settings::~Settings ( )
default

Member Data Documentation

◆ advisory_script_entrypoint

std::string flutter::Settings::advisory_script_entrypoint = "main"

◆ advisory_script_uri

std::string flutter::Settings::advisory_script_uri = "main.dart"

◆ application_kernel_asset

std::string flutter::Settings::application_kernel_asset

◆ application_kernel_list_asset

std::string flutter::Settings::application_kernel_list_asset

Definition at line 141 of file settings.h.

Referenced by flutter::IsolateConfiguration::InferFromSettings().

◆ application_kernels

◆ application_library_paths

std::vector<std::string> flutter::Settings::application_library_paths

◆ assets_dir

fml::UniqueFD::element_type flutter::Settings::assets_dir
Initial value:
=
fml::UniqueFD::traits_type::InvalidValue()

Definition at line 331 of file settings.h.

Referenced by flutter::RunConfiguration::InferFromSettings(), flutter::RunTester(), and flutter::testing::DartFixture::SetSnapshotsAndAssets().

◆ assets_path

std::string flutter::Settings::assets_path

◆ cache_sksl

bool flutter::Settings::cache_sksl = false

Definition at line 157 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ dart_flags

std::vector<std::string> flutter::Settings::dart_flags

◆ dart_library_sources_kernel

MappingCallback flutter::Settings::dart_library_sources_kernel

Definition at line 129 of file settings.h.

Referenced by PopulateJITSnapshotMappingCallbacks(), and flutter::testing::TEST_F().

◆ disable_dart_asserts

bool flutter::Settings::disable_dart_asserts = false

Definition at line 162 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ disable_service_auth_codes

bool flutter::Settings::disable_service_auth_codes = true

Definition at line 202 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ domain_network_policy

std::string flutter::Settings::domain_network_policy

Definition at line 169 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ dump_skp_on_shader_compilation

bool flutter::Settings::dump_skp_on_shader_compilation = false

Definition at line 156 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ enable_checked_mode

bool flutter::Settings::enable_checked_mode = false

Definition at line 147 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ enable_dart_profiling

bool flutter::Settings::enable_dart_profiling = false

Definition at line 160 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ enable_embedder_api

bool flutter::Settings::enable_embedder_api = false

Enable embedder api on the embedder.

This is currently only used by iOS.

Definition at line 360 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ enable_flutter_gpu

bool flutter::Settings::enable_flutter_gpu = false

Definition at line 233 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ enable_impeller

◆ enable_opengl_gpu_tracing

bool flutter::Settings::enable_opengl_gpu_tracing = false

Definition at line 256 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ enable_platform_isolates

bool flutter::Settings::enable_platform_isolates = false

Enable support for isolates that run on the platform thread.

This is used by the runOnPlatformThread API.

Definition at line 365 of file settings.h.

Referenced by flutter::DartUI::InitForIsolate(), and flutter::SettingsFromCommandLine().

◆ enable_serial_gc

bool flutter::Settings::enable_serial_gc = false

Definition at line 163 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ enable_service_port_fallback

bool flutter::Settings::enable_service_port_fallback = false

Definition at line 206 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ enable_software_rendering

◆ enable_surface_control

bool flutter::Settings::enable_surface_control = false

◆ enable_timeline_event_handler

bool flutter::Settings::enable_timeline_event_handler = true

Definition at line 155 of file settings.h.

◆ enable_vm_service

bool flutter::Settings::enable_vm_service = false

◆ enable_vm_service_publication

bool flutter::Settings::enable_vm_service_publication = true

Definition at line 190 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ enable_vulkan_gpu_tracing

bool flutter::Settings::enable_vulkan_gpu_tracing = false

Definition at line 259 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ enable_vulkan_validation

bool flutter::Settings::enable_vulkan_validation = false

Definition at line 252 of file settings.h.

Referenced by flutter::RunTester(), and flutter::SettingsFromCommandLine().

◆ enable_wide_gamut

bool flutter::Settings::enable_wide_gamut = false

Definition at line 218 of file settings.h.

Referenced by flutter::ImageDecoder::Make().

◆ endless_trace_buffer

bool flutter::Settings::endless_trace_buffer = false

Definition at line 159 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ executable_name

std::string flutter::Settings::executable_name = "Flutter"

Definition at line 180 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ font_initialization_data

uint32_t flutter::Settings::font_initialization_data = 0

Definition at line 262 of file settings.h.

Referenced by flutter::Engine::SetupDefaultFontManager().

◆ frame_rasterized_callback

FrameRasterizedCallback flutter::Settings::frame_rasterized_callback

Definition at line 337 of file settings.h.

Referenced by flutter::testing::TEST_F().

◆ icu_data_path

std::string flutter::Settings::icu_data_path

Definition at line 327 of file settings.h.

Referenced by FlutterEngineInitialize(), and flutter::SettingsFromCommandLine().

◆ icu_initialization_required

bool flutter::Settings::icu_initialization_required = true

Definition at line 326 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ icu_mapper

MappingCallback flutter::Settings::icu_mapper

Definition at line 328 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ idle_notification_callback

std::function<void(int64_t)> flutter::Settings::idle_notification_callback

Definition at line 306 of file settings.h.

Referenced by flutter::Engine::Engine(), and flutter::Engine::Spawn().

◆ impeller_antialiased_lines

bool flutter::Settings::impeller_antialiased_lines = false

Definition at line 242 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ impeller_enable_lazy_shader_mode

bool flutter::Settings::impeller_enable_lazy_shader_mode = false

◆ isolate_create_callback

◆ isolate_shutdown_callback

fml::closure flutter::Settings::isolate_shutdown_callback

◆ isolate_snapshot_data

◆ isolate_snapshot_data_path

std::string flutter::Settings::isolate_snapshot_data_path

Definition at line 120 of file settings.h.

Referenced by flutter::ResolveIsolateData(), and flutter::SettingsFromCommandLine().

◆ isolate_snapshot_instr

◆ isolate_snapshot_instr_path

std::string flutter::Settings::isolate_snapshot_instr_path

◆ kSurfaceDataAccessible

constexpr bool flutter::Settings::kSurfaceDataAccessible
staticconstexpr
Initial value:
=
true

Determines if attempts at grabbing the Surface's SurfaceData can be attempted.

Definition at line 107 of file settings.h.

◆ leak_vm

◆ log_message_callback

LogMessageCallback flutter::Settings::log_message_callback

Definition at line 316 of file settings.h.

Referenced by FlutterEngineInitialize().

◆ log_tag

std::string flutter::Settings::log_tag = "flutter"

Definition at line 320 of file settings.h.

Referenced by FlutterEngineInitialize(), and flutter::SettingsFromCommandLine().

◆ may_insecurely_connect_to_all_domains

bool flutter::Settings::may_insecurely_connect_to_all_domains = true

Definition at line 167 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ merged_platform_ui_thread

◆ old_gen_heap_size

int64_t flutter::Settings::old_gen_heap_size = -1

Max size of old gen heap size in MB, or 0 for unlimited, -1 for default value.

See also: https://github.com/dart-lang/sdk/blob/ca64509108b3e7219c50d6c52877c85ab6a35ff2/runtime/vm/flag_list.h#L150

Definition at line 352 of file settings.h.

Referenced by FlutterEngineInitialize(), and flutter::SettingsFromCommandLine().

◆ persistent_isolate_data

std::shared_ptr<const fml::Mapping> flutter::Settings::persistent_isolate_data

◆ prefetched_default_font_manager

bool flutter::Settings::prefetched_default_font_manager = false

Definition at line 215 of file settings.h.

Referenced by flutter::Engine::Run(), and flutter::SettingsFromCommandLine().

◆ profile_microtasks

bool flutter::Settings::profile_microtasks = false

Definition at line 164 of file settings.h.

Referenced by flutter::SettingsFromCommandLine(), and flutter::testing::TEST().

◆ profile_startup

bool flutter::Settings::profile_startup = false

Definition at line 161 of file settings.h.

Referenced by flutter::SettingsFromCommandLine(), and flutter::testing::TEST().

◆ purge_persistent_cache

bool flutter::Settings::purge_persistent_cache = false

Definition at line 158 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ requested_rendering_backend

std::optional<std::string> flutter::Settings::requested_rendering_backend

◆ resource_cache_max_bytes_threshold

size_t flutter::Settings::resource_cache_max_bytes_threshold = 0

Definition at line 355 of file settings.h.

Referenced by flutter::Shell::Create(), and flutter::SettingsFromCommandLine().

◆ root_isolate_create_callback

std::function<void(const DartIsolate&)> flutter::Settings::root_isolate_create_callback

◆ root_isolate_shutdown_callback

fml::closure flutter::Settings::root_isolate_shutdown_callback

Definition at line 291 of file settings.h.

Referenced by flutter::DartIsolate::CreateRunningRootIsolate().

◆ route

std::string flutter::Settings::route

Definition at line 125 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ service_isolate_create_callback

fml::closure flutter::Settings::service_isolate_create_callback

Definition at line 300 of file settings.h.

◆ skia_deterministic_rendering_on_cpu

bool flutter::Settings::skia_deterministic_rendering_on_cpu = false

Definition at line 318 of file settings.h.

Referenced by flutter::SettingsFromCommandLine(), and flutter::testing::TEST_F().

◆ start_paused

bool flutter::Settings::start_paused = false

Definition at line 148 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ task_observer_add

◆ task_observer_remove

◆ temp_directory_path

std::string flutter::Settings::temp_directory_path

Definition at line 144 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ trace_allowlist

std::vector<std::string> flutter::Settings::trace_allowlist

Definition at line 150 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ trace_skia

bool flutter::Settings::trace_skia = false

Definition at line 149 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ trace_skia_allowlist

std::optional<std::vector<std::string> > flutter::Settings::trace_skia_allowlist

Definition at line 151 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ trace_startup

bool flutter::Settings::trace_startup = false

Definition at line 152 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ trace_systrace

bool flutter::Settings::trace_systrace = false

Definition at line 153 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ trace_to_file

std::string flutter::Settings::trace_to_file

Definition at line 154 of file settings.h.

Referenced by flutter::SettingsFromCommandLine(), and flutter::testing::TEST().

◆ unhandled_exception_callback

◆ use_asset_fonts

bool flutter::Settings::use_asset_fonts = true

◆ use_test_fonts

bool flutter::Settings::use_test_fonts = false

◆ verbose_logging

bool flutter::Settings::verbose_logging = false

◆ vm_service_host

std::string flutter::Settings::vm_service_host

Definition at line 193 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ vm_service_port

uint32_t flutter::Settings::vm_service_port = 0

Definition at line 198 of file settings.h.

Referenced by flutter::SettingsFromCommandLine().

◆ vm_snapshot_data

◆ vm_snapshot_data_path

std::string flutter::Settings::vm_snapshot_data_path

Definition at line 115 of file settings.h.

Referenced by flutter::ResolveVMData(), and flutter::SettingsFromCommandLine().

◆ vm_snapshot_instr

◆ vm_snapshot_instr_path

std::string flutter::Settings::vm_snapshot_instr_path

Definition at line 117 of file settings.h.

Referenced by flutter::ResolveVMInstructions(), and flutter::SettingsFromCommandLine().

◆ vmservice_snapshot_library_path

std::vector<std::string> flutter::Settings::vmservice_snapshot_library_path

◆ warn_on_impeller_opt_out

bool flutter::Settings::warn_on_impeller_opt_out = false

Definition at line 245 of file settings.h.

Referenced by flutter::testing::TEST_F().


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