diff --git a/examples/flutter/material_editor/.gitignore b/examples/flutter/material_editor/.gitignore new file mode 100644 index 000000000..79c113f9b --- /dev/null +++ b/examples/flutter/material_editor/.gitignore @@ -0,0 +1,45 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.build/ +.buildlog/ +.history +.svn/ +.swiftpm/ +migrate_working_dir/ + +# IntelliJ related +*.iml +*.ipr +*.iws +.idea/ + +# The .vscode folder contains launch configuration and tasks you configure in +# VS Code which you may wish to be included in version control, so this line +# is commented out by default. +#.vscode/ + +# Flutter/Dart/Pub related +**/doc/api/ +**/ios/Flutter/.last_build_id +.dart_tool/ +.flutter-plugins +.flutter-plugins-dependencies +.pub-cache/ +.pub/ +/build/ + +# Symbolication related +app.*.symbols + +# Obfuscation related +app.*.map.json + +# Android Studio will place build artifacts here +/android/app/debug +/android/app/profile +/android/app/release diff --git a/examples/flutter/material_editor/.metadata b/examples/flutter/material_editor/.metadata new file mode 100644 index 000000000..e9e04af56 --- /dev/null +++ b/examples/flutter/material_editor/.metadata @@ -0,0 +1,36 @@ +# This file tracks properties of this Flutter project. +# Used by Flutter tool to assess capabilities and perform upgrades etc. +# +# This file should be version controlled and should not be manually edited. + +version: + revision: "44a626f4f0027bc38a46dc68aed5964b05a83c18" + channel: "[user-branch]" + +project_type: app + +# Tracks metadata for the flutter migrate command +migration: + platforms: + - platform: root + create_revision: 44a626f4f0027bc38a46dc68aed5964b05a83c18 + base_revision: 44a626f4f0027bc38a46dc68aed5964b05a83c18 + - platform: linux + create_revision: 44a626f4f0027bc38a46dc68aed5964b05a83c18 + base_revision: 44a626f4f0027bc38a46dc68aed5964b05a83c18 + - platform: macos + create_revision: 44a626f4f0027bc38a46dc68aed5964b05a83c18 + base_revision: 44a626f4f0027bc38a46dc68aed5964b05a83c18 + - platform: windows + create_revision: 44a626f4f0027bc38a46dc68aed5964b05a83c18 + base_revision: 44a626f4f0027bc38a46dc68aed5964b05a83c18 + + # User provided section + + # List of Local paths (relative to this file) that should be + # ignored by the migrate tool. + # + # Files that are not part of the templates will be ignored by default. + unmanaged_files: + - 'lib/main.dart' + - 'ios/Runner.xcodeproj/project.pbxproj' diff --git a/examples/flutter/material_editor/README.md b/examples/flutter/material_editor/README.md new file mode 100644 index 000000000..aa2f6bc22 --- /dev/null +++ b/examples/flutter/material_editor/README.md @@ -0,0 +1,62 @@ +# material_editor + +A Flutter project demonstrating **runtime material compilation and +hot-reload** in Thermion: edit Filament `.mat` source in a text field and see +the change on a live-rendered sphere, without restarting the app. + +The top half of the window is a `ViewerWidget` rendering a sphere; the bottom +half is a plain `TextField` holding `.mat` source. Every edit (debounced, or +via the **Apply** button) is compiled to a `.filamat` package *inside the +running engine* and hot-swapped onto the sphere. + +## How it works + +Two APIs from `thermion_dart` drive the whole loop: + +1. **`FilamentApp.compileMaterial(source)`** (runtime compile) — parses and + compiles `.mat` source through the same `matp` + `filamat` pipeline the + offline `matc` tool uses, returning the compiled `.filamat` bytes. On + failure it throws `MaterialCompileException` with the compiler's message, + which the editor shows inline under the text field. + +2. **`FilamentApp.reloadMaterialFromBytes(material, bytes)`** (hot-reload) — + builds a new `Material` from the compiled bytes, creates a replacement + `MaterialInstance`, re-points every renderable that used the old instance, + replays recorded instance state (parameters like `baseTint` below) onto the + replacement, and destroys the old material. The sphere never leaves the + scene; only the material under it changes. + +Startup (`_onViewerAvailable`) compiles `materials/starter.mat` — a lit +material with `baseTint` / `roughness` / `metallic` parameters — creates an +instance, sets those parameters, and creates the sphere geometry with that +instance. Subsequent compiles go through `reloadMaterialFromBytes`, so the +parameter values set at startup survive every edit: change `shadingModel` to +`unlit`, delete `prepareMaterial`, or introduce a syntax error — the sphere +keeps rendering the last good material while the error is shown inline. + +The starter source is a good place to experiment: + +- change `material.baseColor = materialParams.baseTint;` to a constant + `float4(1.0, 0.3, 0.1, 1.0)`; +- add `material.clearCoat = 1.0;` after `prepareMaterial(material);`; +- set `shadingModel : unlit` (and drop the roughness/metallic lines) to see + flat unshaded color; +- delete a `}` to see the inline error report. + +## Platform support + +Runtime compilation is linked into **desktop** engine builds only (Linux, +macOS, Windows). On web `compileMaterial` throws `UnsupportedError`, and on +Android/iOS the native engine reports "not supported" via +`MaterialCompileException`. The example handles both: the sphere still +renders with the default material and the status bar explains why. + +## Running + +```sh +flutter pub get +flutter run -d linux # or -d macos / -d windows +``` + +The example targets desktop platforms only (runtime compilation is not +available elsewhere). diff --git a/examples/flutter/material_editor/analysis_options.yaml b/examples/flutter/material_editor/analysis_options.yaml new file mode 100644 index 000000000..0d2902135 --- /dev/null +++ b/examples/flutter/material_editor/analysis_options.yaml @@ -0,0 +1,28 @@ +# This file configures the analyzer, which statically analyzes Dart code to +# check for errors, warnings, and lints. +# +# The issues identified by the analyzer are surfaced in the UI of Dart-enabled +# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be +# invoked from the command line by running `flutter analyze`. + +# The following line activates a set of recommended lints for Flutter apps, +# packages, and plugins designed to encourage good coding practices. +include: package:flutter_lints/flutter.yaml + +linter: + # The lint rules applied to this project can be customized in the + # section below to disable rules from the `package:flutter_lints/flutter.yaml` + # included above or to enable additional rules. A list of all available lints + # and their documentation is published at https://dart.dev/lints. + # + # Instead of disabling a lint rule for the entire project in the + # section below, it can also be suppressed for a single line of code + # or a specific dart file by using the `// ignore: name_of_lint` and + # `// ignore_for_file: name_of_lint` syntax on the line or in the file + # producing the lint. + rules: + # avoid_print: false # Uncomment to disable the `avoid_print` rule + # prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule + +# Additional information about this file can be found at +# https://dart.dev/guides/language/analysis-options diff --git a/examples/flutter/material_editor/lib/main.dart b/examples/flutter/material_editor/lib/main.dart new file mode 100644 index 000000000..124d15765 --- /dev/null +++ b/examples/flutter/material_editor/lib/main.dart @@ -0,0 +1,522 @@ +import 'dart:async'; + +import 'package:flutter/foundation.dart'; +import 'package:flutter/material.dart'; +import 'package:flutter/services.dart'; +import 'package:logging/logging.dart'; +// thermion_dart exports classes whose names collide with Flutter widgets +// (Material, Transform, Texture...) as well as vector_math (Vector3, Matrix4). +// The unprefixed import wins for viewer plumbing; the `t` prefix is used for +// the colliding names. +import 'package:thermion_flutter/thermion_flutter.dart'; +import 'package:thermion_flutter/thermion_flutter.dart' as t; + +/// A live material editor for Thermion + Filament. +/// +/// The top half renders a sphere. The bottom half is a text editor holding +/// Filament `.mat` source. On every edit (debounced) the source is compiled +/// to a `.filamat` package *inside the running engine* +/// (`FilamentApp.compileMaterial`), and the new package is hot-swapped onto +/// the sphere (`FilamentApp.reloadMaterialFromBytes`), which preserves the +/// material instance's parameter values. Compile errors are shown inline so +/// you can iterate without restarting the app. +/// +/// Runtime compilation is linked into desktop engine builds only (linux, +/// macOS, Windows). On other platforms this example still runs, but the +/// sphere keeps the default material and the status bar explains why. +void main() { + Logger.root.onRecord.listen((record) { + debugPrint(record.toString()); + }); + runApp(const MaterialEditorApp()); +} + +class MaterialEditorApp extends StatelessWidget { + const MaterialEditorApp({super.key}); + + @override + Widget build(BuildContext context) { + return MaterialApp( + title: 'Thermion material editor', + debugShowCheckedModeBanner: false, + theme: ThemeData( + colorScheme: ColorScheme.fromSeed(seedColor: const Color(0xFF6EA8FF)), + useMaterial3: true, + ), + home: const EditorPage(), + ); + } +} + +/// Values applied to the starter material's parameters. They survive every +/// hot-swap: [FilamentApp.reloadMaterialFromBytes] replays recorded instance +/// state onto the replacement instance. +const _starterTint = [0.62, 0.55, 0.92, 1.0]; +const _starterRoughness = 0.35; +const _starterMetallic = 0.15; + +/// Debounce window between the last keystroke and a recompile. +const _autoApplyDelay = Duration(milliseconds: 600); + +class EditorPage extends StatefulWidget { + const EditorPage({super.key}); + + @override + State createState() => _EditorPageState(); +} + +class _EditorPageState extends State { + final TextEditingController _controller = TextEditingController(); + final ScrollController _editorScroll = ScrollController(); + + ThermionViewer? _viewer; + ThermionAsset? _asset; + + /// Completes when the starter source has been seeded into the editor. + /// [_onViewerAvailable] waits on it so the first compile always sees the + /// real starter source, not a still-empty text field. + Future? _starterLoaded; + + /// The material currently on the sphere; null until the first successful + /// compile. Subsequent successful compiles replace it via + /// [FilamentApp.reloadMaterialFromBytes]. + t.Material? _material; + + Timer? _debounce; + Timer? _spin; + bool _busy = false; + bool _autoApply = true; + String _status = 'loading…'; + String? _error; + bool _ok = false; + + @override + void initState() { + super.initState(); + _starterLoaded = _loadStarterSource(); + } + + Future _loadStarterSource() async { + // Seed the editor from the shipped starter .mat so it opens with + // something that renders immediately (and is easy to break on purpose). + try { + _controller.text = await rootBundle.loadString('materials/starter.mat'); + } catch (_) { + _controller.text = _fallbackStarter; + } + } + + /// Called by [ViewerWidget] once the viewer exists. Creates the sphere with + /// the starter material applied, or — where runtime compilation is not + /// linked — with the default material plus an explanatory status. + Future _onViewerAvailable(ThermionViewer viewer) async { + _viewer = viewer; + await _starterLoaded; + // Runtime compilation is only linked into desktop engine builds. Check + // up front so the message is accurate; the exception handlers below + // still cover the case where the platform stub throws instead. + final desktop = switch (defaultTargetPlatform) { + TargetPlatform.linux || + TargetPlatform.macOS || + TargetPlatform.windows => + true, + _ => false, + }; + if (!desktop) { + await _createGeometryWithDefaultMaterial(); + if (mounted) { + setState(() { + _error = 'runtime material compilation requires a desktop build ' + '(linux, macOS or Windows)'; + _status = 'runtime compilation unavailable'; + }); + } + return; + } + try { + final app = FilamentApp.instance!; + final bytes = await app.compileMaterial(_controller.text); + final material = await app.createMaterial(bytes); + final instance = await material.createInstance(); + await _applyStarterParams(instance); + _material = material; + _asset = await viewer.createGeometry( + GeometryUtils.sphere(), + materialInstances: [instance], + ); + _startSpin(); + if (mounted) { + setState(() { + _ok = true; + _status = 'compiled starter material (${bytes.length} bytes)'; + }); + } + } on UnsupportedError catch (error) { + // Web: the WASM engine does not link the material compiler. + await _createGeometryWithDefaultMaterial(); + if (mounted) { + setState(() { + _error = error.message; + _status = 'runtime compilation unavailable'; + }); + } + } on MaterialCompileException catch (error) { + // Android/iOS: the stub implementation reports through this exception. + await _createGeometryWithDefaultMaterial(); + if (mounted) { + setState(() { + _error = error.message; + _status = 'runtime compilation unavailable'; + }); + } + } catch (error, stackTrace) { + debugPrint('viewer setup failed: $error\n$stackTrace'); + if (mounted) { + setState(() => _status = 'viewer setup failed'); + } + } + } + + Future _createGeometryWithDefaultMaterial() async { + // No material instance to pass: the geometry falls back to the default + // ubershader so there is still something to look at. + _asset = await _viewer!.createGeometry(GeometryUtils.sphere()); + _startSpin(); + } + + Future _applyStarterParams(MaterialInstance instance) async { + await instance.setParameterFloat4( + 'baseTint', _starterTint[0], _starterTint[1], _starterTint[2], _starterTint[3]); + await instance.setParameterFloat('roughness', _starterRoughness); + await instance.setParameterFloat('metallic', _starterMetallic); + } + + void _startSpin() { + _spin?.cancel(); + final started = DateTime.now(); + _spin = Timer.periodic(const Duration(milliseconds: 16), (timer) async { + final asset = _asset; + if (!mounted || asset == null) { + timer.cancel(); + return; + } + final elapsed = + DateTime.now().difference(started).inMilliseconds / 1000.0; + await asset.setTransform(Matrix4.rotationY(elapsed * 0.5)); + }); + } + + void _onSourceChanged() { + if (!_autoApply) return; + _debounce?.cancel(); + _debounce = Timer(_autoApplyDelay, _compileAndApply); + } + + /// The heart of the example: compile the edited source and hot-swap it. + Future _compileAndApply() async { + final app = FilamentApp.instance; + final material = _material; + if (app == null || _busy) return; + + setState(() { + _busy = true; + _status = 'compiling…'; + _error = null; + }); + try { + final bytes = await app.compileMaterial(_controller.text); + if (material == null) { + // Reachable only if the initial compile failed (e.g. the shipped + // starter was somehow invalid) and a manual edit fixed it: build the + // material fresh and put it on the geometry. + final created = await app.createMaterial(bytes); + final instance = await created.createInstance(); + await _applyStarterParams(instance); + final asset = _asset; + if (asset == null) { + _asset = await _viewer!.createGeometry( + GeometryUtils.sphere(), + materialInstances: [instance], + ); + } else { + await app.setMaterialInstanceAt(asset.entity, 0, instance); + } + _material = created; + } else { + // Swap the new package in. Instance parameters are replayed from the + // recorded shadow state, so tint/roughness/metallic survive. + _material = await app.reloadMaterialFromBytes(material, bytes); + } + if (mounted) { + setState(() { + _ok = true; + _status = 'applied (${bytes.length} bytes)'; + }); + } + } on MaterialCompileException catch (error) { + // Parse/shader errors land here with the compiler's message. + if (mounted) { + setState(() { + _ok = false; + _status = 'compile failed'; + _error = error.message; + }); + } + } on UnsupportedError catch (error) { + if (mounted) { + setState(() { + _ok = false; + _status = 'runtime compilation unavailable'; + _error = error.message; + }); + } + } catch (error, stackTrace) { + debugPrint('compile failed: $error\n$stackTrace'); + if (mounted) { + setState(() { + _ok = false; + _status = 'apply failed'; + _error = error.toString(); + }); + } + } finally { + if (mounted) { + setState(() => _busy = false); + } + } + } + + Future _resetToStarter() async { + // Programmatic text changes do not fire onChanged, so apply explicitly — + // after the (async) reload of the starter source completes. + await _loadStarterSource(); + if (mounted) setState(() => _error = null); + await _compileAndApply(); + } + + @override + void dispose() { + _debounce?.cancel(); + _spin?.cancel(); + _controller.dispose(); + _editorScroll.dispose(); + super.dispose(); + } + + @override + Widget build(BuildContext context) { + final scheme = Theme.of(context).colorScheme; + return Scaffold( + body: SafeArea( + child: LayoutBuilder( + builder: (context, constraints) { + final wide = constraints.maxWidth > constraints.maxHeight; + final editor = _buildEditorPane(scheme); + final viewport = _buildViewport(scheme); + return wide + ? Row(children: [ + Expanded(flex: 5, child: viewport), + Expanded(flex: 4, child: editor), + ]) + : Column(children: [ + Expanded(flex: 5, child: viewport), + Expanded(flex: 4, child: editor), + ]); + }, + ), + ), + ); + } + + Widget _buildViewport(ColorScheme scheme) { + return Card( + margin: const EdgeInsets.all(8), + clipBehavior: Clip.antiAlias, + child: Stack( + children: [ + Positioned.fill( + child: ViewerWidget( + background: scheme.surfaceContainerLowest, + directLight: + DirectLight.sun(direction: Vector3(0.6, -1.0, -0.7).normalized()), + initialCameraPosition: Vector3(0, 0, 3.2), + manipulatorType: ManipulatorType.ORBIT, + onViewerAvailable: _onViewerAvailable, + initial: const Center(child: CircularProgressIndicator()), + ), + ), + const Positioned( + left: 12, + bottom: 12, + child: _HintChip('drag to orbit · scroll to zoom'), + ), + ], + ), + ); + } + + Widget _buildEditorPane(ColorScheme scheme) { + return Card( + margin: const EdgeInsets.all(8), + clipBehavior: Clip.antiAlias, + child: Column( + crossAxisAlignment: CrossAxisAlignment.stretch, + children: [ + _buildToolbar(scheme), + const Divider(height: 1), + Expanded( + child: TextField( + controller: _controller, + scrollController: _editorScroll, + onChanged: (_) => _onSourceChanged(), + maxLines: null, + expands: true, + textAlignVertical: TextAlignVertical.top, + style: const TextStyle(fontFamily: 'monospace', fontSize: 13), + decoration: const InputDecoration( + isDense: true, + border: InputBorder.none, + contentPadding: EdgeInsets.all(12), + hintText: 'material { … }', + ), + ), + ), + if (_error != null) ...[ + const Divider(height: 1), + _ErrorPane(_error!), + ], + ], + ), + ); + } + + Widget _buildToolbar(ColorScheme scheme) { + return Padding( + padding: const EdgeInsets.fromLTRB(12, 8, 8, 8), + child: Row( + children: [ + Icon( + _busy + ? Icons.hourglass_top + : _ok + ? Icons.check_circle + : Icons.error_outline, + size: 16, + color: _busy + ? scheme.tertiary + : _ok + ? Colors.green + : scheme.error, + ), + const SizedBox(width: 8), + Expanded( + child: Text( + _status, + maxLines: 1, + overflow: TextOverflow.ellipsis, + style: Theme.of(context).textTheme.bodySmall, + ), + ), + IconButton( + tooltip: 'Auto-apply while typing', + isSelected: _autoApply, + onPressed: () => setState(() => _autoApply = !_autoApply), + icon: const Icon(Icons.autorenew), + selectedIcon: const Icon(Icons.autorenew), + ), + IconButton( + tooltip: 'Reset to starter material', + onPressed: _resetToStarter, + icon: const Icon(Icons.restart_alt), + ), + const SizedBox(width: 4), + FilledButton.tonalIcon( + onPressed: _busy ? null : _compileAndApply, + icon: const Icon(Icons.play_arrow, size: 18), + label: const Text('Apply'), + ), + const SizedBox(width: 4), + ], + ), + ); + } +} + +class _ErrorPane extends StatelessWidget { + const _ErrorPane(this.message); + + final String message; + + @override + Widget build(BuildContext context) { + final scheme = Theme.of(context).colorScheme; + return Container( + constraints: const BoxConstraints(maxHeight: 120), + color: scheme.errorContainer.withValues(alpha: 0.35), + child: SingleChildScrollView( + child: Padding( + padding: const EdgeInsets.all(12), + child: Text( + message, + style: TextStyle( + fontFamily: 'monospace', + fontSize: 12, + color: scheme.onErrorContainer, + ), + ), + ), + ), + ); + } +} + +class _HintChip extends StatelessWidget { + const _HintChip(this.label); + + final String label; + + @override + Widget build(BuildContext context) { + final scheme = Theme.of(context).colorScheme; + return DecoratedBox( + decoration: BoxDecoration( + color: scheme.surface.withValues(alpha: 0.7), + borderRadius: BorderRadius.circular(999), + ), + child: Padding( + padding: const EdgeInsets.symmetric(horizontal: 10, vertical: 4), + child: Text( + label, + style: Theme.of(context).textTheme.bodySmall?.copyWith( + color: scheme.onSurface.withValues(alpha: 0.7), + ), + ), + ), + ); + } +} + +/// Used only if the starter asset cannot be loaded; mirrors +/// materials/starter.mat. +const _fallbackStarter = ''' +material { + name : "Editor Starter", + requires : [ position, uv0 ], + parameters : [ + { type : float4, name : baseTint }, + { type : float, name : roughness }, + { type : float, name : metallic } + ], + shadingModel : lit, + blending : opaque, + culling : back, +} +fragment { + void material(inout MaterialInputs material) { + prepareMaterial(material); + material.baseColor = materialParams.baseTint; + material.roughness = materialParams.roughness; + material.metallic = materialParams.metallic; + } +} +'''; diff --git a/examples/flutter/material_editor/linux/.gitignore b/examples/flutter/material_editor/linux/.gitignore new file mode 100644 index 000000000..d3896c984 --- /dev/null +++ b/examples/flutter/material_editor/linux/.gitignore @@ -0,0 +1 @@ +flutter/ephemeral diff --git a/examples/flutter/material_editor/linux/CMakeLists.txt b/examples/flutter/material_editor/linux/CMakeLists.txt new file mode 100644 index 000000000..16a7279c8 --- /dev/null +++ b/examples/flutter/material_editor/linux/CMakeLists.txt @@ -0,0 +1,128 @@ +# Project-level configuration. +cmake_minimum_required(VERSION 3.13) +project(runner LANGUAGES CXX) + +# The name of the executable created for the application. Change this to change +# the on-disk name of your application. +set(BINARY_NAME "material_editor") +# The unique GTK application identifier for this application. See: +# https://wiki.gnome.org/HowDoI/ChooseApplicationID +set(APPLICATION_ID "com.avinium.material_editor") + +# Explicitly opt in to modern CMake behaviors to avoid warnings with recent +# versions of CMake. +cmake_policy(SET CMP0063 NEW) + +# Load bundled libraries from the lib/ directory relative to the binary. +set(CMAKE_INSTALL_RPATH "$ORIGIN/lib") + +# Root filesystem for cross-building. +if(FLUTTER_TARGET_PLATFORM_SYSROOT) + set(CMAKE_SYSROOT ${FLUTTER_TARGET_PLATFORM_SYSROOT}) + set(CMAKE_FIND_ROOT_PATH ${CMAKE_SYSROOT}) + set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) + set(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY) + set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY) + set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY) +endif() + +# Define build configuration options. +if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE "Debug" CACHE + STRING "Flutter build mode" FORCE) + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS + "Debug" "Profile" "Release") +endif() + +# Compilation settings that should be applied to most targets. +# +# Be cautious about adding new options here, as plugins use this function by +# default. In most cases, you should add new options to specific targets instead +# of modifying this function. +function(APPLY_STANDARD_SETTINGS TARGET) + target_compile_features(${TARGET} PUBLIC cxx_std_14) + target_compile_options(${TARGET} PRIVATE -Wall -Werror) + target_compile_options(${TARGET} PRIVATE "$<$>:-O3>") + target_compile_definitions(${TARGET} PRIVATE "$<$>:NDEBUG>") +endfunction() + +# Flutter library and tool build rules. +set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") +add_subdirectory(${FLUTTER_MANAGED_DIR}) + +# System-level dependencies. +find_package(PkgConfig REQUIRED) +pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0) + +# Application build; see runner/CMakeLists.txt. +add_subdirectory("runner") + +# Run the Flutter tool portions of the build. This must not be removed. +add_dependencies(${BINARY_NAME} flutter_assemble) + +# Only the install-generated bundle's copy of the executable will launch +# correctly, since the resources must in the right relative locations. To avoid +# people trying to run the unbundled copy, put it in a subdirectory instead of +# the default top-level location. +set_target_properties(${BINARY_NAME} + PROPERTIES + RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/intermediates_do_not_run" +) + + +# Generated plugin build rules, which manage building the plugins and adding +# them to the application. +include(flutter/generated_plugins.cmake) + + +# === Installation === +# By default, "installing" just makes a relocatable bundle in the build +# directory. +set(BUILD_BUNDLE_DIR "${PROJECT_BINARY_DIR}/bundle") +if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) +endif() + +# Start with a clean build bundle directory every time. +install(CODE " + file(REMOVE_RECURSE \"${BUILD_BUNDLE_DIR}/\") + " COMPONENT Runtime) + +set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") +set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}/lib") + +install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +foreach(bundled_library ${PLUGIN_BUNDLED_LIBRARIES}) + install(FILES "${bundled_library}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endforeach(bundled_library) + +# Copy the native assets provided by the build.dart from all packages. +set(NATIVE_ASSETS_DIR "${PROJECT_BUILD_DIR}native_assets/linux/") +install(DIRECTORY "${NATIVE_ASSETS_DIR}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +# Fully re-copy the assets directory on each build to avoid having stale files +# from a previous install. +set(FLUTTER_ASSET_DIR_NAME "flutter_assets") +install(CODE " + file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") + " COMPONENT Runtime) +install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" + DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) + +# Install the AOT library on non-Debug builds only. +if(NOT CMAKE_BUILD_TYPE MATCHES "Debug") + install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endif() diff --git a/examples/flutter/material_editor/linux/flutter/CMakeLists.txt b/examples/flutter/material_editor/linux/flutter/CMakeLists.txt new file mode 100644 index 000000000..d5bd01648 --- /dev/null +++ b/examples/flutter/material_editor/linux/flutter/CMakeLists.txt @@ -0,0 +1,88 @@ +# This file controls Flutter-level build steps. It should not be edited. +cmake_minimum_required(VERSION 3.10) + +set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") + +# Configuration provided via flutter tool. +include(${EPHEMERAL_DIR}/generated_config.cmake) + +# TODO: Move the rest of this into files in ephemeral. See +# https://github.com/flutter/flutter/issues/57146. + +# Serves the same purpose as list(TRANSFORM ... PREPEND ...), +# which isn't available in 3.10. +function(list_prepend LIST_NAME PREFIX) + set(NEW_LIST "") + foreach(element ${${LIST_NAME}}) + list(APPEND NEW_LIST "${PREFIX}${element}") + endforeach(element) + set(${LIST_NAME} "${NEW_LIST}" PARENT_SCOPE) +endfunction() + +# === Flutter Library === +# System-level dependencies. +find_package(PkgConfig REQUIRED) +pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0) +pkg_check_modules(GLIB REQUIRED IMPORTED_TARGET glib-2.0) +pkg_check_modules(GIO REQUIRED IMPORTED_TARGET gio-2.0) + +set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/libflutter_linux_gtk.so") + +# Published to parent scope for install step. +set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) +set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) +set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) +set(AOT_LIBRARY "${PROJECT_DIR}/build/lib/libapp.so" PARENT_SCOPE) + +list(APPEND FLUTTER_LIBRARY_HEADERS + "fl_basic_message_channel.h" + "fl_binary_codec.h" + "fl_binary_messenger.h" + "fl_dart_project.h" + "fl_engine.h" + "fl_json_message_codec.h" + "fl_json_method_codec.h" + "fl_message_codec.h" + "fl_method_call.h" + "fl_method_channel.h" + "fl_method_codec.h" + "fl_method_response.h" + "fl_plugin_registrar.h" + "fl_plugin_registry.h" + "fl_standard_message_codec.h" + "fl_standard_method_codec.h" + "fl_string_codec.h" + "fl_value.h" + "fl_view.h" + "flutter_linux.h" +) +list_prepend(FLUTTER_LIBRARY_HEADERS "${EPHEMERAL_DIR}/flutter_linux/") +add_library(flutter INTERFACE) +target_include_directories(flutter INTERFACE + "${EPHEMERAL_DIR}" +) +target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}") +target_link_libraries(flutter INTERFACE + PkgConfig::GTK + PkgConfig::GLIB + PkgConfig::GIO +) +add_dependencies(flutter flutter_assemble) + +# === Flutter tool backend === +# _phony_ is a non-existent file to force this command to run every time, +# since currently there's no way to get a full input/output list from the +# flutter tool. +add_custom_command( + OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} + ${CMAKE_CURRENT_BINARY_DIR}/_phony_ + COMMAND ${CMAKE_COMMAND} -E env + ${FLUTTER_TOOL_ENVIRONMENT} + "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.sh" + ${FLUTTER_TARGET_PLATFORM} ${CMAKE_BUILD_TYPE} + VERBATIM +) +add_custom_target(flutter_assemble DEPENDS + "${FLUTTER_LIBRARY}" + ${FLUTTER_LIBRARY_HEADERS} +) diff --git a/examples/flutter/material_editor/linux/flutter/generated_plugin_registrant.cc b/examples/flutter/material_editor/linux/flutter/generated_plugin_registrant.cc new file mode 100644 index 000000000..01193c105 --- /dev/null +++ b/examples/flutter/material_editor/linux/flutter/generated_plugin_registrant.cc @@ -0,0 +1,15 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#include "generated_plugin_registrant.h" + +#include + +void fl_register_plugins(FlPluginRegistry* registry) { + g_autoptr(FlPluginRegistrar) thermion_flutter_registrar = + fl_plugin_registry_get_registrar_for_plugin(registry, "ThermionFlutterPlugin"); + thermion_flutter_plugin_register_with_registrar(thermion_flutter_registrar); +} diff --git a/examples/flutter/material_editor/linux/flutter/generated_plugin_registrant.h b/examples/flutter/material_editor/linux/flutter/generated_plugin_registrant.h new file mode 100644 index 000000000..e0f0a47bc --- /dev/null +++ b/examples/flutter/material_editor/linux/flutter/generated_plugin_registrant.h @@ -0,0 +1,15 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#ifndef GENERATED_PLUGIN_REGISTRANT_ +#define GENERATED_PLUGIN_REGISTRANT_ + +#include + +// Registers Flutter plugins. +void fl_register_plugins(FlPluginRegistry* registry); + +#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/examples/flutter/material_editor/linux/flutter/generated_plugins.cmake b/examples/flutter/material_editor/linux/flutter/generated_plugins.cmake new file mode 100644 index 000000000..274b5f605 --- /dev/null +++ b/examples/flutter/material_editor/linux/flutter/generated_plugins.cmake @@ -0,0 +1,24 @@ +# +# Generated file, do not edit. +# + +list(APPEND FLUTTER_PLUGIN_LIST + thermion_flutter +) + +list(APPEND FLUTTER_FFI_PLUGIN_LIST +) + +set(PLUGIN_BUNDLED_LIBRARIES) + +foreach(plugin ${FLUTTER_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/linux plugins/${plugin}) + target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) + list(APPEND PLUGIN_BUNDLED_LIBRARIES $) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) +endforeach(plugin) + +foreach(ffi_plugin ${FLUTTER_FFI_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${ffi_plugin}/linux plugins/${ffi_plugin}) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${ffi_plugin}_bundled_libraries}) +endforeach(ffi_plugin) diff --git a/examples/flutter/material_editor/linux/runner/CMakeLists.txt b/examples/flutter/material_editor/linux/runner/CMakeLists.txt new file mode 100644 index 000000000..e97dabc70 --- /dev/null +++ b/examples/flutter/material_editor/linux/runner/CMakeLists.txt @@ -0,0 +1,26 @@ +cmake_minimum_required(VERSION 3.13) +project(runner LANGUAGES CXX) + +# Define the application target. To change its name, change BINARY_NAME in the +# top-level CMakeLists.txt, not the value here, or `flutter run` will no longer +# work. +# +# Any new source files that you add to the application should be added here. +add_executable(${BINARY_NAME} + "main.cc" + "my_application.cc" + "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" +) + +# Apply the standard set of build settings. This can be removed for applications +# that need different build settings. +apply_standard_settings(${BINARY_NAME}) + +# Add preprocessor definitions for the application ID. +add_definitions(-DAPPLICATION_ID="${APPLICATION_ID}") + +# Add dependency libraries. Add any application-specific dependencies here. +target_link_libraries(${BINARY_NAME} PRIVATE flutter) +target_link_libraries(${BINARY_NAME} PRIVATE PkgConfig::GTK) + +target_include_directories(${BINARY_NAME} PRIVATE "${CMAKE_SOURCE_DIR}") diff --git a/examples/flutter/material_editor/linux/runner/main.cc b/examples/flutter/material_editor/linux/runner/main.cc new file mode 100644 index 000000000..e7c5c5437 --- /dev/null +++ b/examples/flutter/material_editor/linux/runner/main.cc @@ -0,0 +1,6 @@ +#include "my_application.h" + +int main(int argc, char** argv) { + g_autoptr(MyApplication) app = my_application_new(); + return g_application_run(G_APPLICATION(app), argc, argv); +} diff --git a/examples/flutter/material_editor/linux/runner/my_application.cc b/examples/flutter/material_editor/linux/runner/my_application.cc new file mode 100644 index 000000000..bd5811ef3 --- /dev/null +++ b/examples/flutter/material_editor/linux/runner/my_application.cc @@ -0,0 +1,148 @@ +#include "my_application.h" + +#include +#ifdef GDK_WINDOWING_X11 +#include +#endif + +#include "flutter/generated_plugin_registrant.h" + +struct _MyApplication { + GtkApplication parent_instance; + char** dart_entrypoint_arguments; +}; + +G_DEFINE_TYPE(MyApplication, my_application, GTK_TYPE_APPLICATION) + +// Called when first Flutter frame received. +static void first_frame_cb(MyApplication* self, FlView* view) { + gtk_widget_show(gtk_widget_get_toplevel(GTK_WIDGET(view))); +} + +// Implements GApplication::activate. +static void my_application_activate(GApplication* application) { + MyApplication* self = MY_APPLICATION(application); + GtkWindow* window = + GTK_WINDOW(gtk_application_window_new(GTK_APPLICATION(application))); + + // Use a header bar when running in GNOME as this is the common style used + // by applications and is the setup most users will be using (e.g. Ubuntu + // desktop). + // If running on X and not using GNOME then just use a traditional title bar + // in case the window manager does more exotic layout, e.g. tiling. + // If running on Wayland assume the header bar will work (may need changing + // if future cases occur). + gboolean use_header_bar = TRUE; +#ifdef GDK_WINDOWING_X11 + GdkScreen* screen = gtk_window_get_screen(window); + if (GDK_IS_X11_SCREEN(screen)) { + const gchar* wm_name = gdk_x11_screen_get_window_manager_name(screen); + if (g_strcmp0(wm_name, "GNOME Shell") != 0) { + use_header_bar = FALSE; + } + } +#endif + if (use_header_bar) { + GtkHeaderBar* header_bar = GTK_HEADER_BAR(gtk_header_bar_new()); + gtk_widget_show(GTK_WIDGET(header_bar)); + gtk_header_bar_set_title(header_bar, "material_editor"); + gtk_header_bar_set_show_close_button(header_bar, TRUE); + gtk_window_set_titlebar(window, GTK_WIDGET(header_bar)); + } else { + gtk_window_set_title(window, "material_editor"); + } + + gtk_window_set_default_size(window, 1280, 720); + + g_autoptr(FlDartProject) project = fl_dart_project_new(); + fl_dart_project_set_dart_entrypoint_arguments( + project, self->dart_entrypoint_arguments); + + FlView* view = fl_view_new(project); + GdkRGBA background_color; + // Background defaults to black, override it here if necessary, e.g. #00000000 + // for transparent. + gdk_rgba_parse(&background_color, "#000000"); + fl_view_set_background_color(view, &background_color); + gtk_widget_show(GTK_WIDGET(view)); + gtk_container_add(GTK_CONTAINER(window), GTK_WIDGET(view)); + + // Show the window when Flutter renders. + // Requires the view to be realized so we can start rendering. + g_signal_connect_swapped(view, "first-frame", G_CALLBACK(first_frame_cb), + self); + gtk_widget_realize(GTK_WIDGET(view)); + + fl_register_plugins(FL_PLUGIN_REGISTRY(view)); + + gtk_widget_grab_focus(GTK_WIDGET(view)); +} + +// Implements GApplication::local_command_line. +static gboolean my_application_local_command_line(GApplication* application, + gchar*** arguments, + int* exit_status) { + MyApplication* self = MY_APPLICATION(application); + // Strip out the first argument as it is the binary name. + self->dart_entrypoint_arguments = g_strdupv(*arguments + 1); + + g_autoptr(GError) error = nullptr; + if (!g_application_register(application, nullptr, &error)) { + g_warning("Failed to register: %s", error->message); + *exit_status = 1; + return TRUE; + } + + g_application_activate(application); + *exit_status = 0; + + return TRUE; +} + +// Implements GApplication::startup. +static void my_application_startup(GApplication* application) { + // MyApplication* self = MY_APPLICATION(object); + + // Perform any actions required at application startup. + + G_APPLICATION_CLASS(my_application_parent_class)->startup(application); +} + +// Implements GApplication::shutdown. +static void my_application_shutdown(GApplication* application) { + // MyApplication* self = MY_APPLICATION(object); + + // Perform any actions required at application shutdown. + + G_APPLICATION_CLASS(my_application_parent_class)->shutdown(application); +} + +// Implements GObject::dispose. +static void my_application_dispose(GObject* object) { + MyApplication* self = MY_APPLICATION(object); + g_clear_pointer(&self->dart_entrypoint_arguments, g_strfreev); + G_OBJECT_CLASS(my_application_parent_class)->dispose(object); +} + +static void my_application_class_init(MyApplicationClass* klass) { + G_APPLICATION_CLASS(klass)->activate = my_application_activate; + G_APPLICATION_CLASS(klass)->local_command_line = + my_application_local_command_line; + G_APPLICATION_CLASS(klass)->startup = my_application_startup; + G_APPLICATION_CLASS(klass)->shutdown = my_application_shutdown; + G_OBJECT_CLASS(klass)->dispose = my_application_dispose; +} + +static void my_application_init(MyApplication* self) {} + +MyApplication* my_application_new() { + // Set the program name to the application ID, which helps various systems + // like GTK and desktop environments map this running application to its + // corresponding .desktop file. This ensures better integration by allowing + // the application to be recognized beyond its binary name. + g_set_prgname(APPLICATION_ID); + + return MY_APPLICATION(g_object_new(my_application_get_type(), + "application-id", APPLICATION_ID, "flags", + G_APPLICATION_NON_UNIQUE, nullptr)); +} diff --git a/examples/flutter/material_editor/linux/runner/my_application.h b/examples/flutter/material_editor/linux/runner/my_application.h new file mode 100644 index 000000000..db16367a7 --- /dev/null +++ b/examples/flutter/material_editor/linux/runner/my_application.h @@ -0,0 +1,21 @@ +#ifndef FLUTTER_MY_APPLICATION_H_ +#define FLUTTER_MY_APPLICATION_H_ + +#include + +G_DECLARE_FINAL_TYPE(MyApplication, + my_application, + MY, + APPLICATION, + GtkApplication) + +/** + * my_application_new: + * + * Creates a new Flutter-based application. + * + * Returns: a new #MyApplication. + */ +MyApplication* my_application_new(); + +#endif // FLUTTER_MY_APPLICATION_H_ diff --git a/examples/flutter/material_editor/macos/.gitignore b/examples/flutter/material_editor/macos/.gitignore new file mode 100644 index 000000000..746adbb6b --- /dev/null +++ b/examples/flutter/material_editor/macos/.gitignore @@ -0,0 +1,7 @@ +# Flutter-related +**/Flutter/ephemeral/ +**/Pods/ + +# Xcode-related +**/dgph +**/xcuserdata/ diff --git a/examples/flutter/material_editor/macos/Flutter/Flutter-Debug.xcconfig b/examples/flutter/material_editor/macos/Flutter/Flutter-Debug.xcconfig new file mode 100644 index 000000000..c2efd0b60 --- /dev/null +++ b/examples/flutter/material_editor/macos/Flutter/Flutter-Debug.xcconfig @@ -0,0 +1 @@ +#include "ephemeral/Flutter-Generated.xcconfig" diff --git a/examples/flutter/material_editor/macos/Flutter/Flutter-Release.xcconfig b/examples/flutter/material_editor/macos/Flutter/Flutter-Release.xcconfig new file mode 100644 index 000000000..c2efd0b60 --- /dev/null +++ b/examples/flutter/material_editor/macos/Flutter/Flutter-Release.xcconfig @@ -0,0 +1 @@ +#include "ephemeral/Flutter-Generated.xcconfig" diff --git a/examples/flutter/material_editor/macos/Flutter/GeneratedPluginRegistrant.swift b/examples/flutter/material_editor/macos/Flutter/GeneratedPluginRegistrant.swift new file mode 100644 index 000000000..b6c27f96f --- /dev/null +++ b/examples/flutter/material_editor/macos/Flutter/GeneratedPluginRegistrant.swift @@ -0,0 +1,12 @@ +// +// Generated file. Do not edit. +// + +import FlutterMacOS +import Foundation + +import thermion_flutter + +func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) { + SwiftThermionFlutterPlugin.register(with: registry.registrar(forPlugin: "SwiftThermionFlutterPlugin")) +} diff --git a/examples/flutter/material_editor/macos/Runner.xcodeproj/project.pbxproj b/examples/flutter/material_editor/macos/Runner.xcodeproj/project.pbxproj new file mode 100644 index 000000000..d1893b00f --- /dev/null +++ b/examples/flutter/material_editor/macos/Runner.xcodeproj/project.pbxproj @@ -0,0 +1,705 @@ +// !$*UTF8*$! +{ + archiveVersion = 1; + classes = { + }; + objectVersion = 54; + objects = { + +/* Begin PBXAggregateTarget section */ + 33CC111A2044C6BA0003C045 /* Flutter Assemble */ = { + isa = PBXAggregateTarget; + buildConfigurationList = 33CC111B2044C6BA0003C045 /* Build configuration list for PBXAggregateTarget "Flutter Assemble" */; + buildPhases = ( + 33CC111E2044C6BF0003C045 /* ShellScript */, + ); + dependencies = ( + ); + name = "Flutter Assemble"; + productName = FLX; + }; +/* End PBXAggregateTarget section */ + +/* Begin PBXBuildFile section */ + 331C80D8294CF71000263BE5 /* RunnerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 331C80D7294CF71000263BE5 /* RunnerTests.swift */; }; + 335BBD1B22A9A15E00E9071D /* GeneratedPluginRegistrant.swift in Sources */ = {isa = PBXBuildFile; fileRef = 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */; }; + 33CC10F12044A3C60003C045 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33CC10F02044A3C60003C045 /* AppDelegate.swift */; }; + 33CC10F32044A3C60003C045 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 33CC10F22044A3C60003C045 /* Assets.xcassets */; }; + 33CC10F62044A3C60003C045 /* MainMenu.xib in Resources */ = {isa = PBXBuildFile; fileRef = 33CC10F42044A3C60003C045 /* MainMenu.xib */; }; + 33CC11132044BFA00003C045 /* MainFlutterWindow.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */; }; +/* End PBXBuildFile section */ + +/* Begin PBXContainerItemProxy section */ + 331C80D9294CF71000263BE5 /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 33CC10E52044A3C60003C045 /* Project object */; + proxyType = 1; + remoteGlobalIDString = 33CC10EC2044A3C60003C045; + remoteInfo = Runner; + }; + 33CC111F2044C79F0003C045 /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 33CC10E52044A3C60003C045 /* Project object */; + proxyType = 1; + remoteGlobalIDString = 33CC111A2044C6BA0003C045; + remoteInfo = FLX; + }; +/* End PBXContainerItemProxy section */ + +/* Begin PBXCopyFilesBuildPhase section */ + 33CC110E2044A8840003C045 /* Bundle Framework */ = { + isa = PBXCopyFilesBuildPhase; + buildActionMask = 2147483647; + dstPath = ""; + dstSubfolderSpec = 10; + files = ( + ); + name = "Bundle Framework"; + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXCopyFilesBuildPhase section */ + +/* Begin PBXFileReference section */ + 331C80D5294CF71000263BE5 /* RunnerTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = RunnerTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; + 331C80D7294CF71000263BE5 /* RunnerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RunnerTests.swift; sourceTree = ""; }; + 333000ED22D3DE5D00554162 /* Warnings.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Warnings.xcconfig; sourceTree = ""; }; + 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = GeneratedPluginRegistrant.swift; sourceTree = ""; }; + 33CC10ED2044A3C60003C045 /* material_editor.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = "material_editor.app"; sourceTree = BUILT_PRODUCTS_DIR; }; + 33CC10F02044A3C60003C045 /* AppDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = ""; }; + 33CC10F22044A3C60003C045 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; name = Assets.xcassets; path = Runner/Assets.xcassets; sourceTree = ""; }; + 33CC10F52044A3C60003C045 /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.xib; name = Base; path = Base.lproj/MainMenu.xib; sourceTree = ""; }; + 33CC10F72044A3C60003C045 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; name = Info.plist; path = Runner/Info.plist; sourceTree = ""; }; + 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MainFlutterWindow.swift; sourceTree = ""; }; + 33CEB47222A05771004F2AC0 /* Flutter-Debug.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = "Flutter-Debug.xcconfig"; sourceTree = ""; }; + 33CEB47422A05771004F2AC0 /* Flutter-Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = "Flutter-Release.xcconfig"; sourceTree = ""; }; + 33CEB47722A0578A004F2AC0 /* Flutter-Generated.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; name = "Flutter-Generated.xcconfig"; path = "ephemeral/Flutter-Generated.xcconfig"; sourceTree = ""; }; + 33E51913231747F40026EE4D /* DebugProfile.entitlements */ = {isa = PBXFileReference; lastKnownFileType = text.plist.entitlements; path = DebugProfile.entitlements; sourceTree = ""; }; + 33E51914231749380026EE4D /* Release.entitlements */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.entitlements; path = Release.entitlements; sourceTree = ""; }; + 33E5194F232828860026EE4D /* AppInfo.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = AppInfo.xcconfig; sourceTree = ""; }; + 7AFA3C8E1D35360C0083082E /* Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Release.xcconfig; sourceTree = ""; }; + 9740EEB21CF90195004384FC /* Debug.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; path = Debug.xcconfig; sourceTree = ""; }; +/* End PBXFileReference section */ + +/* Begin PBXFrameworksBuildPhase section */ + 331C80D2294CF70F00263BE5 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 33CC10EA2044A3C60003C045 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXFrameworksBuildPhase section */ + +/* Begin PBXGroup section */ + 331C80D6294CF71000263BE5 /* RunnerTests */ = { + isa = PBXGroup; + children = ( + 331C80D7294CF71000263BE5 /* RunnerTests.swift */, + ); + path = RunnerTests; + sourceTree = ""; + }; + 33BA886A226E78AF003329D5 /* Configs */ = { + isa = PBXGroup; + children = ( + 33E5194F232828860026EE4D /* AppInfo.xcconfig */, + 9740EEB21CF90195004384FC /* Debug.xcconfig */, + 7AFA3C8E1D35360C0083082E /* Release.xcconfig */, + 333000ED22D3DE5D00554162 /* Warnings.xcconfig */, + ); + path = Configs; + sourceTree = ""; + }; + 33CC10E42044A3C60003C045 = { + isa = PBXGroup; + children = ( + 33FAB671232836740065AC1E /* Runner */, + 33CEB47122A05771004F2AC0 /* Flutter */, + 331C80D6294CF71000263BE5 /* RunnerTests */, + 33CC10EE2044A3C60003C045 /* Products */, + D73912EC22F37F3D000D13A0 /* Frameworks */, + ); + sourceTree = ""; + }; + 33CC10EE2044A3C60003C045 /* Products */ = { + isa = PBXGroup; + children = ( + 33CC10ED2044A3C60003C045 /* material_editor.app */, + 331C80D5294CF71000263BE5 /* RunnerTests.xctest */, + ); + name = Products; + sourceTree = ""; + }; + 33CC11242044D66E0003C045 /* Resources */ = { + isa = PBXGroup; + children = ( + 33CC10F22044A3C60003C045 /* Assets.xcassets */, + 33CC10F42044A3C60003C045 /* MainMenu.xib */, + 33CC10F72044A3C60003C045 /* Info.plist */, + ); + name = Resources; + path = ..; + sourceTree = ""; + }; + 33CEB47122A05771004F2AC0 /* Flutter */ = { + isa = PBXGroup; + children = ( + 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */, + 33CEB47222A05771004F2AC0 /* Flutter-Debug.xcconfig */, + 33CEB47422A05771004F2AC0 /* Flutter-Release.xcconfig */, + 33CEB47722A0578A004F2AC0 /* Flutter-Generated.xcconfig */, + ); + path = Flutter; + sourceTree = ""; + }; + 33FAB671232836740065AC1E /* Runner */ = { + isa = PBXGroup; + children = ( + 33CC10F02044A3C60003C045 /* AppDelegate.swift */, + 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */, + 33E51913231747F40026EE4D /* DebugProfile.entitlements */, + 33E51914231749380026EE4D /* Release.entitlements */, + 33CC11242044D66E0003C045 /* Resources */, + 33BA886A226E78AF003329D5 /* Configs */, + ); + path = Runner; + sourceTree = ""; + }; + D73912EC22F37F3D000D13A0 /* Frameworks */ = { + isa = PBXGroup; + children = ( + ); + name = Frameworks; + sourceTree = ""; + }; +/* End PBXGroup section */ + +/* Begin PBXNativeTarget section */ + 331C80D4294CF70F00263BE5 /* RunnerTests */ = { + isa = PBXNativeTarget; + buildConfigurationList = 331C80DE294CF71000263BE5 /* Build configuration list for PBXNativeTarget "RunnerTests" */; + buildPhases = ( + 331C80D1294CF70F00263BE5 /* Sources */, + 331C80D2294CF70F00263BE5 /* Frameworks */, + 331C80D3294CF70F00263BE5 /* Resources */, + ); + buildRules = ( + ); + dependencies = ( + 331C80DA294CF71000263BE5 /* PBXTargetDependency */, + ); + name = RunnerTests; + productName = RunnerTests; + productReference = 331C80D5294CF71000263BE5 /* RunnerTests.xctest */; + productType = "com.apple.product-type.bundle.unit-test"; + }; + 33CC10EC2044A3C60003C045 /* Runner */ = { + isa = PBXNativeTarget; + buildConfigurationList = 33CC10FB2044A3C60003C045 /* Build configuration list for PBXNativeTarget "Runner" */; + buildPhases = ( + 33CC10E92044A3C60003C045 /* Sources */, + 33CC10EA2044A3C60003C045 /* Frameworks */, + 33CC10EB2044A3C60003C045 /* Resources */, + 33CC110E2044A8840003C045 /* Bundle Framework */, + 3399D490228B24CF009A79C7 /* ShellScript */, + ); + buildRules = ( + ); + dependencies = ( + 33CC11202044C79F0003C045 /* PBXTargetDependency */, + ); + name = Runner; + productName = Runner; + productReference = 33CC10ED2044A3C60003C045 /* material_editor.app */; + productType = "com.apple.product-type.application"; + }; +/* End PBXNativeTarget section */ + +/* Begin PBXProject section */ + 33CC10E52044A3C60003C045 /* Project object */ = { + isa = PBXProject; + attributes = { + BuildIndependentTargetsInParallel = YES; + LastSwiftUpdateCheck = 0920; + LastUpgradeCheck = 1510; + ORGANIZATIONNAME = ""; + TargetAttributes = { + 331C80D4294CF70F00263BE5 = { + CreatedOnToolsVersion = 14.0; + TestTargetID = 33CC10EC2044A3C60003C045; + }; + 33CC10EC2044A3C60003C045 = { + CreatedOnToolsVersion = 9.2; + LastSwiftMigration = 1100; + ProvisioningStyle = Automatic; + SystemCapabilities = { + com.apple.Sandbox = { + enabled = 1; + }; + }; + }; + 33CC111A2044C6BA0003C045 = { + CreatedOnToolsVersion = 9.2; + ProvisioningStyle = Manual; + }; + }; + }; + buildConfigurationList = 33CC10E82044A3C60003C045 /* Build configuration list for PBXProject "Runner" */; + compatibilityVersion = "Xcode 9.3"; + developmentRegion = en; + hasScannedForEncodings = 0; + knownRegions = ( + en, + Base, + ); + mainGroup = 33CC10E42044A3C60003C045; + productRefGroup = 33CC10EE2044A3C60003C045 /* Products */; + projectDirPath = ""; + projectRoot = ""; + targets = ( + 33CC10EC2044A3C60003C045 /* Runner */, + 331C80D4294CF70F00263BE5 /* RunnerTests */, + 33CC111A2044C6BA0003C045 /* Flutter Assemble */, + ); + }; +/* End PBXProject section */ + +/* Begin PBXResourcesBuildPhase section */ + 331C80D3294CF70F00263BE5 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 33CC10EB2044A3C60003C045 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 33CC10F32044A3C60003C045 /* Assets.xcassets in Resources */, + 33CC10F62044A3C60003C045 /* MainMenu.xib in Resources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXResourcesBuildPhase section */ + +/* Begin PBXShellScriptBuildPhase section */ + 3399D490228B24CF009A79C7 /* ShellScript */ = { + isa = PBXShellScriptBuildPhase; + alwaysOutOfDate = 1; + buildActionMask = 2147483647; + files = ( + ); + inputFileListPaths = ( + ); + inputPaths = ( + ); + outputFileListPaths = ( + ); + outputPaths = ( + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "echo \"$PRODUCT_NAME.app\" > \"$PROJECT_DIR\"/Flutter/ephemeral/.app_filename && \"$FLUTTER_ROOT\"/packages/flutter_tools/bin/macos_assemble.sh embed\n"; + }; + 33CC111E2044C6BF0003C045 /* ShellScript */ = { + isa = PBXShellScriptBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + inputFileListPaths = ( + Flutter/ephemeral/FlutterInputs.xcfilelist, + ); + inputPaths = ( + Flutter/ephemeral/tripwire, + ); + outputFileListPaths = ( + Flutter/ephemeral/FlutterOutputs.xcfilelist, + ); + outputPaths = ( + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "\"$FLUTTER_ROOT\"/packages/flutter_tools/bin/macos_assemble.sh && touch Flutter/ephemeral/tripwire"; + }; +/* End PBXShellScriptBuildPhase section */ + +/* Begin PBXSourcesBuildPhase section */ + 331C80D1294CF70F00263BE5 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 331C80D8294CF71000263BE5 /* RunnerTests.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 33CC10E92044A3C60003C045 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 33CC11132044BFA00003C045 /* MainFlutterWindow.swift in Sources */, + 33CC10F12044A3C60003C045 /* AppDelegate.swift in Sources */, + 335BBD1B22A9A15E00E9071D /* GeneratedPluginRegistrant.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXSourcesBuildPhase section */ + +/* Begin PBXTargetDependency section */ + 331C80DA294CF71000263BE5 /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 33CC10EC2044A3C60003C045 /* Runner */; + targetProxy = 331C80D9294CF71000263BE5 /* PBXContainerItemProxy */; + }; + 33CC11202044C79F0003C045 /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 33CC111A2044C6BA0003C045 /* Flutter Assemble */; + targetProxy = 33CC111F2044C79F0003C045 /* PBXContainerItemProxy */; + }; +/* End PBXTargetDependency section */ + +/* Begin PBXVariantGroup section */ + 33CC10F42044A3C60003C045 /* MainMenu.xib */ = { + isa = PBXVariantGroup; + children = ( + 33CC10F52044A3C60003C045 /* Base */, + ); + name = MainMenu.xib; + path = Runner; + sourceTree = ""; + }; +/* End PBXVariantGroup section */ + +/* Begin XCBuildConfiguration section */ + 331C80DB294CF71000263BE5 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.avinium.materialEditor.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/material_editor.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/material_editor"; + }; + name = Debug; + }; + 331C80DC294CF71000263BE5 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.avinium.materialEditor.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/material_editor.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/material_editor"; + }; + name = Release; + }; + 331C80DD294CF71000263BE5 /* Profile */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.avinium.materialEditor.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/material_editor.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/material_editor"; + }; + name = Profile; + }; + 338D0CE9231458BD00FA5F75 /* Profile */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CODE_SIGN_IDENTITY = "-"; + COPY_PHASE_STRIP = NO; + DEAD_CODE_STRIPPING = YES; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; + GCC_C_LANGUAGE_STANDARD = gnu11; + GCC_NO_COMMON_BLOCKS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + MACOSX_DEPLOYMENT_TARGET = 10.15; + MTL_ENABLE_DEBUG_INFO = NO; + SDKROOT = macosx; + SWIFT_COMPILATION_MODE = wholemodule; + SWIFT_OPTIMIZATION_LEVEL = "-O"; + }; + name = Profile; + }; + 338D0CEA231458BD00FA5F75 /* Profile */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 33E5194F232828860026EE4D /* AppInfo.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CODE_SIGN_ENTITLEMENTS = Runner/DebugProfile.entitlements; + CODE_SIGN_STYLE = Automatic; + COMBINE_HIDPI_IMAGES = YES; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/../Frameworks", + ); + PROVISIONING_PROFILE_SPECIFIER = ""; + SWIFT_VERSION = 5.0; + }; + name = Profile; + }; + 338D0CEB231458BD00FA5F75 /* Profile */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Manual; + PRODUCT_NAME = "$(TARGET_NAME)"; + }; + name = Profile; + }; + 33CC10F92044A3C60003C045 /* Debug */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 9740EEB21CF90195004384FC /* Debug.xcconfig */; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CODE_SIGN_IDENTITY = "-"; + COPY_PHASE_STRIP = NO; + DEAD_CODE_STRIPPING = YES; + DEBUG_INFORMATION_FORMAT = dwarf; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_TESTABILITY = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; + GCC_C_LANGUAGE_STANDARD = gnu11; + GCC_DYNAMIC_NO_PIC = NO; + GCC_NO_COMMON_BLOCKS = YES; + GCC_OPTIMIZATION_LEVEL = 0; + GCC_PREPROCESSOR_DEFINITIONS = ( + "DEBUG=1", + "$(inherited)", + ); + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + MACOSX_DEPLOYMENT_TARGET = 10.15; + MTL_ENABLE_DEBUG_INFO = YES; + ONLY_ACTIVE_ARCH = YES; + SDKROOT = macosx; + SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + }; + name = Debug; + }; + 33CC10FA2044A3C60003C045 /* Release */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CODE_SIGN_IDENTITY = "-"; + COPY_PHASE_STRIP = NO; + DEAD_CODE_STRIPPING = YES; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; + GCC_C_LANGUAGE_STANDARD = gnu11; + GCC_NO_COMMON_BLOCKS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + MACOSX_DEPLOYMENT_TARGET = 10.15; + MTL_ENABLE_DEBUG_INFO = NO; + SDKROOT = macosx; + SWIFT_COMPILATION_MODE = wholemodule; + SWIFT_OPTIMIZATION_LEVEL = "-O"; + }; + name = Release; + }; + 33CC10FC2044A3C60003C045 /* Debug */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 33E5194F232828860026EE4D /* AppInfo.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CODE_SIGN_ENTITLEMENTS = Runner/DebugProfile.entitlements; + CODE_SIGN_STYLE = Automatic; + COMBINE_HIDPI_IMAGES = YES; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/../Frameworks", + ); + PROVISIONING_PROFILE_SPECIFIER = ""; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + SWIFT_VERSION = 5.0; + }; + name = Debug; + }; + 33CC10FD2044A3C60003C045 /* Release */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 33E5194F232828860026EE4D /* AppInfo.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CODE_SIGN_ENTITLEMENTS = Runner/Release.entitlements; + CODE_SIGN_STYLE = Automatic; + COMBINE_HIDPI_IMAGES = YES; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/../Frameworks", + ); + PROVISIONING_PROFILE_SPECIFIER = ""; + SWIFT_VERSION = 5.0; + }; + name = Release; + }; + 33CC111C2044C6BA0003C045 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Manual; + PRODUCT_NAME = "$(TARGET_NAME)"; + }; + name = Debug; + }; + 33CC111D2044C6BA0003C045 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Automatic; + PRODUCT_NAME = "$(TARGET_NAME)"; + }; + name = Release; + }; +/* End XCBuildConfiguration section */ + +/* Begin XCConfigurationList section */ + 331C80DE294CF71000263BE5 /* Build configuration list for PBXNativeTarget "RunnerTests" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 331C80DB294CF71000263BE5 /* Debug */, + 331C80DC294CF71000263BE5 /* Release */, + 331C80DD294CF71000263BE5 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 33CC10E82044A3C60003C045 /* Build configuration list for PBXProject "Runner" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 33CC10F92044A3C60003C045 /* Debug */, + 33CC10FA2044A3C60003C045 /* Release */, + 338D0CE9231458BD00FA5F75 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 33CC10FB2044A3C60003C045 /* Build configuration list for PBXNativeTarget "Runner" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 33CC10FC2044A3C60003C045 /* Debug */, + 33CC10FD2044A3C60003C045 /* Release */, + 338D0CEA231458BD00FA5F75 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 33CC111B2044C6BA0003C045 /* Build configuration list for PBXAggregateTarget "Flutter Assemble" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 33CC111C2044C6BA0003C045 /* Debug */, + 33CC111D2044C6BA0003C045 /* Release */, + 338D0CEB231458BD00FA5F75 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; +/* End XCConfigurationList section */ + }; + rootObject = 33CC10E52044A3C60003C045 /* Project object */; +} diff --git a/examples/flutter/material_editor/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/examples/flutter/material_editor/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 000000000..18d981003 --- /dev/null +++ b/examples/flutter/material_editor/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/examples/flutter/material_editor/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/examples/flutter/material_editor/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme new file mode 100644 index 000000000..c8f3d471a --- /dev/null +++ b/examples/flutter/material_editor/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme @@ -0,0 +1,99 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/examples/flutter/material_editor/macos/Runner.xcworkspace/contents.xcworkspacedata b/examples/flutter/material_editor/macos/Runner.xcworkspace/contents.xcworkspacedata new file mode 100644 index 000000000..1d526a16e --- /dev/null +++ b/examples/flutter/material_editor/macos/Runner.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,7 @@ + + + + + diff --git a/examples/flutter/material_editor/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/examples/flutter/material_editor/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 000000000..18d981003 --- /dev/null +++ b/examples/flutter/material_editor/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/examples/flutter/material_editor/macos/Runner/AppDelegate.swift b/examples/flutter/material_editor/macos/Runner/AppDelegate.swift new file mode 100644 index 000000000..b3c176141 --- /dev/null +++ b/examples/flutter/material_editor/macos/Runner/AppDelegate.swift @@ -0,0 +1,13 @@ +import Cocoa +import FlutterMacOS + +@main +class AppDelegate: FlutterAppDelegate { + override func applicationShouldTerminateAfterLastWindowClosed(_ sender: NSApplication) -> Bool { + return true + } + + override func applicationSupportsSecureRestorableState(_ app: NSApplication) -> Bool { + return true + } +} diff --git a/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json b/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json new file mode 100644 index 000000000..a2ec33f19 --- /dev/null +++ b/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json @@ -0,0 +1,68 @@ +{ + "images" : [ + { + "size" : "16x16", + "idiom" : "mac", + "filename" : "app_icon_16.png", + "scale" : "1x" + }, + { + "size" : "16x16", + "idiom" : "mac", + "filename" : "app_icon_32.png", + "scale" : "2x" + }, + { + "size" : "32x32", + "idiom" : "mac", + "filename" : "app_icon_32.png", + "scale" : "1x" + }, + { + "size" : "32x32", + "idiom" : "mac", + "filename" : "app_icon_64.png", + "scale" : "2x" + }, + { + "size" : "128x128", + "idiom" : "mac", + "filename" : "app_icon_128.png", + "scale" : "1x" + }, + { + "size" : "128x128", + "idiom" : "mac", + "filename" : "app_icon_256.png", + "scale" : "2x" + }, + { + "size" : "256x256", + "idiom" : "mac", + "filename" : "app_icon_256.png", + "scale" : "1x" + }, + { + "size" : "256x256", + "idiom" : "mac", + "filename" : "app_icon_512.png", + "scale" : "2x" + }, + { + "size" : "512x512", + "idiom" : "mac", + "filename" : "app_icon_512.png", + "scale" : "1x" + }, + { + "size" : "512x512", + "idiom" : "mac", + "filename" : "app_icon_1024.png", + "scale" : "2x" + } + ], + "info" : { + "version" : 1, + "author" : "xcode" + } +} diff --git a/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png b/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png new file mode 100644 index 000000000..82b6f9d9a Binary files /dev/null and b/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png differ diff --git a/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png b/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png new file mode 100644 index 000000000..13b35eba5 Binary files /dev/null and b/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png differ diff --git a/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png b/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png new file mode 100644 index 000000000..0a3f5fa40 Binary files /dev/null and b/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png differ diff --git a/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png b/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png new file mode 100644 index 000000000..bdb57226d Binary files /dev/null and b/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png differ diff --git a/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png b/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png new file mode 100644 index 000000000..f083318e0 Binary files /dev/null and b/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png differ diff --git a/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png b/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png new file mode 100644 index 000000000..326c0e72c Binary files /dev/null and b/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png differ diff --git a/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png b/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png new file mode 100644 index 000000000..2f1632cfd Binary files /dev/null and b/examples/flutter/material_editor/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png differ diff --git a/examples/flutter/material_editor/macos/Runner/Base.lproj/MainMenu.xib b/examples/flutter/material_editor/macos/Runner/Base.lproj/MainMenu.xib new file mode 100644 index 000000000..80e867a4e --- /dev/null +++ b/examples/flutter/material_editor/macos/Runner/Base.lproj/MainMenu.xib @@ -0,0 +1,343 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/examples/flutter/material_editor/macos/Runner/Configs/AppInfo.xcconfig b/examples/flutter/material_editor/macos/Runner/Configs/AppInfo.xcconfig new file mode 100644 index 000000000..2b74521a6 --- /dev/null +++ b/examples/flutter/material_editor/macos/Runner/Configs/AppInfo.xcconfig @@ -0,0 +1,14 @@ +// Application-level settings for the Runner target. +// +// This may be replaced with something auto-generated from metadata (e.g., pubspec.yaml) in the +// future. If not, the values below would default to using the project name when this becomes a +// 'flutter create' template. + +// The application's name. By default this is also the title of the Flutter window. +PRODUCT_NAME = material_editor + +// The application's bundle identifier +PRODUCT_BUNDLE_IDENTIFIER = com.avinium.materialEditor + +// The copyright displayed in application information +PRODUCT_COPYRIGHT = Copyright © 2026 com.avinium. All rights reserved. diff --git a/examples/flutter/material_editor/macos/Runner/Configs/Debug.xcconfig b/examples/flutter/material_editor/macos/Runner/Configs/Debug.xcconfig new file mode 100644 index 000000000..36b0fd946 --- /dev/null +++ b/examples/flutter/material_editor/macos/Runner/Configs/Debug.xcconfig @@ -0,0 +1,2 @@ +#include "../../Flutter/Flutter-Debug.xcconfig" +#include "Warnings.xcconfig" diff --git a/examples/flutter/material_editor/macos/Runner/Configs/Release.xcconfig b/examples/flutter/material_editor/macos/Runner/Configs/Release.xcconfig new file mode 100644 index 000000000..dff4f4956 --- /dev/null +++ b/examples/flutter/material_editor/macos/Runner/Configs/Release.xcconfig @@ -0,0 +1,2 @@ +#include "../../Flutter/Flutter-Release.xcconfig" +#include "Warnings.xcconfig" diff --git a/examples/flutter/material_editor/macos/Runner/Configs/Warnings.xcconfig b/examples/flutter/material_editor/macos/Runner/Configs/Warnings.xcconfig new file mode 100644 index 000000000..42bcbf478 --- /dev/null +++ b/examples/flutter/material_editor/macos/Runner/Configs/Warnings.xcconfig @@ -0,0 +1,13 @@ +WARNING_CFLAGS = -Wall -Wconditional-uninitialized -Wnullable-to-nonnull-conversion -Wmissing-method-return-type -Woverlength-strings +GCC_WARN_UNDECLARED_SELECTOR = YES +CLANG_UNDEFINED_BEHAVIOR_SANITIZER_NULLABILITY = YES +CLANG_WARN_UNGUARDED_AVAILABILITY = YES_AGGRESSIVE +CLANG_WARN__DUPLICATE_METHOD_MATCH = YES +CLANG_WARN_PRAGMA_PACK = YES +CLANG_WARN_STRICT_PROTOTYPES = YES +CLANG_WARN_COMMA = YES +GCC_WARN_STRICT_SELECTOR_MATCH = YES +CLANG_WARN_OBJC_REPEATED_USE_OF_WEAK = YES +CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES +GCC_WARN_SHADOW = YES +CLANG_WARN_UNREACHABLE_CODE = YES diff --git a/examples/flutter/material_editor/macos/Runner/DebugProfile.entitlements b/examples/flutter/material_editor/macos/Runner/DebugProfile.entitlements new file mode 100644 index 000000000..dddb8a30c --- /dev/null +++ b/examples/flutter/material_editor/macos/Runner/DebugProfile.entitlements @@ -0,0 +1,12 @@ + + + + + com.apple.security.app-sandbox + + com.apple.security.cs.allow-jit + + com.apple.security.network.server + + + diff --git a/examples/flutter/material_editor/macos/Runner/Info.plist b/examples/flutter/material_editor/macos/Runner/Info.plist new file mode 100644 index 000000000..4789daa6a --- /dev/null +++ b/examples/flutter/material_editor/macos/Runner/Info.plist @@ -0,0 +1,32 @@ + + + + + CFBundleDevelopmentRegion + $(DEVELOPMENT_LANGUAGE) + CFBundleExecutable + $(EXECUTABLE_NAME) + CFBundleIconFile + + CFBundleIdentifier + $(PRODUCT_BUNDLE_IDENTIFIER) + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + $(PRODUCT_NAME) + CFBundlePackageType + APPL + CFBundleShortVersionString + $(FLUTTER_BUILD_NAME) + CFBundleVersion + $(FLUTTER_BUILD_NUMBER) + LSMinimumSystemVersion + $(MACOSX_DEPLOYMENT_TARGET) + NSHumanReadableCopyright + $(PRODUCT_COPYRIGHT) + NSMainNibFile + MainMenu + NSPrincipalClass + NSApplication + + diff --git a/examples/flutter/material_editor/macos/Runner/MainFlutterWindow.swift b/examples/flutter/material_editor/macos/Runner/MainFlutterWindow.swift new file mode 100644 index 000000000..3cc05eb23 --- /dev/null +++ b/examples/flutter/material_editor/macos/Runner/MainFlutterWindow.swift @@ -0,0 +1,15 @@ +import Cocoa +import FlutterMacOS + +class MainFlutterWindow: NSWindow { + override func awakeFromNib() { + let flutterViewController = FlutterViewController() + let windowFrame = self.frame + self.contentViewController = flutterViewController + self.setFrame(windowFrame, display: true) + + RegisterGeneratedPlugins(registry: flutterViewController) + + super.awakeFromNib() + } +} diff --git a/examples/flutter/material_editor/macos/Runner/Release.entitlements b/examples/flutter/material_editor/macos/Runner/Release.entitlements new file mode 100644 index 000000000..852fa1a47 --- /dev/null +++ b/examples/flutter/material_editor/macos/Runner/Release.entitlements @@ -0,0 +1,8 @@ + + + + + com.apple.security.app-sandbox + + + diff --git a/examples/flutter/material_editor/macos/RunnerTests/RunnerTests.swift b/examples/flutter/material_editor/macos/RunnerTests/RunnerTests.swift new file mode 100644 index 000000000..61f3bd1fc --- /dev/null +++ b/examples/flutter/material_editor/macos/RunnerTests/RunnerTests.swift @@ -0,0 +1,12 @@ +import Cocoa +import FlutterMacOS +import XCTest + +class RunnerTests: XCTestCase { + + func testExample() { + // If you add code to the Runner application, consider adding tests here. + // See https://developer.apple.com/documentation/xctest for more information about using XCTest. + } + +} diff --git a/examples/flutter/material_editor/materials/starter.mat b/examples/flutter/material_editor/materials/starter.mat new file mode 100644 index 000000000..07cb8d066 --- /dev/null +++ b/examples/flutter/material_editor/materials/starter.mat @@ -0,0 +1,37 @@ +material { + name : "Editor Starter", + requires : [ position, uv0 ], + parameters : [ + { + type : float4, + name : baseTint + }, + { + type : float, + name : roughness + }, + { + type : float, + name : metallic + } + ], + shadingModel : lit, + blending : opaque, + culling : back, + depthWrite : true, + depthCulling : true +} + +// The fragment shader runs for every pixel of the sphere. Everything set on +// `material` here becomes the surface's appearance: baseColor, roughness and +// metallic drive the standard lit model (see Filament's Materials doc for the +// full set of inputs). `materialParams` exposes the parameters declared above; +// the app sets their values on the material instance. +fragment { + void material(inout MaterialInputs material) { + prepareMaterial(material); + material.baseColor = materialParams.baseTint; + material.roughness = materialParams.roughness; + material.metallic = materialParams.metallic; + } +} diff --git a/examples/flutter/material_editor/pubspec.yaml b/examples/flutter/material_editor/pubspec.yaml new file mode 100644 index 000000000..a14cb8e15 --- /dev/null +++ b/examples/flutter/material_editor/pubspec.yaml @@ -0,0 +1,31 @@ +name: material_editor +description: "Live Filament material editor: edit .mat source and hot-swap it onto a renderable at runtime." +publish_to: 'none' + +version: 1.0.0+1 + +environment: + sdk: '>=3.3.0 <4.0.0' + +dependencies: + flutter: + sdk: flutter + logging: ^1.2.0 + vector_math: ^2.1.4 + thermion_flutter: ^0.2.1-dev.7 + +dependency_overrides: + thermion_dart: + path: ../../../thermion_dart + thermion_flutter: + path: ../../../thermion_flutter/thermion_flutter + +dev_dependencies: + flutter_test: + sdk: flutter + flutter_lints: ^4.0.0 + +flutter: + uses-material-design: true + assets: + - materials/ diff --git a/examples/flutter/material_editor/windows/.gitignore b/examples/flutter/material_editor/windows/.gitignore new file mode 100644 index 000000000..d492d0d98 --- /dev/null +++ b/examples/flutter/material_editor/windows/.gitignore @@ -0,0 +1,17 @@ +flutter/ephemeral/ + +# Visual Studio user-specific files. +*.suo +*.user +*.userosscache +*.sln.docstates + +# Visual Studio build-related files. +x64/ +x86/ + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ diff --git a/examples/flutter/material_editor/windows/CMakeLists.txt b/examples/flutter/material_editor/windows/CMakeLists.txt new file mode 100644 index 000000000..a2cd18039 --- /dev/null +++ b/examples/flutter/material_editor/windows/CMakeLists.txt @@ -0,0 +1,108 @@ +# Project-level configuration. +cmake_minimum_required(VERSION 3.14) +project(material_editor LANGUAGES CXX) + +# The name of the executable created for the application. Change this to change +# the on-disk name of your application. +set(BINARY_NAME "material_editor") + +# Explicitly opt in to modern CMake behaviors to avoid warnings with recent +# versions of CMake. +cmake_policy(VERSION 3.14...3.25) + +# Define build configuration option. +get_property(IS_MULTICONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG) +if(IS_MULTICONFIG) + set(CMAKE_CONFIGURATION_TYPES "Debug;Profile;Release" + CACHE STRING "" FORCE) +else() + if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE "Debug" CACHE + STRING "Flutter build mode" FORCE) + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS + "Debug" "Profile" "Release") + endif() +endif() +# Define settings for the Profile build mode. +set(CMAKE_EXE_LINKER_FLAGS_PROFILE "${CMAKE_EXE_LINKER_FLAGS_RELEASE}") +set(CMAKE_SHARED_LINKER_FLAGS_PROFILE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE}") +set(CMAKE_C_FLAGS_PROFILE "${CMAKE_C_FLAGS_RELEASE}") +set(CMAKE_CXX_FLAGS_PROFILE "${CMAKE_CXX_FLAGS_RELEASE}") + +# Use Unicode for all projects. +add_definitions(-DUNICODE -D_UNICODE) + +# Compilation settings that should be applied to most targets. +# +# Be cautious about adding new options here, as plugins use this function by +# default. In most cases, you should add new options to specific targets instead +# of modifying this function. +function(APPLY_STANDARD_SETTINGS TARGET) + target_compile_features(${TARGET} PUBLIC cxx_std_17) + target_compile_options(${TARGET} PRIVATE /W4 /WX /wd"4100") + target_compile_options(${TARGET} PRIVATE /EHsc) + target_compile_definitions(${TARGET} PRIVATE "_HAS_EXCEPTIONS=0") + target_compile_definitions(${TARGET} PRIVATE "$<$:_DEBUG>") +endfunction() + +# Flutter library and tool build rules. +set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") +add_subdirectory(${FLUTTER_MANAGED_DIR}) + +# Application build; see runner/CMakeLists.txt. +add_subdirectory("runner") + + +# Generated plugin build rules, which manage building the plugins and adding +# them to the application. +include(flutter/generated_plugins.cmake) + + +# === Installation === +# Support files are copied into place next to the executable, so that it can +# run in place. This is done instead of making a separate bundle (as on Linux) +# so that building and running from within Visual Studio will work. +set(BUILD_BUNDLE_DIR "$") +# Make the "install" step default, as it's required to run. +set(CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD 1) +if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) +endif() + +set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") +set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}") + +install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +if(PLUGIN_BUNDLED_LIBRARIES) + install(FILES "${PLUGIN_BUNDLED_LIBRARIES}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endif() + +# Copy the native assets provided by the build.dart from all packages. +set(NATIVE_ASSETS_DIR "${PROJECT_BUILD_DIR}native_assets/windows/") +install(DIRECTORY "${NATIVE_ASSETS_DIR}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +# Fully re-copy the assets directory on each build to avoid having stale files +# from a previous install. +set(FLUTTER_ASSET_DIR_NAME "flutter_assets") +install(CODE " + file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") + " COMPONENT Runtime) +install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" + DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) + +# Install the AOT library on non-Debug builds only. +install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + CONFIGURATIONS Profile;Release + COMPONENT Runtime) diff --git a/examples/flutter/material_editor/windows/flutter/CMakeLists.txt b/examples/flutter/material_editor/windows/flutter/CMakeLists.txt new file mode 100644 index 000000000..903f4899d --- /dev/null +++ b/examples/flutter/material_editor/windows/flutter/CMakeLists.txt @@ -0,0 +1,109 @@ +# This file controls Flutter-level build steps. It should not be edited. +cmake_minimum_required(VERSION 3.14) + +set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") + +# Configuration provided via flutter tool. +include(${EPHEMERAL_DIR}/generated_config.cmake) + +# TODO: Move the rest of this into files in ephemeral. See +# https://github.com/flutter/flutter/issues/57146. +set(WRAPPER_ROOT "${EPHEMERAL_DIR}/cpp_client_wrapper") + +# Set fallback configurations for older versions of the flutter tool. +if (NOT DEFINED FLUTTER_TARGET_PLATFORM) + set(FLUTTER_TARGET_PLATFORM "windows-x64") +endif() + +# === Flutter Library === +set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/flutter_windows.dll") + +# Published to parent scope for install step. +set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) +set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) +set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) +set(AOT_LIBRARY "${PROJECT_DIR}/build/windows/app.so" PARENT_SCOPE) + +list(APPEND FLUTTER_LIBRARY_HEADERS + "flutter_export.h" + "flutter_windows.h" + "flutter_messenger.h" + "flutter_plugin_registrar.h" + "flutter_texture_registrar.h" +) +list(TRANSFORM FLUTTER_LIBRARY_HEADERS PREPEND "${EPHEMERAL_DIR}/") +add_library(flutter INTERFACE) +target_include_directories(flutter INTERFACE + "${EPHEMERAL_DIR}" +) +target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}.lib") +add_dependencies(flutter flutter_assemble) + +# === Wrapper === +list(APPEND CPP_WRAPPER_SOURCES_CORE + "core_implementations.cc" + "standard_codec.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_CORE PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_PLUGIN + "plugin_registrar.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_PLUGIN PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_APP + "flutter_engine.cc" + "flutter_view_controller.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_APP PREPEND "${WRAPPER_ROOT}/") + +# Wrapper sources needed for a plugin. +add_library(flutter_wrapper_plugin STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} +) +apply_standard_settings(flutter_wrapper_plugin) +set_target_properties(flutter_wrapper_plugin PROPERTIES + POSITION_INDEPENDENT_CODE ON) +set_target_properties(flutter_wrapper_plugin PROPERTIES + CXX_VISIBILITY_PRESET hidden) +target_link_libraries(flutter_wrapper_plugin PUBLIC flutter) +target_include_directories(flutter_wrapper_plugin PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_plugin flutter_assemble) + +# Wrapper sources needed for the runner. +add_library(flutter_wrapper_app STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_APP} +) +apply_standard_settings(flutter_wrapper_app) +target_link_libraries(flutter_wrapper_app PUBLIC flutter) +target_include_directories(flutter_wrapper_app PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_app flutter_assemble) + +# === Flutter tool backend === +# _phony_ is a non-existent file to force this command to run every time, +# since currently there's no way to get a full input/output list from the +# flutter tool. +set(PHONY_OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/_phony_") +set_source_files_properties("${PHONY_OUTPUT}" PROPERTIES SYMBOLIC TRUE) +add_custom_command( + OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} + ${PHONY_OUTPUT} + COMMAND ${CMAKE_COMMAND} -E env + ${FLUTTER_TOOL_ENVIRONMENT} + "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.bat" + ${FLUTTER_TARGET_PLATFORM} $ + VERBATIM +) +add_custom_target(flutter_assemble DEPENDS + "${FLUTTER_LIBRARY}" + ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} +) diff --git a/examples/flutter/material_editor/windows/flutter/generated_plugin_registrant.cc b/examples/flutter/material_editor/windows/flutter/generated_plugin_registrant.cc new file mode 100644 index 000000000..64919ad28 --- /dev/null +++ b/examples/flutter/material_editor/windows/flutter/generated_plugin_registrant.cc @@ -0,0 +1,14 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#include "generated_plugin_registrant.h" + +#include + +void RegisterPlugins(flutter::PluginRegistry* registry) { + ThermionFlutterPluginCApiRegisterWithRegistrar( + registry->GetRegistrarForPlugin("ThermionFlutterPluginCApi")); +} diff --git a/examples/flutter/material_editor/windows/flutter/generated_plugin_registrant.h b/examples/flutter/material_editor/windows/flutter/generated_plugin_registrant.h new file mode 100644 index 000000000..dc139d85a --- /dev/null +++ b/examples/flutter/material_editor/windows/flutter/generated_plugin_registrant.h @@ -0,0 +1,15 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#ifndef GENERATED_PLUGIN_REGISTRANT_ +#define GENERATED_PLUGIN_REGISTRANT_ + +#include + +// Registers Flutter plugins. +void RegisterPlugins(flutter::PluginRegistry* registry); + +#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/examples/flutter/material_editor/windows/flutter/generated_plugins.cmake b/examples/flutter/material_editor/windows/flutter/generated_plugins.cmake new file mode 100644 index 000000000..55f1a93df --- /dev/null +++ b/examples/flutter/material_editor/windows/flutter/generated_plugins.cmake @@ -0,0 +1,24 @@ +# +# Generated file, do not edit. +# + +list(APPEND FLUTTER_PLUGIN_LIST + thermion_flutter +) + +list(APPEND FLUTTER_FFI_PLUGIN_LIST +) + +set(PLUGIN_BUNDLED_LIBRARIES) + +foreach(plugin ${FLUTTER_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/windows plugins/${plugin}) + target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) + list(APPEND PLUGIN_BUNDLED_LIBRARIES $) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) +endforeach(plugin) + +foreach(ffi_plugin ${FLUTTER_FFI_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${ffi_plugin}/windows plugins/${ffi_plugin}) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${ffi_plugin}_bundled_libraries}) +endforeach(ffi_plugin) diff --git a/examples/flutter/material_editor/windows/runner/CMakeLists.txt b/examples/flutter/material_editor/windows/runner/CMakeLists.txt new file mode 100644 index 000000000..394917c05 --- /dev/null +++ b/examples/flutter/material_editor/windows/runner/CMakeLists.txt @@ -0,0 +1,40 @@ +cmake_minimum_required(VERSION 3.14) +project(runner LANGUAGES CXX) + +# Define the application target. To change its name, change BINARY_NAME in the +# top-level CMakeLists.txt, not the value here, or `flutter run` will no longer +# work. +# +# Any new source files that you add to the application should be added here. +add_executable(${BINARY_NAME} WIN32 + "flutter_window.cpp" + "main.cpp" + "utils.cpp" + "win32_window.cpp" + "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" + "Runner.rc" + "runner.exe.manifest" +) + +# Apply the standard set of build settings. This can be removed for applications +# that need different build settings. +apply_standard_settings(${BINARY_NAME}) + +# Add preprocessor definitions for the build version. +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION=\"${FLUTTER_VERSION}\"") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_MAJOR=${FLUTTER_VERSION_MAJOR}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_MINOR=${FLUTTER_VERSION_MINOR}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_PATCH=${FLUTTER_VERSION_PATCH}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_BUILD=${FLUTTER_VERSION_BUILD}") + +# Disable Windows macros that collide with C++ standard library functions. +target_compile_definitions(${BINARY_NAME} PRIVATE "NOMINMAX") + +# Add dependency libraries and include directories. Add any application-specific +# dependencies here. +target_link_libraries(${BINARY_NAME} PRIVATE flutter flutter_wrapper_app) +target_link_libraries(${BINARY_NAME} PRIVATE "dwmapi.lib") +target_include_directories(${BINARY_NAME} PRIVATE "${CMAKE_SOURCE_DIR}") + +# Run the Flutter tool portions of the build. This must not be removed. +add_dependencies(${BINARY_NAME} flutter_assemble) diff --git a/examples/flutter/material_editor/windows/runner/Runner.rc b/examples/flutter/material_editor/windows/runner/Runner.rc new file mode 100644 index 000000000..3ad70f860 --- /dev/null +++ b/examples/flutter/material_editor/windows/runner/Runner.rc @@ -0,0 +1,121 @@ +// Microsoft Visual C++ generated resource script. +// +#pragma code_page(65001) +#include "resource.h" + +#define APSTUDIO_READONLY_SYMBOLS +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 2 resource. +// +#include "winres.h" + +///////////////////////////////////////////////////////////////////////////// +#undef APSTUDIO_READONLY_SYMBOLS + +///////////////////////////////////////////////////////////////////////////// +// English (United States) resources + +#if !defined(AFX_RESOURCE_DLL) || defined(AFX_TARG_ENU) +LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US + +#ifdef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// TEXTINCLUDE +// + +1 TEXTINCLUDE +BEGIN + "resource.h\0" +END + +2 TEXTINCLUDE +BEGIN + "#include ""winres.h""\r\n" + "\0" +END + +3 TEXTINCLUDE +BEGIN + "\r\n" + "\0" +END + +#endif // APSTUDIO_INVOKED + + +///////////////////////////////////////////////////////////////////////////// +// +// Icon +// + +// Icon with lowest ID value placed first to ensure application icon +// remains consistent on all systems. +IDI_APP_ICON ICON "resources\\app_icon.ico" + + +///////////////////////////////////////////////////////////////////////////// +// +// Version +// + +#if defined(FLUTTER_VERSION_MAJOR) && defined(FLUTTER_VERSION_MINOR) && defined(FLUTTER_VERSION_PATCH) && defined(FLUTTER_VERSION_BUILD) +#define VERSION_AS_NUMBER FLUTTER_VERSION_MAJOR,FLUTTER_VERSION_MINOR,FLUTTER_VERSION_PATCH,FLUTTER_VERSION_BUILD +#else +#define VERSION_AS_NUMBER 1,0,0,0 +#endif + +#if defined(FLUTTER_VERSION) +#define VERSION_AS_STRING FLUTTER_VERSION +#else +#define VERSION_AS_STRING "1.0.0" +#endif + +VS_VERSION_INFO VERSIONINFO + FILEVERSION VERSION_AS_NUMBER + PRODUCTVERSION VERSION_AS_NUMBER + FILEFLAGSMASK VS_FFI_FILEFLAGSMASK +#ifdef _DEBUG + FILEFLAGS VS_FF_DEBUG +#else + FILEFLAGS 0x0L +#endif + FILEOS VOS__WINDOWS32 + FILETYPE VFT_APP + FILESUBTYPE 0x0L +BEGIN + BLOCK "StringFileInfo" + BEGIN + BLOCK "040904e4" + BEGIN + VALUE "CompanyName", "com.avinium" "\0" + VALUE "FileDescription", "material_editor" "\0" + VALUE "FileVersion", VERSION_AS_STRING "\0" + VALUE "InternalName", "material_editor" "\0" + VALUE "LegalCopyright", "Copyright (C) 2026 com.avinium. All rights reserved." "\0" + VALUE "OriginalFilename", "material_editor.exe" "\0" + VALUE "ProductName", "material_editor" "\0" + VALUE "ProductVersion", VERSION_AS_STRING "\0" + END + END + BLOCK "VarFileInfo" + BEGIN + VALUE "Translation", 0x409, 1252 + END +END + +#endif // English (United States) resources +///////////////////////////////////////////////////////////////////////////// + + + +#ifndef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 3 resource. +// + + +///////////////////////////////////////////////////////////////////////////// +#endif // not APSTUDIO_INVOKED diff --git a/examples/flutter/material_editor/windows/runner/flutter_window.cpp b/examples/flutter/material_editor/windows/runner/flutter_window.cpp new file mode 100644 index 000000000..955ee3038 --- /dev/null +++ b/examples/flutter/material_editor/windows/runner/flutter_window.cpp @@ -0,0 +1,71 @@ +#include "flutter_window.h" + +#include + +#include "flutter/generated_plugin_registrant.h" + +FlutterWindow::FlutterWindow(const flutter::DartProject& project) + : project_(project) {} + +FlutterWindow::~FlutterWindow() {} + +bool FlutterWindow::OnCreate() { + if (!Win32Window::OnCreate()) { + return false; + } + + RECT frame = GetClientArea(); + + // The size here must match the window dimensions to avoid unnecessary surface + // creation / destruction in the startup path. + flutter_controller_ = std::make_unique( + frame.right - frame.left, frame.bottom - frame.top, project_); + // Ensure that basic setup of the controller was successful. + if (!flutter_controller_->engine() || !flutter_controller_->view()) { + return false; + } + RegisterPlugins(flutter_controller_->engine()); + SetChildContent(flutter_controller_->view()->GetNativeWindow()); + + flutter_controller_->engine()->SetNextFrameCallback([&]() { + this->Show(); + }); + + // Flutter can complete the first frame before the "show window" callback is + // registered. The following call ensures a frame is pending to ensure the + // window is shown. It is a no-op if the first frame hasn't completed yet. + flutter_controller_->ForceRedraw(); + + return true; +} + +void FlutterWindow::OnDestroy() { + if (flutter_controller_) { + flutter_controller_ = nullptr; + } + + Win32Window::OnDestroy(); +} + +LRESULT +FlutterWindow::MessageHandler(HWND hwnd, UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + // Give Flutter, including plugins, an opportunity to handle window messages. + if (flutter_controller_) { + std::optional result = + flutter_controller_->HandleTopLevelWindowProc(hwnd, message, wparam, + lparam); + if (result) { + return *result; + } + } + + switch (message) { + case WM_FONTCHANGE: + flutter_controller_->engine()->ReloadSystemFonts(); + break; + } + + return Win32Window::MessageHandler(hwnd, message, wparam, lparam); +} diff --git a/examples/flutter/material_editor/windows/runner/flutter_window.h b/examples/flutter/material_editor/windows/runner/flutter_window.h new file mode 100644 index 000000000..6da0652f0 --- /dev/null +++ b/examples/flutter/material_editor/windows/runner/flutter_window.h @@ -0,0 +1,33 @@ +#ifndef RUNNER_FLUTTER_WINDOW_H_ +#define RUNNER_FLUTTER_WINDOW_H_ + +#include +#include + +#include + +#include "win32_window.h" + +// A window that does nothing but host a Flutter view. +class FlutterWindow : public Win32Window { + public: + // Creates a new FlutterWindow hosting a Flutter view running |project|. + explicit FlutterWindow(const flutter::DartProject& project); + virtual ~FlutterWindow(); + + protected: + // Win32Window: + bool OnCreate() override; + void OnDestroy() override; + LRESULT MessageHandler(HWND window, UINT const message, WPARAM const wparam, + LPARAM const lparam) noexcept override; + + private: + // The project to run. + flutter::DartProject project_; + + // The Flutter instance hosted by this window. + std::unique_ptr flutter_controller_; +}; + +#endif // RUNNER_FLUTTER_WINDOW_H_ diff --git a/examples/flutter/material_editor/windows/runner/main.cpp b/examples/flutter/material_editor/windows/runner/main.cpp new file mode 100644 index 000000000..2db93d0a6 --- /dev/null +++ b/examples/flutter/material_editor/windows/runner/main.cpp @@ -0,0 +1,43 @@ +#include +#include +#include + +#include "flutter_window.h" +#include "utils.h" + +int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev, + _In_ wchar_t *command_line, _In_ int show_command) { + // Attach to console when present (e.g., 'flutter run') or create a + // new console when running with a debugger. + if (!::AttachConsole(ATTACH_PARENT_PROCESS) && ::IsDebuggerPresent()) { + CreateAndAttachConsole(); + } + + // Initialize COM, so that it is available for use in the library and/or + // plugins. + ::CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED); + + flutter::DartProject project(L"data"); + + std::vector command_line_arguments = + GetCommandLineArguments(); + + project.set_dart_entrypoint_arguments(std::move(command_line_arguments)); + + FlutterWindow window(project); + Win32Window::Point origin(10, 10); + Win32Window::Size size(1280, 720); + if (!window.Create(L"material_editor", origin, size)) { + return EXIT_FAILURE; + } + window.SetQuitOnClose(true); + + ::MSG msg; + while (::GetMessage(&msg, nullptr, 0, 0)) { + ::TranslateMessage(&msg); + ::DispatchMessage(&msg); + } + + ::CoUninitialize(); + return EXIT_SUCCESS; +} diff --git a/examples/flutter/material_editor/windows/runner/resource.h b/examples/flutter/material_editor/windows/runner/resource.h new file mode 100644 index 000000000..66a65d1e4 --- /dev/null +++ b/examples/flutter/material_editor/windows/runner/resource.h @@ -0,0 +1,16 @@ +//{{NO_DEPENDENCIES}} +// Microsoft Visual C++ generated include file. +// Used by Runner.rc +// +#define IDI_APP_ICON 101 + +// Next default values for new objects +// +#ifdef APSTUDIO_INVOKED +#ifndef APSTUDIO_READONLY_SYMBOLS +#define _APS_NEXT_RESOURCE_VALUE 102 +#define _APS_NEXT_COMMAND_VALUE 40001 +#define _APS_NEXT_CONTROL_VALUE 1001 +#define _APS_NEXT_SYMED_VALUE 101 +#endif +#endif diff --git a/examples/flutter/material_editor/windows/runner/resources/app_icon.ico b/examples/flutter/material_editor/windows/runner/resources/app_icon.ico new file mode 100644 index 000000000..c04e20caf Binary files /dev/null and b/examples/flutter/material_editor/windows/runner/resources/app_icon.ico differ diff --git a/examples/flutter/material_editor/windows/runner/runner.exe.manifest b/examples/flutter/material_editor/windows/runner/runner.exe.manifest new file mode 100644 index 000000000..153653e8d --- /dev/null +++ b/examples/flutter/material_editor/windows/runner/runner.exe.manifest @@ -0,0 +1,14 @@ + + + + + PerMonitorV2 + + + + + + + + + diff --git a/examples/flutter/material_editor/windows/runner/utils.cpp b/examples/flutter/material_editor/windows/runner/utils.cpp new file mode 100644 index 000000000..3a0b46511 --- /dev/null +++ b/examples/flutter/material_editor/windows/runner/utils.cpp @@ -0,0 +1,65 @@ +#include "utils.h" + +#include +#include +#include +#include + +#include + +void CreateAndAttachConsole() { + if (::AllocConsole()) { + FILE *unused; + if (freopen_s(&unused, "CONOUT$", "w", stdout)) { + _dup2(_fileno(stdout), 1); + } + if (freopen_s(&unused, "CONOUT$", "w", stderr)) { + _dup2(_fileno(stdout), 2); + } + std::ios::sync_with_stdio(); + FlutterDesktopResyncOutputStreams(); + } +} + +std::vector GetCommandLineArguments() { + // Convert the UTF-16 command line arguments to UTF-8 for the Engine to use. + int argc; + wchar_t** argv = ::CommandLineToArgvW(::GetCommandLineW(), &argc); + if (argv == nullptr) { + return std::vector(); + } + + std::vector command_line_arguments; + + // Skip the first argument as it's the binary name. + for (int i = 1; i < argc; i++) { + command_line_arguments.push_back(Utf8FromUtf16(argv[i])); + } + + ::LocalFree(argv); + + return command_line_arguments; +} + +std::string Utf8FromUtf16(const wchar_t* utf16_string) { + if (utf16_string == nullptr) { + return std::string(); + } + unsigned int target_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + -1, nullptr, 0, nullptr, nullptr) + -1; // remove the trailing null character + int input_length = (int)wcslen(utf16_string); + std::string utf8_string; + if (target_length == 0 || target_length > utf8_string.max_size()) { + return utf8_string; + } + utf8_string.resize(target_length); + int converted_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + input_length, utf8_string.data(), target_length, nullptr, nullptr); + if (converted_length == 0) { + return std::string(); + } + return utf8_string; +} diff --git a/examples/flutter/material_editor/windows/runner/utils.h b/examples/flutter/material_editor/windows/runner/utils.h new file mode 100644 index 000000000..3879d5475 --- /dev/null +++ b/examples/flutter/material_editor/windows/runner/utils.h @@ -0,0 +1,19 @@ +#ifndef RUNNER_UTILS_H_ +#define RUNNER_UTILS_H_ + +#include +#include + +// Creates a console for the process, and redirects stdout and stderr to +// it for both the runner and the Flutter library. +void CreateAndAttachConsole(); + +// Takes a null-terminated wchar_t* encoded in UTF-16 and returns a std::string +// encoded in UTF-8. Returns an empty std::string on failure. +std::string Utf8FromUtf16(const wchar_t* utf16_string); + +// Gets the command line arguments passed in as a std::vector, +// encoded in UTF-8. Returns an empty std::vector on failure. +std::vector GetCommandLineArguments(); + +#endif // RUNNER_UTILS_H_ diff --git a/examples/flutter/material_editor/windows/runner/win32_window.cpp b/examples/flutter/material_editor/windows/runner/win32_window.cpp new file mode 100644 index 000000000..60608d0fe --- /dev/null +++ b/examples/flutter/material_editor/windows/runner/win32_window.cpp @@ -0,0 +1,288 @@ +#include "win32_window.h" + +#include +#include + +#include "resource.h" + +namespace { + +/// Window attribute that enables dark mode window decorations. +/// +/// Redefined in case the developer's machine has a Windows SDK older than +/// version 10.0.22000.0. +/// See: https://docs.microsoft.com/windows/win32/api/dwmapi/ne-dwmapi-dwmwindowattribute +#ifndef DWMWA_USE_IMMERSIVE_DARK_MODE +#define DWMWA_USE_IMMERSIVE_DARK_MODE 20 +#endif + +constexpr const wchar_t kWindowClassName[] = L"FLUTTER_RUNNER_WIN32_WINDOW"; + +/// Registry key for app theme preference. +/// +/// A value of 0 indicates apps should use dark mode. A non-zero or missing +/// value indicates apps should use light mode. +constexpr const wchar_t kGetPreferredBrightnessRegKey[] = + L"Software\\Microsoft\\Windows\\CurrentVersion\\Themes\\Personalize"; +constexpr const wchar_t kGetPreferredBrightnessRegValue[] = L"AppsUseLightTheme"; + +// The number of Win32Window objects that currently exist. +static int g_active_window_count = 0; + +using EnableNonClientDpiScaling = BOOL __stdcall(HWND hwnd); + +// Scale helper to convert logical scaler values to physical using passed in +// scale factor +int Scale(int source, double scale_factor) { + return static_cast(source * scale_factor); +} + +// Dynamically loads the |EnableNonClientDpiScaling| from the User32 module. +// This API is only needed for PerMonitor V1 awareness mode. +void EnableFullDpiSupportIfAvailable(HWND hwnd) { + HMODULE user32_module = LoadLibraryA("User32.dll"); + if (!user32_module) { + return; + } + auto enable_non_client_dpi_scaling = + reinterpret_cast( + GetProcAddress(user32_module, "EnableNonClientDpiScaling")); + if (enable_non_client_dpi_scaling != nullptr) { + enable_non_client_dpi_scaling(hwnd); + } + FreeLibrary(user32_module); +} + +} // namespace + +// Manages the Win32Window's window class registration. +class WindowClassRegistrar { + public: + ~WindowClassRegistrar() = default; + + // Returns the singleton registrar instance. + static WindowClassRegistrar* GetInstance() { + if (!instance_) { + instance_ = new WindowClassRegistrar(); + } + return instance_; + } + + // Returns the name of the window class, registering the class if it hasn't + // previously been registered. + const wchar_t* GetWindowClass(); + + // Unregisters the window class. Should only be called if there are no + // instances of the window. + void UnregisterWindowClass(); + + private: + WindowClassRegistrar() = default; + + static WindowClassRegistrar* instance_; + + bool class_registered_ = false; +}; + +WindowClassRegistrar* WindowClassRegistrar::instance_ = nullptr; + +const wchar_t* WindowClassRegistrar::GetWindowClass() { + if (!class_registered_) { + WNDCLASS window_class{}; + window_class.hCursor = LoadCursor(nullptr, IDC_ARROW); + window_class.lpszClassName = kWindowClassName; + window_class.style = CS_HREDRAW | CS_VREDRAW; + window_class.cbClsExtra = 0; + window_class.cbWndExtra = 0; + window_class.hInstance = GetModuleHandle(nullptr); + window_class.hIcon = + LoadIcon(window_class.hInstance, MAKEINTRESOURCE(IDI_APP_ICON)); + window_class.hbrBackground = 0; + window_class.lpszMenuName = nullptr; + window_class.lpfnWndProc = Win32Window::WndProc; + RegisterClass(&window_class); + class_registered_ = true; + } + return kWindowClassName; +} + +void WindowClassRegistrar::UnregisterWindowClass() { + UnregisterClass(kWindowClassName, nullptr); + class_registered_ = false; +} + +Win32Window::Win32Window() { + ++g_active_window_count; +} + +Win32Window::~Win32Window() { + --g_active_window_count; + Destroy(); +} + +bool Win32Window::Create(const std::wstring& title, + const Point& origin, + const Size& size) { + Destroy(); + + const wchar_t* window_class = + WindowClassRegistrar::GetInstance()->GetWindowClass(); + + const POINT target_point = {static_cast(origin.x), + static_cast(origin.y)}; + HMONITOR monitor = MonitorFromPoint(target_point, MONITOR_DEFAULTTONEAREST); + UINT dpi = FlutterDesktopGetDpiForMonitor(monitor); + double scale_factor = dpi / 96.0; + + HWND window = CreateWindow( + window_class, title.c_str(), WS_OVERLAPPEDWINDOW, + Scale(origin.x, scale_factor), Scale(origin.y, scale_factor), + Scale(size.width, scale_factor), Scale(size.height, scale_factor), + nullptr, nullptr, GetModuleHandle(nullptr), this); + + if (!window) { + return false; + } + + UpdateTheme(window); + + return OnCreate(); +} + +bool Win32Window::Show() { + return ShowWindow(window_handle_, SW_SHOWNORMAL); +} + +// static +LRESULT CALLBACK Win32Window::WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + if (message == WM_NCCREATE) { + auto window_struct = reinterpret_cast(lparam); + SetWindowLongPtr(window, GWLP_USERDATA, + reinterpret_cast(window_struct->lpCreateParams)); + + auto that = static_cast(window_struct->lpCreateParams); + EnableFullDpiSupportIfAvailable(window); + that->window_handle_ = window; + } else if (Win32Window* that = GetThisFromHandle(window)) { + return that->MessageHandler(window, message, wparam, lparam); + } + + return DefWindowProc(window, message, wparam, lparam); +} + +LRESULT +Win32Window::MessageHandler(HWND hwnd, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + switch (message) { + case WM_DESTROY: + window_handle_ = nullptr; + Destroy(); + if (quit_on_close_) { + PostQuitMessage(0); + } + return 0; + + case WM_DPICHANGED: { + auto newRectSize = reinterpret_cast(lparam); + LONG newWidth = newRectSize->right - newRectSize->left; + LONG newHeight = newRectSize->bottom - newRectSize->top; + + SetWindowPos(hwnd, nullptr, newRectSize->left, newRectSize->top, newWidth, + newHeight, SWP_NOZORDER | SWP_NOACTIVATE); + + return 0; + } + case WM_SIZE: { + RECT rect = GetClientArea(); + if (child_content_ != nullptr) { + // Size and position the child window. + MoveWindow(child_content_, rect.left, rect.top, rect.right - rect.left, + rect.bottom - rect.top, TRUE); + } + return 0; + } + + case WM_ACTIVATE: + if (child_content_ != nullptr) { + SetFocus(child_content_); + } + return 0; + + case WM_DWMCOLORIZATIONCOLORCHANGED: + UpdateTheme(hwnd); + return 0; + } + + return DefWindowProc(window_handle_, message, wparam, lparam); +} + +void Win32Window::Destroy() { + OnDestroy(); + + if (window_handle_) { + DestroyWindow(window_handle_); + window_handle_ = nullptr; + } + if (g_active_window_count == 0) { + WindowClassRegistrar::GetInstance()->UnregisterWindowClass(); + } +} + +Win32Window* Win32Window::GetThisFromHandle(HWND const window) noexcept { + return reinterpret_cast( + GetWindowLongPtr(window, GWLP_USERDATA)); +} + +void Win32Window::SetChildContent(HWND content) { + child_content_ = content; + SetParent(content, window_handle_); + RECT frame = GetClientArea(); + + MoveWindow(content, frame.left, frame.top, frame.right - frame.left, + frame.bottom - frame.top, true); + + SetFocus(child_content_); +} + +RECT Win32Window::GetClientArea() { + RECT frame; + GetClientRect(window_handle_, &frame); + return frame; +} + +HWND Win32Window::GetHandle() { + return window_handle_; +} + +void Win32Window::SetQuitOnClose(bool quit_on_close) { + quit_on_close_ = quit_on_close; +} + +bool Win32Window::OnCreate() { + // No-op; provided for subclasses. + return true; +} + +void Win32Window::OnDestroy() { + // No-op; provided for subclasses. +} + +void Win32Window::UpdateTheme(HWND const window) { + DWORD light_mode; + DWORD light_mode_size = sizeof(light_mode); + LSTATUS result = RegGetValue(HKEY_CURRENT_USER, kGetPreferredBrightnessRegKey, + kGetPreferredBrightnessRegValue, + RRF_RT_REG_DWORD, nullptr, &light_mode, + &light_mode_size); + + if (result == ERROR_SUCCESS) { + BOOL enable_dark_mode = light_mode == 0; + DwmSetWindowAttribute(window, DWMWA_USE_IMMERSIVE_DARK_MODE, + &enable_dark_mode, sizeof(enable_dark_mode)); + } +} diff --git a/examples/flutter/material_editor/windows/runner/win32_window.h b/examples/flutter/material_editor/windows/runner/win32_window.h new file mode 100644 index 000000000..e901dde68 --- /dev/null +++ b/examples/flutter/material_editor/windows/runner/win32_window.h @@ -0,0 +1,102 @@ +#ifndef RUNNER_WIN32_WINDOW_H_ +#define RUNNER_WIN32_WINDOW_H_ + +#include + +#include +#include +#include + +// A class abstraction for a high DPI-aware Win32 Window. Intended to be +// inherited from by classes that wish to specialize with custom +// rendering and input handling +class Win32Window { + public: + struct Point { + unsigned int x; + unsigned int y; + Point(unsigned int x, unsigned int y) : x(x), y(y) {} + }; + + struct Size { + unsigned int width; + unsigned int height; + Size(unsigned int width, unsigned int height) + : width(width), height(height) {} + }; + + Win32Window(); + virtual ~Win32Window(); + + // Creates a win32 window with |title| that is positioned and sized using + // |origin| and |size|. New windows are created on the default monitor. Window + // sizes are specified to the OS in physical pixels, hence to ensure a + // consistent size this function will scale the inputted width and height as + // as appropriate for the default monitor. The window is invisible until + // |Show| is called. Returns true if the window was created successfully. + bool Create(const std::wstring& title, const Point& origin, const Size& size); + + // Show the current window. Returns true if the window was successfully shown. + bool Show(); + + // Release OS resources associated with window. + void Destroy(); + + // Inserts |content| into the window tree. + void SetChildContent(HWND content); + + // Returns the backing Window handle to enable clients to set icon and other + // window properties. Returns nullptr if the window has been destroyed. + HWND GetHandle(); + + // If true, closing this window will quit the application. + void SetQuitOnClose(bool quit_on_close); + + // Return a RECT representing the bounds of the current client area. + RECT GetClientArea(); + + protected: + // Processes and route salient window messages for mouse handling, + // size change and DPI. Delegates handling of these to member overloads that + // inheriting classes can handle. + virtual LRESULT MessageHandler(HWND window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Called when CreateAndShow is called, allowing subclass window-related + // setup. Subclasses should return false if setup fails. + virtual bool OnCreate(); + + // Called when Destroy is called. + virtual void OnDestroy(); + + private: + friend class WindowClassRegistrar; + + // OS callback called by message pump. Handles the WM_NCCREATE message which + // is passed when the non-client area is being created and enables automatic + // non-client DPI scaling so that the non-client area automatically + // responds to changes in DPI. All other messages are handled by + // MessageHandler. + static LRESULT CALLBACK WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Retrieves a class instance pointer for |window| + static Win32Window* GetThisFromHandle(HWND const window) noexcept; + + // Update the window frame's theme to match the system theme. + static void UpdateTheme(HWND const window); + + bool quit_on_close_ = false; + + // window handle for top level window. + HWND window_handle_ = nullptr; + + // window handle for hosted content. + HWND child_content_ = nullptr; +}; + +#endif // RUNNER_WIN32_WINDOW_H_ diff --git a/thermion_dart/hook/build.dart b/thermion_dart/hook/build.dart index e1bb9e525..c6c3136e3 100644 --- a/thermion_dart/hook/build.dart +++ b/thermion_dart/hook/build.dart @@ -229,6 +229,13 @@ outputDirectory : ${outputDirectory.path} "backend", "filameshio", if (targetOS != OS.iOS) "filamat", + // The .mat parser backing runtime material compilation + // (Engine_compileMaterial). Only the desktop artifacts ship libmatp + // (Android/iOS have filamat only, web has neither — see + // docs/research/runtime-material-compile.md), so it is linked on + // desktop only, ahead of utils because libmatp references it. Windows + // links via #pragma comment(lib) in ThermionWin32.h instead. + if (targetOS == OS.linux || targetOS == OS.macOS) "matp", if (targetOS == OS.linux) "shaders", "utils", // Android links Filament's Perfetto tracing archive. utils is always @@ -301,6 +308,14 @@ outputDirectory : ${outputDirectory.path} defines["ENABLE_TRACING"] = "1"; } + // Runtime material compilation (Phase 1 of + // docs/research/runtime-material-compile.md): the compiler implementation + // is linked into desktop builds only (where the artifact ships + // libmatp.a); other platforms compile a stub that returns a clear error. + if (targetOS == OS.linux || targetOS == OS.macOS || targetOS == OS.windows) { + defines["THERMION_RUNTIME_MATERIAL_COMPILE"] = "1"; + } + // Check for plugin configuration final pluginConfigs = input.userDefines["plugins"] as List?; diff --git a/thermion_dart/lib/src/bindings/src/thermion_dart_ffi.g.dart b/thermion_dart/lib/src/bindings/src/thermion_dart_ffi.g.dart index ce0563476..767a4e988 100644 --- a/thermion_dart/lib/src/bindings/src/thermion_dart_ffi.g.dart +++ b/thermion_dart/lib/src/bindings/src/thermion_dart_ffi.g.dart @@ -423,6 +423,9 @@ external bool Material_hasParameter(ffi.Pointer tMaterial, ffi.Pointe @ffi.Native)>(isLeaf: true) external bool MaterialInstance_isStencilWriteEnabled(ffi.Pointer materialInstance); +@ffi.Native Function(ffi.Pointer)>(isLeaf: true) +external ffi.Pointer MaterialInstance_getMaterial(ffi.Pointer materialInstance); + @ffi.Native, ffi.Bool)>(isLeaf: true) external void MaterialInstance_setStencilWrite(ffi.Pointer materialInstance, bool enabled); @@ -1173,6 +1176,99 @@ external ffi.Pointer Engine_buildMaterial( int length, ); +/// Compiles .mat [matSource] ([length] bytes, not necessarily +/// NUL-terminated) into a filamat package, synchronously on the calling +/// thread. #include directives must already be resolved by the caller (the +/// Dart layer flattens them). +/// +/// [platform]/[targetApi]/[optimization] select the compilation targets; +/// pass T_MATERIAL_TARGET_API_FROM_ENGINE to derive targetApi from the +/// engine's backend. +/// +/// [definesJson] is either nullptr or a flat JSON object of preprocessor +/// defines, e.g. `{"OCCLUSION": "1"}`. Only string keys/values and basic +/// backslash escapes are supported. +/// +/// [embedSource] controls whether the .mat source is embedded in the +/// package (matc's no-embed-source flag). +/// +/// On success returns a malloc'd buffer of *outSize bytes that the caller +/// must release with [Engine_freeCompiledMaterial]. On failure returns +/// nullptr and writes a NUL-terminated message into [outError] (capacity +/// [outErrorCap]). +@ffi.Native< + ffi.Pointer Function( + ffi.Pointer, + ffi.Pointer, + ffi.Size, + ffi.UnsignedInt, + ffi.UnsignedInt, + ffi.UnsignedInt, + ffi.Pointer, + ffi.Uint8, + ffi.Pointer, + ffi.Size, + ffi.Pointer, + ) +>(isLeaf: true) +external ffi.Pointer Engine_compileMaterial( + ffi.Pointer tEngine, + ffi.Pointer matSource, + int length, + int platform, + int targetApi, + int optimization, + ffi.Pointer definesJson, + int embedSource, + ffi.Pointer outError, + int outErrorCap, + ffi.Pointer outSize, +); + +/// Releases a buffer returned by [Engine_compileMaterial]. +@ffi.Native)>(isLeaf: true) +external void Engine_freeCompiledMaterial(ffi.Pointer data); + +/// As [Engine_compileMaterial], but the work runs on the engine's render +/// thread. The task writes the malloc'd package to *[outData] and its size to +/// *[outSize] (release it with [Engine_freeCompiledMaterial]), or nullptr on +/// failure with the message in [outError], then invokes [onComplete] with +/// [requestId]. +@ffi.Native< + ffi.Void Function( + ffi.Pointer, + ffi.Pointer, + ffi.Size, + ffi.UnsignedInt, + ffi.UnsignedInt, + ffi.UnsignedInt, + ffi.Pointer, + ffi.Uint8, + ffi.Pointer, + ffi.Size, + ffi.Pointer>, + ffi.Pointer, + ffi.Uint32, + ffi.Pointer>, + ) +>(isLeaf: true) +external void Engine_compileMaterialRenderThread( + ffi.Pointer tEngine, + ffi.Pointer matSource, + int length, + int platform, + int targetApi, + int optimization, + ffi.Pointer definesJson, + int embedSource, + ffi.Pointer outError, + int outErrorCap, + ffi.Pointer> outData, + ffi.Pointer outSize, + int requestId, + ffi.Pointer> onComplete, +); + @ffi.Native, ffi.Pointer)>(isLeaf: true) external void Engine_destroyMaterial(ffi.Pointer tEngine, ffi.Pointer tMaterial); @@ -4605,6 +4701,34 @@ external void Scene_setIndirectLight(ffi.Pointer tScene, ffi.Pointer, ffi.Pointer)>(isLeaf: true) external void Scene_addFilamentAsset(ffi.Pointer tScene, ffi.Pointer asset); +/// Walks every renderable primitive in the scene and records the ones whose +/// current MaterialInstance belongs to [tMaterial]. +/// +/// Returns the TOTAL number of matches (which may exceed [capacity]). When +/// [outEntities]/[outPrimitives]/[outInstances] are non-null, up to +/// [capacity] matches are written to them. Call once with null buffers to +/// size the output, then again to fetch it. +@ffi.Native< + ffi.Size Function( + ffi.Pointer, + ffi.Pointer, + ffi.Pointer, + ffi.Pointer, + ffi.Pointer, + ffi.Pointer>, + ffi.Size, + ) +>(isLeaf: true) +external int Scene_scanForMaterial( + ffi.Pointer tScene, + ffi.Pointer tRenderableManager, + ffi.Pointer tMaterial, + ffi.Pointer outEntities, + ffi.Pointer outPrimitives, + ffi.Pointer> outInstances, + int capacity, +); + @ffi.Native(isLeaf: true) external void FrameScheduler_startWithCallback(FrameTickCallback tickCallback, int targetFps); @@ -5628,6 +5752,28 @@ sealed class TBackend { static const BACKEND_NOOP = 4; } +sealed class TMaterialPlatform { + static const T_MATERIAL_PLATFORM_DESKTOP = 0; + static const T_MATERIAL_PLATFORM_MOBILE = 1; + static const T_MATERIAL_PLATFORM_ALL = 2; +} + +sealed class TMaterialTargetApi { + static const T_MATERIAL_TARGET_API_OPENGL = 1; + static const T_MATERIAL_TARGET_API_VULKAN = 2; + static const T_MATERIAL_TARGET_API_METAL = 4; + static const T_MATERIAL_TARGET_API_WEBGPU = 8; + static const T_MATERIAL_TARGET_API_ALL = 15; + static const T_MATERIAL_TARGET_API_FROM_ENGINE = 256; +} + +sealed class TMaterialOptimization { + static const T_MATERIAL_OPTIMIZATION_NONE = 0; + static const T_MATERIAL_OPTIMIZATION_PREPROCESSOR = 1; + static const T_MATERIAL_OPTIMIZATION_SIZE = 2; + static const T_MATERIAL_OPTIMIZATION_PERFORMANCE = 3; +} + sealed class TLightType { static const LIGHT_TYPE_SUN = 0; static const LIGHT_TYPE_DIRECTIONAL = 1; diff --git a/thermion_dart/lib/src/bindings/src/thermion_dart_js_interop.g.dart b/thermion_dart/lib/src/bindings/src/thermion_dart_js_interop.g.dart index 64a05b7c8..a3661da72 100644 --- a/thermion_dart/lib/src/bindings/src/thermion_dart_js_interop.g.dart +++ b/thermion_dart/lib/src/bindings/src/thermion_dart_js_interop.g.dart @@ -188,6 +188,7 @@ extension type GeneratedBindings(NativeLibrary _) implements JSObject { external Pointer _Material_createBoneOverlayMaterial(Pointer tEngine); external int _Material_hasParameter(Pointer tMaterial, Pointer propertyName); external int _MaterialInstance_isStencilWriteEnabled(Pointer materialInstance); + external Pointer _MaterialInstance_getMaterial(Pointer materialInstance); external void _MaterialInstance_setStencilWrite(Pointer materialInstance, bool enabled); external void _MaterialInstance_setCullingMode(Pointer materialInstance, int culling); external void _MaterialInstance_setDoubleSided(Pointer materialInstance, bool doubleSided); @@ -518,6 +519,65 @@ extension type GeneratedBindings(NativeLibrary _) implements JSObject { Pointer materialData, size_t length, ); + + /// Compiles .mat [matSource] ([length] bytes, not necessarily + /// NUL-terminated) into a filamat package, synchronously on the calling + /// thread. #include directives must already be resolved by the caller (the + /// Dart layer flattens them). + /// + /// [platform]/[targetApi]/[optimization] select the compilation targets; + /// pass T_MATERIAL_TARGET_API_FROM_ENGINE to derive targetApi from the + /// engine's backend. + /// + /// [definesJson] is either nullptr or a flat JSON object of preprocessor + /// defines, e.g. `{"OCCLUSION": "1"}`. Only string keys/values and basic + /// backslash escapes are supported. + /// + /// [embedSource] controls whether the .mat source is embedded in the + /// package (matc's no-embed-source flag). + /// + /// On success returns a malloc'd buffer of *outSize bytes that the caller + /// must release with [Engine_freeCompiledMaterial]. On failure returns + /// nullptr and writes a NUL-terminated message into [outError] (capacity + /// [outErrorCap]). + external Pointer _Engine_compileMaterial( + Pointer tEngine, + Pointer matSource, + size_t length, + int platform, + int targetApi, + int optimization, + Pointer definesJson, + int embedSource, + Pointer outError, + size_t outErrorCap, + Pointer outSize, + ); + + /// Releases a buffer returned by [Engine_compileMaterial]. + external void _Engine_freeCompiledMaterial(Pointer data); + + /// As [Engine_compileMaterial], but the work runs on the engine's render + /// thread. The task writes the malloc'd package to *[outData] and its size to + /// *[outSize] (release it with [Engine_freeCompiledMaterial]), or nullptr on + /// failure with the message in [outError], then invokes [onComplete] with + /// [requestId]. + external void _Engine_compileMaterialRenderThread( + Pointer tEngine, + Pointer matSource, + size_t length, + int platform, + int targetApi, + int optimization, + Pointer definesJson, + int embedSource, + Pointer outError, + size_t outErrorCap, + Pointer> outData, + Pointer outSize, + int requestId, + Pointer> onComplete, + ); external void _Engine_destroyMaterial(Pointer tEngine, Pointer tMaterial); external void _Engine_destroyMaterialInstance(Pointer tEngine, Pointer tMaterialInstance); external Pointer _Engine_createScene(Pointer tEngine); @@ -2376,6 +2436,23 @@ extension type GeneratedBindings(NativeLibrary _) implements JSObject { external Pointer _Scene_getSkybox(Pointer tScene); external void _Scene_setIndirectLight(Pointer tScene, Pointer tIndirectLight); external void _Scene_addFilamentAsset(Pointer tScene, Pointer asset); + + /// Walks every renderable primitive in the scene and records the ones whose + /// current MaterialInstance belongs to [tMaterial]. + /// + /// Returns the TOTAL number of matches (which may exceed [capacity]). When + /// [outEntities]/[outPrimitives]/[outInstances] are non-null, up to + /// [capacity] matches are written to them. Call once with null buffers to + /// size the output, then again to fetch it. + external size_t _Scene_scanForMaterial( + Pointer tScene, + Pointer tRenderableManager, + Pointer tMaterial, + Pointer outEntities, + Pointer outPrimitives, + Pointer> outInstances, + size_t capacity, + ); external void _FrameScheduler_startWithCallback(FrameTickCallback tickCallback, int targetFps); external void _FrameScheduler_stop(); external int _FrameScheduler_initDartApi(Pointer data); @@ -3046,6 +3123,11 @@ bool MaterialInstance_isStencilWriteEnabled(Pointer materialI return result == 1; } +Pointer MaterialInstance_getMaterial(Pointer materialInstance) { + final result = GeneratedBindings.instance._MaterialInstance_getMaterial(materialInstance.cast()); + return Pointer(result); +} + void MaterialInstance_setStencilWrite(Pointer materialInstance, bool enabled) { final result = GeneratedBindings.instance._MaterialInstance_setStencilWrite(materialInstance.cast(), enabled); return result; @@ -4075,6 +4157,101 @@ Pointer Engine_buildMaterial(Pointer tEngine, Pointer return Pointer(result); } +/// Compiles .mat [matSource] ([length] bytes, not necessarily +/// NUL-terminated) into a filamat package, synchronously on the calling +/// thread. #include directives must already be resolved by the caller (the +/// Dart layer flattens them). +/// +/// [platform]/[targetApi]/[optimization] select the compilation targets; +/// pass T_MATERIAL_TARGET_API_FROM_ENGINE to derive targetApi from the +/// engine's backend. +/// +/// [definesJson] is either nullptr or a flat JSON object of preprocessor +/// defines, e.g. `{"OCCLUSION": "1"}`. Only string keys/values and basic +/// backslash escapes are supported. +/// +/// [embedSource] controls whether the .mat source is embedded in the +/// package (matc's no-embed-source flag). +/// +/// On success returns a malloc'd buffer of *outSize bytes that the caller +/// must release with [Engine_freeCompiledMaterial]. On failure returns +/// nullptr and writes a NUL-terminated message into [outError] (capacity +/// [outErrorCap]). +Pointer Engine_compileMaterial( + Pointer tEngine, + Pointer matSource, + Dartsize_t length, + int platform, + int targetApi, + int optimization, + Pointer definesJson, + int embedSource, + Pointer outError, + Dartsize_t outErrorCap, + Pointer outSize, +) { + final result = GeneratedBindings.instance._Engine_compileMaterial( + tEngine.cast(), + matSource, + length, + platform, + targetApi, + optimization, + definesJson, + embedSource, + outError, + outErrorCap, + outSize, + ); + return Pointer(result); +} + +/// Releases a buffer returned by [Engine_compileMaterial]. +void Engine_freeCompiledMaterial(Pointer data) { + final result = GeneratedBindings.instance._Engine_freeCompiledMaterial(data); + return result; +} + +/// As [Engine_compileMaterial], but the work runs on the engine's render +/// thread. The task writes the malloc'd package to *[outData] and its size to +/// *[outSize] (release it with [Engine_freeCompiledMaterial]), or nullptr on +/// failure with the message in [outError], then invokes [onComplete] with +/// [requestId]. +void Engine_compileMaterialRenderThread( + Pointer tEngine, + Pointer matSource, + Dartsize_t length, + int platform, + int targetApi, + int optimization, + Pointer definesJson, + int embedSource, + Pointer outError, + Dartsize_t outErrorCap, + Pointer> outData, + Pointer outSize, + int requestId, + Pointer> onComplete, +) { + final result = GeneratedBindings.instance._Engine_compileMaterialRenderThread( + tEngine.cast(), + matSource, + length, + platform, + targetApi, + optimization, + definesJson, + embedSource, + outError, + outErrorCap, + outData, + outSize, + requestId, + onComplete.cast(), + ); + return result; +} + void Engine_destroyMaterial(Pointer tEngine, Pointer tMaterial) { final result = GeneratedBindings.instance._Engine_destroyMaterial(tEngine.cast(), tMaterial.cast()); return result; @@ -8759,6 +8936,34 @@ void Scene_addFilamentAsset(Pointer tScene, Pointer asse return result; } +/// Walks every renderable primitive in the scene and records the ones whose +/// current MaterialInstance belongs to [tMaterial]. +/// +/// Returns the TOTAL number of matches (which may exceed [capacity]). When +/// [outEntities]/[outPrimitives]/[outInstances] are non-null, up to +/// [capacity] matches are written to them. Call once with null buffers to +/// size the output, then again to fetch it. +Dartsize_t Scene_scanForMaterial( + Pointer tScene, + Pointer tRenderableManager, + Pointer tMaterial, + Pointer outEntities, + Pointer outPrimitives, + Pointer> outInstances, + Dartsize_t capacity, +) { + final result = GeneratedBindings.instance._Scene_scanForMaterial( + tScene.cast(), + tRenderableManager.cast(), + tMaterial.cast(), + outEntities, + outPrimitives, + outInstances.cast(), + capacity, + ); + return result; +} + void FrameScheduler_startWithCallback(DartFrameTickCallback tickCallback, int targetFps) { final result = GeneratedBindings.instance._FrameScheduler_startWithCallback( tickCallback as Pointer>, @@ -10759,6 +10964,28 @@ final class TFence extends Struct { } } +sealed class TMaterialPlatform { + static const T_MATERIAL_PLATFORM_DESKTOP = 0; + static const T_MATERIAL_PLATFORM_MOBILE = 1; + static const T_MATERIAL_PLATFORM_ALL = 2; +} + +sealed class TMaterialTargetApi { + static const T_MATERIAL_TARGET_API_OPENGL = 1; + static const T_MATERIAL_TARGET_API_VULKAN = 2; + static const T_MATERIAL_TARGET_API_METAL = 4; + static const T_MATERIAL_TARGET_API_WEBGPU = 8; + static const T_MATERIAL_TARGET_API_ALL = 15; + static const T_MATERIAL_TARGET_API_FROM_ENGINE = 256; +} + +sealed class TMaterialOptimization { + static const T_MATERIAL_OPTIMIZATION_NONE = 0; + static const T_MATERIAL_OPTIMIZATION_PREPROCESSOR = 1; + static const T_MATERIAL_OPTIMIZATION_SIZE = 2; + static const T_MATERIAL_OPTIMIZATION_PERFORMANCE = 3; +} + extension TSkyboxExt on Pointer { TSkybox toDart() { return TSkybox(this); @@ -11476,7 +11703,15 @@ extension StructAllocator on Struct { } } -extension NativeFunctionPointer0 on void Function() { +extension NativeFunctionPointer0 on void Function(int requestId) { + Pointer> addFunction() { + return Pointer>( + NativeLibrary.instance.addFunction(this.toJS, 'vi'), + ).cast(); + } +} + +extension NativeFunctionPointer1 on void Function() { Pointer> addFunction() { return Pointer>( NativeLibrary.instance.addFunction(this.toJS, 'v'), @@ -11484,7 +11719,7 @@ extension NativeFunctionPointer0 on void Function() { } } -extension NativeFunctionPointer1 on void Function(Pointer) { +extension NativeFunctionPointer2 on void Function(Pointer) { Pointer)>> addFunction() { return Pointer)>>( NativeLibrary.instance.addFunction)>(this.toJS, 'vp'), @@ -11492,7 +11727,7 @@ extension NativeFunctionPointer1 on void Function(Pointer< } } -extension NativeFunctionPointer17 on void Function(bool) { +extension NativeFunctionPointer18 on void Function(bool) { Pointer> addFunction() { return Pointer>( NativeLibrary.instance.addFunction(this.toJS, 'vi'), @@ -11500,15 +11735,7 @@ extension NativeFunctionPointer17 on void Function(bool) { } } -extension NativeFunctionPointer47 on void Function(int) { - Pointer> addFunction() { - return Pointer>( - NativeLibrary.instance.addFunction(this.toJS, 'vi'), - ).cast(); - } -} - -extension NativeFunctionPointer61 on void Function(double) { +extension NativeFunctionPointer62 on void Function(double) { Pointer> addFunction() { return Pointer>( NativeLibrary.instance.addFunction(this.toJS, 'vf'), diff --git a/thermion_dart/lib/src/filament/src/implementation/ffi_filament_app.dart b/thermion_dart/lib/src/filament/src/implementation/ffi_filament_app.dart index 81ca9a762..55c5a7f0c 100644 --- a/thermion_dart/lib/src/filament/src/implementation/ffi_filament_app.dart +++ b/thermion_dart/lib/src/filament/src/implementation/ffi_filament_app.dart @@ -1,4 +1,5 @@ import 'dart:async'; +import 'dart:convert'; import 'dart:math' as math; import 'package:thermion_dart/src/filament/src/implementation/ffi_render_manager.dart'; @@ -265,7 +266,9 @@ class FFIFilamentApp extends FilamentApp { // Future createScene() async { - return FFIScene(Engine_createScene(engine), this); + final scene = FFIScene(Engine_createScene(engine), this); + _scenes.add(scene); + return scene; } // @@ -737,6 +740,357 @@ class FFIFilamentApp extends FilamentApp { await renderableManager.setMaterialInstanceAt(entity, index, materialInstance); } + /// Scenes created by this app, for scans that must walk scene contents + /// (see [findRenderablesUsingMaterial]). Kept in creation order; pruned in + /// [destroyScene]. + final _scenes = []; + + /// One wrapper per live native MaterialInstance pointer. + /// + /// Filament instances are write-only, so parameter/raster state is recorded + /// on the Dart wrapper (MaterialInstanceShadowState) rather than read back + /// from native. Returning the *same* wrapper for repeated lookups of one + /// native instance is what keeps that recording complete — otherwise each + /// getMaterialInstanceAt would hand out a fresh wrapper with an empty + /// recording and a later reload would silently drop earlier mutations. + final _materialInstanceWrappers = , FFIMaterialInstance>{}; + + /// Attachments made through [setMaterialInstanceAt], keyed by the attached + /// instance. The scene scan in [findRenderablesUsingMaterial] cannot see + /// renderables that are not in a scene yet; this records them so a reload + /// can still re-point them before destroying the old instances. + final _materialInstanceAttachments = , Set<(ThermionEntity, int)>>{}; + + /// Returns the wrapper for [pointer], creating (and caching) it on first + /// use. Callers that hold the returned wrapper must not use it after the + /// underlying instance has been destroyed. + FFIMaterialInstance getOrCreateMaterialInstanceWrapper(Pointer pointer) { + return _materialInstanceWrappers.putIfAbsent(pointer, () => FFIMaterialInstance(pointer, this)); + } + + /// Caches [instance] as the sole wrapper for its native pointer (used when + /// a new instance is created, where there is no pre-existing wrapper). + void adoptMaterialInstance(FFIMaterialInstance instance) { + _materialInstanceWrappers[instance.pointer] = instance; + } + + /// Drops the wrapper and attachment records for [instance]. Called when the + /// instance is destroyed. + void forgetMaterialInstance(FFIMaterialInstance instance) { + _materialInstanceWrappers.remove(instance.pointer); + _materialInstanceAttachments.remove(instance.pointer); + } + + /// Records that [instance] was attached to a renderable primitive via + /// [setMaterialInstanceAt]. + void recordMaterialInstanceAttachment(ThermionEntity entity, int primitiveIndex, FFIMaterialInstance instance) { + _materialInstanceAttachments.putIfAbsent(instance.pointer, () => {}).add((entity, primitiveIndex)); + } + + /// Drops the record for an attachment that was cleared or overwritten. + /// Overwrites record the new instance through [recordMaterialInstanceAttachment]; + /// the stale (entity, primitive) entry for [instance] is removed here. + void forgetMaterialInstanceAttachment(ThermionEntity entity, int primitiveIndex, FFIMaterialInstance instance) { + _materialInstanceAttachments[instance.pointer]?.remove((entity, primitiveIndex)); + } + + @override + Future> findRenderablesUsingMaterial(Material material) async { + final ffiMaterial = material as FFIMaterial; + final uses = []; + final reported = <(ThermionEntity, int)>{}; + + // Pass 1: native scan over every live scene. Finds every primitive + // currently drawn with an instance of [material], however the instance + // was created — including instances handed out by asset loaders, which + // have no Dart wrapper until now. + for (final scene in List.of(_scenes)) { + final scenePtr = scene.getNativeHandle(); + final renderableManagerPtr = renderableManager.renderableManager; + final count = Scene_scanForMaterial( + scenePtr, + renderableManagerPtr, + ffiMaterial.pointer, + nullptr.cast(), + nullptr.cast(), + nullptr.cast(), + 0, + ); + if (count == 0) { + continue; + } + final entities = makeInt32List(count); + final primitives = makeUint32List(count); + late Pointer stackPtr; + if (FILAMENT_WASM) { + stackPtr = stackSave(); + } + try { + Scene_scanForMaterial( + scenePtr, + renderableManagerPtr, + ffiMaterial.pointer, + entities.address, + primitives.address, + nullptr.cast(), + count, + ); + for (var i = 0; i < count; i++) { + final entity = entities[i]; + final primitiveIndex = primitives[i]; + if (!reported.add((entity, primitiveIndex))) { + continue; + } + // The scan's outInstances output is left empty on purpose: reusing + // RenderableManager_getMaterialInstanceAt keeps this path on an + // existing binding and gives us the cached wrapper (with its shadow + // recording) when there is one. + final instance = await renderableManager.getMaterialInstanceAt(entity, primitiveIndex); + if (instance == null) { + // The renderable changed between the scan and this fetch. + continue; + } + uses.add(MaterialInstanceUse(entity, primitiveIndex, instance)); + } + } finally { + if (FILAMENT_WASM) { + stackRestore(stackPtr); + } + } + } + + // Pass 2: attachments recorded through this library that pass 1 cannot + // see because the renderable is not in a scene. Every record is + // re-validated against the renderable's *current* instance, so entries + // left over from earlier swaps are pruned instead of reported. + for (final entry in Map.of(_materialInstanceAttachments).entries) { + for (final attachment in Set.of(entry.value)) { + if (reported.contains(attachment)) { + continue; + } + final current = await renderableManager.getMaterialInstanceAt(attachment.$1, attachment.$2); + if (current == null || + (current as FFIMaterialInstance).pointer.address != entry.key.address || + MaterialInstance_getMaterial(current.pointer).address != ffiMaterial.pointer.address) { + entry.value.remove(attachment); + continue; + } + reported.add(attachment); + uses.add(MaterialInstanceUse(attachment.$1, attachment.$2, current)); + } + if (entry.value.isEmpty) { + _materialInstanceAttachments.remove(entry.key); + } + } + + return uses; + } + + @override + Future reloadMaterialFromBytes( + Material oldMaterial, + Uint8List materialBytes, { + bool destroyOld = true, + }) async { + final oldFFIMaterial = oldMaterial as FFIMaterial; + + // Build the replacement first: if the bytes are invalid we want to fail + // before touching anything. + final newMaterial = await createMaterial(materialBytes); + + // Every distinct old instance becomes exactly one new instance, so + // renderables that shared an instance keep sharing one. + final uses = await findRenderablesUsingMaterial(oldMaterial); + final replacements = , FFIMaterialInstance>{}; + final retired = {}; + for (final use in uses) { + final oldInstance = use.materialInstance as FFIMaterialInstance; + retired.add(oldInstance); + var replacement = replacements[oldInstance.pointer]; + if (replacement == null) { + replacement = await newMaterial.createInstance() as FFIMaterialInstance; + await oldInstance.shadow.applyTo(replacement); + replacements[oldInstance.pointer] = replacement; + } + // Re-point the primitive before the old instance is destroyed. + await setMaterialInstanceAt(use.entity, use.primitiveIndex, replacement); + } + + if (destroyOld) { + // Filament requires every instance of a material to be destroyed + // before the material itself. Destroy the retired (replaced) instances + // plus any other instance created from this material, including ones + // never attached to a renderable — leaving those alive would make the + // material destroy hang. destroy() is idempotent, so overlap between + // the two sets is fine. + for (final instance in retired) { + await instance.destroy(); + } + for (final instance in List.of(oldFFIMaterial.createdInstances)) { + await instance.destroy(); + } + await oldFFIMaterial.destroy(); + } + return newMaterial; + } + + static final _includeRegExp = RegExp(r'^[ \t]*#[ \t]*include[ \t]*["<]([^">]+)[">][ \t]*$'); + + /// Flattens `#include` directives in [source] using this app's resource + /// loader, so the native compiler receives a single self-contained buffer + /// (matp only sees the bytes it is handed; it has no include callback). + /// + /// Each include is resolved against [includePaths] in order, then tried as + /// a bare path through the loader. Circular and over-deep include chains + /// are rejected rather than looped. + Future _resolveIncludes(String source, List includePaths) async { + Future tryLoad(String uri) async { + try { + return utf8.decode(await _loadResource(uri)); + } catch (_) { + return null; + } + } + + Future expand(String text, String referencing, List active) async { + final lines = text.split('\n'); + final out = []; + for (final line in lines) { + final match = _includeRegExp.firstMatch(line); + if (match == null) { + out.add(line); + continue; + } + final name = match.group(1)!; + if (active.contains(name)) { + throw MaterialCompileException( + "#include \"$name\" from $referencing is circular (${active.join(" -> ")} -> $name)", + ); + } + if (active.length >= 64) { + throw MaterialCompileException("#include nesting exceeded 64 levels at \"$name\" from $referencing"); + } + String? included; + String? resolvedAs; + for (final dir in [...includePaths, ""]) { + final candidate = dir.isEmpty || dir.endsWith("/") ? "$dir$name" : "$dir/$name"; + final contents = await tryLoad(candidate); + if (contents != null) { + included = contents; + resolvedAs = candidate; + break; + } + } + if (included == null) { + throw MaterialCompileException( + "Could not resolve #include \"$name\" " + "from $referencing (searched: ${includePaths.isEmpty ? "" : includePaths.join(", ")})", + ); + } + // Splice the file in place of the directive. Nested includes in the + // included file are resolved the same way. + out.add(await expand(included, resolvedAs!, [...active, name])); + } + return out.join('\n'); + } + + return expand(source, "", []); + } + + @override + Future compileMaterial( + String matSource, { + MaterialCompilePlatform platform = MaterialCompilePlatform.all, + Set? targetApi, + MaterialOptimization optimization = MaterialOptimization.performance, + Map defines = const {}, + List includePaths = const [], + bool embedSource = true, + }) async { + if (FILAMENT_WASM) { + throw UnsupportedError( + "compileMaterial is not supported on web: the WASM engine does not link the " + "material compiler. Pre-compile .mat sources to .filamat with matc and load " + "them with createMaterial instead.", + ); + } + + final platformFlag = switch (platform) { + MaterialCompilePlatform.desktop => TMaterialPlatform.T_MATERIAL_PLATFORM_DESKTOP, + MaterialCompilePlatform.mobile => TMaterialPlatform.T_MATERIAL_PLATFORM_MOBILE, + MaterialCompilePlatform.all => TMaterialPlatform.T_MATERIAL_PLATFORM_ALL, + }; + // Null targetApi lets native derive the target from the engine's backend, + // which is what makes the package loadable by the running engine. + var targetApiFlag = TMaterialTargetApi.T_MATERIAL_TARGET_API_FROM_ENGINE; + if (targetApi != null && targetApi.isNotEmpty) { + targetApiFlag = 0; + for (final api in targetApi) { + targetApiFlag |= switch (api) { + MaterialTargetApi.opengl => TMaterialTargetApi.T_MATERIAL_TARGET_API_OPENGL, + MaterialTargetApi.vulkan => TMaterialTargetApi.T_MATERIAL_TARGET_API_VULKAN, + MaterialTargetApi.metal => TMaterialTargetApi.T_MATERIAL_TARGET_API_METAL, + MaterialTargetApi.webgpu => TMaterialTargetApi.T_MATERIAL_TARGET_API_WEBGPU, + }; + } + } + final optimizationLevel = switch (optimization) { + MaterialOptimization.none => TMaterialOptimization.T_MATERIAL_OPTIMIZATION_NONE, + MaterialOptimization.preprocessor => TMaterialOptimization.T_MATERIAL_OPTIMIZATION_PREPROCESSOR, + MaterialOptimization.size => TMaterialOptimization.T_MATERIAL_OPTIMIZATION_SIZE, + MaterialOptimization.performance => TMaterialOptimization.T_MATERIAL_OPTIMIZATION_PERFORMANCE, + }; + + final flattened = await _resolveIncludes(matSource, includePaths); + final sourceByteLength = utf8.encode(flattened).length; + + final sourcePtr = flattened.toNativeUtf8().cast(); + final definesPtr = defines.isEmpty ? nullptr.cast() : jsonEncode(defines).toNativeUtf8().cast(); + final outError = allocate(1024); + outError[0] = 0; + // Written by the render-thread task before the completion callback fires. + final outData = allocate>(sizeOf>()); + final outSize = allocate(sizeOf()); + try { + await withVoidCallback((requestId, cb) { + Engine_compileMaterialRenderThread( + engine, + sourcePtr, + sourceByteLength, + platformFlag, + targetApiFlag, + optimizationLevel, + definesPtr, + embedSource ? 1 : 0, + outError, + 1024, + outData, + outSize.cast(), + requestId, + cb, + ); + }); + final data = outData.value; + if (data == nullptr) { + throw MaterialCompileException(outError.cast().toDartString()); + } + final size = outSize.value; + // Copy out of the native buffer, then hand it back. The buffer stays + // valid from the task's write until this free; nothing else touches it. + final compiled = Uint8List.fromList(data.asTypedList(size)); + Engine_freeCompiledMaterial(data); + return compiled; + } finally { + free(sourcePtr); + if (definesPtr != nullptr) { + free(definesPtr); + } + free(outError); + free(outData); + free(outSize); + } + } + final _swapChains = []; // @@ -1262,6 +1616,7 @@ class FFIFilamentApp extends FilamentApp { } Future destroyScene(covariant FFIScene scene) async { + _scenes.remove(scene); await withVoidCallback((requestId, cb) => Engine_destroySceneRenderThread(engine, scene.scene, requestId, cb)); } diff --git a/thermion_dart/lib/src/filament/src/implementation/ffi_material.dart b/thermion_dart/lib/src/filament/src/implementation/ffi_material.dart index 141205213..93c05dd59 100644 --- a/thermion_dart/lib/src/filament/src/implementation/ffi_material.dart +++ b/thermion_dart/lib/src/filament/src/implementation/ffi_material.dart @@ -1,12 +1,24 @@ import 'dart:async'; import 'package:thermion_dart/src/filament/src/implementation/ffi_texture.dart'; import 'package:thermion_dart/thermion_dart.dart'; +import 'ffi_filament_app.dart'; +import 'material_shadow_state.dart'; class FFIMaterial extends Material> { final Pointer pointer; final FilamentApp _app; + /// + /// Every instance created from this material via [createInstance]. + /// + /// Instances cannot be re-parented to another material in Filament, so + /// hot-reloading a material means creating replacement instances. This list + /// lets the app find (and retire) the instances of a material being swapped + /// out, including ones not currently attached to any renderable. + /// + final List createdInstances = []; + FFIMaterial(this.pointer, this._app); @override @@ -14,10 +26,24 @@ class FFIMaterial extends Material> { var ptr = await withPointerCallback((cb) { Material_createInstanceRenderThread(pointer, cb); }); - return FFIMaterialInstance(ptr, _app); + final instance = FFIMaterialInstance(ptr, _app); + // Register with the app so later lookups of this native instance return + // this wrapper (and keep its shadow recording). The registry is FFI-app + // internal state, not part of the FilamentApp interface. + (_app as FFIFilamentApp).adoptMaterialInstance(instance); + createdInstances.add(instance); + return instance; } Future destroy() async { + // Filament requires every instance of a material to be gone before the + // material itself; destroying a material with live instances strands the + // render thread. Retire the instances this wrapper created (they must + // already be detached from live renderables — see reloadMaterialFromBytes, + // which re-points renderables before retiring old instances). + for (final instance in List.of(createdInstances)) { + await instance.destroy(); + } await withVoidCallback((requestId, cb) { Engine_destroyMaterialRenderThread(_app.engine, pointer, requestId, cb); }); @@ -44,6 +70,16 @@ class FFIMaterialInstance extends MaterialInstance> { final FilamentApp _app; + /// + /// Shadow copy of every parameter/raster-state mutation applied through + /// this wrapper. Filament instances are write-only, so this recording is + /// the only way to carry state across to a replacement instance when a + /// material is hot-reloaded. See [MaterialInstanceShadowState]. + /// + final MaterialInstanceShadowState shadow = MaterialInstanceShadowState(); + + bool _destroyed = false; + FFIMaterialInstance(this.pointer, this._app) { if (pointer == nullptr) { throw Exception("MaterialInstance not found"); @@ -51,36 +87,43 @@ class FFIMaterialInstance extends MaterialInstance> { } Future setDoubleSided(bool doubleSided) async { + shadow.doubleSided = doubleSided; MaterialInstance_setDoubleSided(this.pointer, doubleSided); } @override Future setDepthCullingEnabled(bool enabled) async { + shadow.depthCullingEnabled = enabled; MaterialInstance_setDepthCulling(this.pointer, enabled); } @override Future setDepthWriteEnabled(bool enabled) async { + shadow.depthWriteEnabled = enabled; MaterialInstance_setDepthWrite(this.pointer, enabled); } @override Future setParameterFloat(String name, double value) async { + shadow.parameters[name] = value; MaterialInstance_setParameterFloat(pointer, name.toNativeUtf8().cast(), value); } @override Future setParameterFloat2(String name, double x, double y) async { + shadow.parameters[name] = [x, y]; MaterialInstance_setParameterFloat2(pointer, name.toNativeUtf8().cast(), x, y); } @override Future setParameterFloat3(String name, double x, double y, double z) async { + shadow.parameters[name] = [x, y, z]; MaterialInstance_setParameterFloat3(pointer, name.toNativeUtf8().cast(), x, y, z); } @override Future setParameterFloat3Array(String name, List array) async { + shadow.parameters[name] = List.of(array); final ptr = name.toNativeUtf8().cast(); final data = Float64List(array.length * 3); int i = 0; @@ -100,51 +143,61 @@ class FFIMaterialInstance extends MaterialInstance> { @override Future setParameterFloat4(String name, double x, double y, double z, double w) async { + shadow.parameters[name] = [x, y, z, w]; MaterialInstance_setParameterFloat4(pointer, name.toNativeUtf8().cast(), x, y, z, w); } @override Future setParameterInt(String name, int value) async { + shadow.parameters[name] = value; MaterialInstance_setParameterInt(pointer, name.toNativeUtf8().cast(), value); } @override Future setDepthFunc(SamplerCompareFunction depthFunc) async { + shadow.depthFunc = depthFunc; MaterialInstance_setDepthFunc(pointer, depthFunc.index); } @override Future setStencilCompareFunction(SamplerCompareFunction func, [StencilFace face = StencilFace.FRONT_AND_BACK]) async { + shadow.stencilCompareFunction[face] = func; MaterialInstance_setStencilCompareFunction(pointer, func.index, face.toFFI()); } @override Future setStencilOpDepthFail(StencilOperation op, [StencilFace face = StencilFace.FRONT_AND_BACK]) async { + shadow.stencilOpDepthFail[face] = op; MaterialInstance_setStencilOpDepthFail(pointer, op.index, face.toFFI()); } @override Future setStencilOpDepthStencilPass(StencilOperation op, [StencilFace face = StencilFace.FRONT_AND_BACK]) async { + shadow.stencilOpDepthStencilPass[face] = op; MaterialInstance_setStencilOpDepthStencilPass(pointer, op.index, face.toFFI()); } @override Future setStencilOpStencilFail(StencilOperation op, [StencilFace face = StencilFace.FRONT_AND_BACK]) async { + shadow.stencilOpStencilFail[face] = op; MaterialInstance_setStencilOpStencilFail(pointer, op.index, face.toFFI()); } @override Future setStencilReferenceValue(int value, [StencilFace face = StencilFace.FRONT_AND_BACK]) async { + shadow.stencilReferenceValue[face] = value; MaterialInstance_setStencilReferenceValue(pointer, value, face.toFFI()); } @override Future setStencilWriteEnabled(bool enabled) async { + shadow.stencilWriteEnabled = enabled; MaterialInstance_setStencilWrite(pointer, enabled); } @override Future setCullingMode(CullingMode cullingMode) async { + shadow.cullingMode = cullingMode; MaterialInstance_setCullingMode(pointer, cullingMode.index); ; } @@ -156,22 +209,33 @@ class FFIMaterialInstance extends MaterialInstance> { @override Future setStencilReadMask(int mask) async { + shadow.stencilReadMask = mask; MaterialInstance_setStencilReadMask(pointer, mask); } @override Future setStencilWriteMask(int mask) async { + shadow.stencilWriteMask = mask; MaterialInstance_setStencilWriteMask(pointer, mask); } + /// Destroys the native instance. Safe to call more than once; later calls + /// are no-ops (Filament objects can be released as part of destroying a + /// parent, and a repeated destroy would otherwise touch a freed pointer). Future destroy() async { + if (_destroyed) { + return; + } + _destroyed = true; await withVoidCallback((requestId, cb) { Engine_destroyMaterialInstanceRenderThread(_app.engine, this.pointer, requestId, cb); }); + (_app as FFIFilamentApp).forgetMaterialInstance(this); } @override Future setTransparencyMode(TransparencyMode mode) async { + shadow.transparencyMode = mode; MaterialInstance_setTransparencyMode(pointer, mode.index); } @@ -182,16 +246,19 @@ class FFIMaterialInstance extends MaterialInstance> { @override Future setParameterTexture(String name, covariant FFITexture texture, covariant FFITextureSampler sampler) async { + shadow.parameters[name] = MaterialInstanceTextureBinding(texture, sampler); MaterialInstance_setParameterTexture(pointer, name.toNativeUtf8().cast(), texture.pointer, sampler.pointer); } @override Future setParameterBool(String name, bool value) async { + shadow.parameters[name] = value; MaterialInstance_setParameterBool(pointer, name.toNativeUtf8().cast(), value); } @override Future setParameterMat3(String name, Matrix3 matrix) async { + shadow.parameters[name] = matrix.clone(); MaterialInstance_setParameterMat3(pointer, name.toNativeUtf8().cast(), matrix.storage.address); if (FILAMENT_WASM) { @@ -201,6 +268,7 @@ class FFIMaterialInstance extends MaterialInstance> { @override Future setParameterMat4(String name, Matrix4 matrix) async { + shadow.parameters[name] = matrix.clone(); MaterialInstance_setParameterMat4(pointer, name.toNativeUtf8().cast(), matrix.storage.address); } diff --git a/thermion_dart/lib/src/filament/src/implementation/ffi_renderable_manager.dart b/thermion_dart/lib/src/filament/src/implementation/ffi_renderable_manager.dart index e703482a0..fa2400935 100644 --- a/thermion_dart/lib/src/filament/src/implementation/ffi_renderable_manager.dart +++ b/thermion_dart/lib/src/filament/src/implementation/ffi_renderable_manager.dart @@ -52,12 +52,17 @@ class FFIRenderableManager extends RenderableManager int primitiveIndex, MaterialInstance materialInstance, ) async { - return RenderableManager_setMaterialInstanceAt( + final ffiInstance = materialInstance as FFIMaterialInstance; + final result = RenderableManager_setMaterialInstanceAt( renderableManager, entity, primitiveIndex, - (materialInstance as FFIMaterialInstance).pointer, + ffiInstance.pointer, ); + // Record the attachment so material reloads can still find renderables + // that are not in a scene (the scene scan can't see those). + app.recordMaterialInstanceAttachment(entity, primitiveIndex, ffiInstance); + return result; } @override @@ -95,12 +100,19 @@ class FFIRenderableManager extends RenderableManager return null; } - return FFIMaterialInstance(instancePtr, app); + // Cached wrapper: repeated lookups of one native instance must return + // the same wrapper, or the shadow recording used for material reload + // would be split across wrappers and silently lose values. + return app.getOrCreateMaterialInstanceWrapper(instancePtr); } @override Future clearMaterialInstanceAt(ThermionEntity entity, int primitiveIndex) async { + final previous = await getMaterialInstanceAt(entity, primitiveIndex); RenderableManager_clearMaterialInstanceAt(renderableManager, entity, primitiveIndex); + if (previous != null) { + app.forgetMaterialInstanceAttachment(entity, primitiveIndex, previous as FFIMaterialInstance); + } } // ============================================================================ diff --git a/thermion_dart/lib/src/filament/src/implementation/material_shadow_state.dart b/thermion_dart/lib/src/filament/src/implementation/material_shadow_state.dart new file mode 100644 index 000000000..091cf80a8 --- /dev/null +++ b/thermion_dart/lib/src/filament/src/implementation/material_shadow_state.dart @@ -0,0 +1,171 @@ +import 'package:thermion_dart/thermion_dart.dart'; + +import 'ffi_material.dart'; +import 'ffi_texture.dart'; + +/// A texture bound to a material parameter, plus the sampler it was bound +/// with. Kept as a record so [MaterialInstanceShadowState] can re-bind the +/// exact pair onto a replacement instance. +class MaterialInstanceTextureBinding { + final FFITexture texture; + final FFITextureSampler sampler; + + MaterialInstanceTextureBinding(this.texture, this.sampler); +} + +/// Shadow copy of every mutation applied to a [MaterialInstance]. +/// +/// Filament's MaterialInstance API is write-only: parameter values and raster +/// state cannot be read back. So each Dart setter records the call here, and +/// [applyTo] replays the recording onto a fresh instance. This is what lets +/// reloadMaterialFromBytes rebuild instances that behave identically to the +/// ones they replace. +/// +/// Only the *latest* value of each parameter is kept (a map, not a log); the +/// raster-state fields likewise hold the last value written. Setters that are +/// queries rather than mutations (isStencilWriteEnabled, getTransparencyMode) +/// are not recorded. +class MaterialInstanceShadowState { + /// name -> value. Insertion-ordered so replay matches the order the + /// application originally applied values in. + /// + /// Value types, matching the setter that produced them: + /// - double (float), List<double> of length 2/3/4 (float2/3/4) + /// - List<Vector3> (float3 array) + /// - int, bool + /// - Matrix3, Matrix4 + /// - [MaterialInstanceTextureBinding] + final Map parameters = {}; + + bool? doubleSided; + bool? depthCullingEnabled; + bool? depthWriteEnabled; + SamplerCompareFunction? depthFunc; + bool? stencilWriteEnabled; + int? stencilReadMask; + int? stencilWriteMask; + CullingMode? cullingMode; + TransparencyMode? transparencyMode; + + /// Per-face stencil state. Keyed by face because the setters accept a face + /// argument; FRONT_AND_BACK entries are recorded under their own key. + final Map stencilCompareFunction = {}; + final Map stencilOpDepthFail = {}; + final Map stencilOpDepthStencilPass = {}; + final Map stencilOpStencilFail = {}; + final Map stencilReferenceValue = {}; + + /// Replays every recorded mutation onto [target], in the order recorded + /// (parameters first, then raster state). Recording on [target] is a side + /// effect of calling its setters, so the target ends up with its own copy of + /// this state. + Future applyTo(covariant FFIMaterialInstance target) async { + for (final entry in parameters.entries) { + final value = entry.value; + if (value is double) { + await target.setParameterFloat(entry.key, value); + } else if (value is List) { + switch (value.length) { + case 2: + await target.setParameterFloat2(entry.key, value[0], value[1]); + case 3: + await target.setParameterFloat3(entry.key, value[0], value[1], value[2]); + case 4: + await target.setParameterFloat4(entry.key, value[0], value[1], value[2], value[3]); + default: + throw StateError("Cannot replay float parameter ${entry.key} of ${value.length} components"); + } + } else if (value is List) { + await target.setParameterFloat3Array(entry.key, value); + } else if (value is int) { + await target.setParameterInt(entry.key, value); + } else if (value is bool) { + await target.setParameterBool(entry.key, value); + } else if (value is Matrix3) { + await target.setParameterMat3(entry.key, value); + } else if (value is Matrix4) { + await target.setParameterMat4(entry.key, value); + } else if (value is MaterialInstanceTextureBinding) { + await target.setParameterTexture(entry.key, value.texture, value.sampler); + } else { + throw StateError("Cannot replay parameter ${entry.key} of type ${value.runtimeType}"); + } + } + + // Use ?. to skip state never set on the source instance. + final doubleSided = this.doubleSided; + if (doubleSided != null) { + await target.setDoubleSided(doubleSided); + } + final depthCullingEnabled = this.depthCullingEnabled; + if (depthCullingEnabled != null) { + await target.setDepthCullingEnabled(depthCullingEnabled); + } + final depthWriteEnabled = this.depthWriteEnabled; + if (depthWriteEnabled != null) { + await target.setDepthWriteEnabled(depthWriteEnabled); + } + final depthFunc = this.depthFunc; + if (depthFunc != null) { + await target.setDepthFunc(depthFunc); + } + final stencilWriteEnabled = this.stencilWriteEnabled; + if (stencilWriteEnabled != null) { + await target.setStencilWriteEnabled(stencilWriteEnabled); + } + final stencilReadMask = this.stencilReadMask; + if (stencilReadMask != null) { + await target.setStencilReadMask(stencilReadMask); + } + final stencilWriteMask = this.stencilWriteMask; + if (stencilWriteMask != null) { + await target.setStencilWriteMask(stencilWriteMask); + } + final cullingMode = this.cullingMode; + if (cullingMode != null) { + await target.setCullingMode(cullingMode); + } + final transparencyMode = this.transparencyMode; + if (transparencyMode != null) { + await target.setTransparencyMode(transparencyMode); + } + for (final entry in stencilCompareFunction.entries) { + await target.setStencilCompareFunction(entry.value, entry.key); + } + for (final entry in stencilOpDepthFail.entries) { + await target.setStencilOpDepthFail(entry.value, entry.key); + } + for (final entry in stencilOpDepthStencilPass.entries) { + await target.setStencilOpDepthStencilPass(entry.value, entry.key); + } + for (final entry in stencilOpStencilFail.entries) { + await target.setStencilOpStencilFail(entry.value, entry.key); + } + for (final entry in stencilReferenceValue.entries) { + await target.setStencilReferenceValue(entry.value, entry.key); + } + } + + /// Copies this state into a fresh [MaterialInstanceShadowState] without + /// touching any instance. Used when a material is reloaded and the caller + /// wants to keep a hand-made recording for the next reload. + MaterialInstanceShadowState clone() { + final copy = MaterialInstanceShadowState(); + copy.parameters.addAll(parameters); + copy.doubleSided = doubleSided; + copy.depthCullingEnabled = depthCullingEnabled; + copy.depthWriteEnabled = depthWriteEnabled; + copy.depthFunc = depthFunc; + copy.stencilWriteEnabled = stencilWriteEnabled; + copy.stencilReadMask = stencilReadMask; + copy.stencilWriteMask = stencilWriteMask; + copy.cullingMode = cullingMode; + copy.transparencyMode = transparencyMode; + copy.stencilCompareFunction.addAll(stencilCompareFunction); + copy.stencilOpDepthFail.addAll(stencilOpDepthFail); + copy.stencilOpDepthStencilPass.addAll(stencilOpDepthStencilPass); + copy.stencilOpStencilFail.addAll(stencilOpStencilFail); + copy.stencilReferenceValue.addAll(stencilReferenceValue); + return copy; + } +} diff --git a/thermion_dart/lib/src/filament/src/interface/filament_app.dart b/thermion_dart/lib/src/filament/src/interface/filament_app.dart index e1ae9066d..5633aa9d9 100644 --- a/thermion_dart/lib/src/filament/src/interface/filament_app.dart +++ b/thermion_dart/lib/src/filament/src/interface/filament_app.dart @@ -128,6 +128,42 @@ abstract class FilamentApp { // Future createMaterial(Uint8List data); + /// Compiles .mat [matSource] into a .filamat package at runtime — the + /// same container [createMaterial] accepts — using the Filament material + /// compiler linked into the engine library (matc's pipeline: parse the + /// material definition, generate + optimize shaders for the target). + /// + /// Phase 1 of docs/research/runtime-material-compile.md. Currently + /// supported on desktop (linux/macOS/Windows); other platforms throw + /// [UnsupportedError]. + /// + /// [targetApi] selects which graphics APIs the package carries shaders + /// for; null derives it from the engine's active backend (recommended, and + /// what a reload-and-continue workflow wants). [platform] defaults to + /// generating both desktop and mobile variants. [optimization] mirrors + /// matc's -O flags (default PERFORMANCE, like release materials). + /// + /// [defines] are passed to the shader preprocessor (matc's -D). [matSource] + /// must not contain unresolved #include directives: [includePaths] lists + /// directories to resolve them from, and includes are flattened by this + /// library before compiling (circular includes are an error). + /// + /// [embedSource] controls whether the .mat source is embedded in the + /// package (matc's -e / no-embed-source); embedded source makes packages + /// self-describing for tooling at a small size cost. + /// + /// Throws [MaterialCompileException] with the compiler's message when the + /// source fails to parse or the shaders fail to build. + Future compileMaterial( + String matSource, { + MaterialCompilePlatform platform = MaterialCompilePlatform.all, + Set? targetApi, + MaterialOptimization optimization = MaterialOptimization.performance, + Map defines = const {}, + List includePaths = const [], + bool embedSource = true, + }); + // Future createUbershaderMaterialInstance({ bool doubleSided = false, @@ -269,6 +305,42 @@ abstract class FilamentApp { // Future setMaterialInstanceAt(ThermionEntity entity, int primitiveIndex, MaterialInstance materialInstance); + /// Replaces [oldMaterial] with a [Material] built from [materialBytes] + /// (the same container [createMaterial] accepts), keeping renderables + /// visually continuous. + /// + /// This is the reload path from the runtime-material-compile design + /// (docs/research/runtime-material-compile.md, section 4.1): Filament does + /// not allow re-parenting a MaterialInstance to another Material, so the + /// swap is: build the new material, create one replacement instance per + /// distinct instance of the old material, replay each old instance's + /// recorded state onto its replacement, point every affected renderable + /// primitive at the replacement, then destroy the old instances and the old + /// material on the render thread. + /// + /// Parameter and raster state are replayed from the shadow recording kept + /// by the MaterialInstance wrappers: every setParameter*/set* call made + /// through this library is captured. Values set only through native code + /// (none today) or parameters relying on the material's declared defaults + /// cannot be recovered; instances whose state was never touched are + /// re-created with the new material's defaults. + /// + /// Set [destroyOld] to false to keep the old material alive (e.g. to fade + /// between materials yourself); you then own it and its instances. + Future reloadMaterialFromBytes(Material oldMaterial, Uint8List materialBytes, {bool destroyOld = true}); + + /// Returns every renderable primitive, across all scenes, currently drawn + /// with an instance of [material] — including instances attached by asset + /// loaders outside this library (found by scanning the scene) and instances + /// attached via [setMaterialInstanceAt] that are not yet in a scene + /// (found from the app's own records). + /// + /// This is the entity-scan helper of the reload design (section 4.1, L2). + /// It is exposed separately from [reloadMaterialFromBytes] because callers + /// may want the list of affected entities for their own bookkeeping (for + /// example to re-run per-entity material setup after a reload). + Future> findRenderablesUsingMaterial(Material material); + // Returns all valid swapchains. Future> getSwapChains(); @@ -449,3 +521,44 @@ abstract class FilamentApp { // If [meshName] is specified, only extracts data for that specific mesh. Future parseGltf(Uint8List data, {String? meshName}); } + +/// One hit from [FilamentApp.findRenderablesUsingMaterial]: a renderable +/// primitive currently drawn with a material instance that belongs to a given +/// material. +class MaterialInstanceUse { + /// The renderable entity. Combine with [primitiveIndex] for + /// [FilamentApp.setMaterialInstanceAt]. + final ThermionEntity entity; + + /// Which primitive of [entity]'s renderable uses the material instance. + final int primitiveIndex; + + /// The instance in use. After a material reload this refers to a retired + /// instance; re-fetch uses from the app instead of caching them. + final MaterialInstance materialInstance; + + MaterialInstanceUse(this.entity, this.primitiveIndex, this.materialInstance); +} + +/// Which platform flavor of shaders a runtime compile generates +/// (matc's -g/-p selection). Mirrors filamat's Platform. +enum MaterialCompilePlatform { desktop, mobile, all } + +/// Which graphics API a runtime compile generates shaders for (matc's -a). +/// Pass a Set to generate several; omit [FilamentApp.compileMaterial]'s +/// targetApi to derive it from the engine's backend. +enum MaterialTargetApi { opengl, vulkan, metal, webgpu } + +/// Optimization level for a runtime compile (matc's -O). +enum MaterialOptimization { none, preprocessor, size, performance } + +/// Thrown by [FilamentApp.compileMaterial] when the .mat source fails to +/// parse or its shaders fail to build. The message comes from the compiler. +class MaterialCompileException implements Exception { + final String message; + + MaterialCompileException(this.message); + + @override + String toString() => "MaterialCompileException: $message"; +} diff --git a/thermion_dart/native/include/ThermionWin32.h b/thermion_dart/native/include/ThermionWin32.h index faa6d4e8b..726859609 100644 --- a/thermion_dart/native/include/ThermionWin32.h +++ b/thermion_dart/native/include/ThermionWin32.h @@ -12,6 +12,19 @@ #pragma comment(lib, "bluegl.lib") #pragma comment(lib, "backend.lib") #pragma comment(lib, "filamat.lib") +// The .mat parser for runtime material compilation (Engine_compileMaterial). +// matp must precede utils.lib in link order (it references utils symbols); +// unlike the Linux/macOS archives, the Windows filamat/matp do not bundle +// glslang/SPIRV, so the shader-compiler libraries they reference are linked +// here explicitly. +#pragma comment(lib, "matp.lib") +#pragma comment(lib, "glslang.lib") +#pragma comment(lib, "SPIRV.lib") +#pragma comment(lib, "SPIRV-Tools.lib") +#pragma comment(lib, "SPIRV-Tools-opt.lib") +#pragma comment(lib, "spirv-cross-core.lib") +#pragma comment(lib, "spirv-cross-glsl.lib") +#pragma comment(lib, "spirv-cross-msl.lib") #pragma comment(lib, "geometry.lib") #pragma comment(lib, "utils.lib") #pragma comment(lib, "filabridge.lib") diff --git a/thermion_dart/native/include/c_api/TEngine.h b/thermion_dart/native/include/c_api/TEngine.h index f381668c3..3ce1c8fa1 100644 --- a/thermion_dart/native/include/c_api/TEngine.h +++ b/thermion_dart/native/include/c_api/TEngine.h @@ -58,6 +58,103 @@ EMSCRIPTEN_KEEPALIVE void Engine_flushAndWait(TEngine *tEngine); EMSCRIPTEN_KEEPALIVE void Engine_execute(TEngine *tEngine); EMSCRIPTEN_KEEPALIVE TMaterial *Engine_buildMaterial(TEngine *tEngine, const uint8_t* materialData, size_t length); + +// --------------------------------------------------------------------------- +// Runtime material compilation (.mat source -> .filamat package). +// +// Phase 1 of docs/research/runtime-material-compile.md. The real +// implementation is only linked into desktop builds (linux/macos/windows, +// where the artifact ships libfilamat + libmatp); every other platform gets +// a stub that fails with an explanatory message. The header declares the API +// unconditionally so bindings generate everywhere. +// --------------------------------------------------------------------------- + +enum TMaterialPlatform { + // Values match filamat::MaterialBuilderBase::Platform. + T_MATERIAL_PLATFORM_DESKTOP = 0, + T_MATERIAL_PLATFORM_MOBILE = 1, + T_MATERIAL_PLATFORM_ALL = 2, +}; +typedef enum TMaterialPlatform TMaterialPlatform; + +enum TMaterialTargetApi { + // Bit values match filamat::MaterialBuilderBase::TargetApi and may be + // OR-ed together. + T_MATERIAL_TARGET_API_OPENGL = 0x01, + T_MATERIAL_TARGET_API_VULKAN = 0x02, + T_MATERIAL_TARGET_API_METAL = 0x04, + T_MATERIAL_TARGET_API_WEBGPU = 0x08, + T_MATERIAL_TARGET_API_ALL = 0x0F, + // Derive the target from the engine's active backend (recommended). + T_MATERIAL_TARGET_API_FROM_ENGINE = 0x100, +}; +typedef enum TMaterialTargetApi TMaterialTargetApi; + +enum TMaterialOptimization { + // Values match filamat::MaterialBuilderBase::Optimization. + T_MATERIAL_OPTIMIZATION_NONE = 0, + T_MATERIAL_OPTIMIZATION_PREPROCESSOR = 1, + T_MATERIAL_OPTIMIZATION_SIZE = 2, + T_MATERIAL_OPTIMIZATION_PERFORMANCE = 3, +}; +typedef enum TMaterialOptimization TMaterialOptimization; + +/// Compiles .mat [matSource] ([length] bytes, not necessarily +/// NUL-terminated) into a filamat package, synchronously on the calling +/// thread. #include directives must already be resolved by the caller (the +/// Dart layer flattens them). +/// +/// [platform]/[targetApi]/[optimization] select the compilation targets; +/// pass T_MATERIAL_TARGET_API_FROM_ENGINE to derive targetApi from the +/// engine's backend. +/// +/// [definesJson] is either nullptr or a flat JSON object of preprocessor +/// defines, e.g. `{"OCCLUSION": "1"}`. Only string keys/values and basic +/// backslash escapes are supported. +/// +/// [embedSource] controls whether the .mat source is embedded in the +/// package (matc's no-embed-source flag). +/// +/// On success returns a malloc'd buffer of *outSize bytes that the caller +/// must release with [Engine_freeCompiledMaterial]. On failure returns +/// nullptr and writes a NUL-terminated message into [outError] (capacity +/// [outErrorCap]). +EMSCRIPTEN_KEEPALIVE const uint8_t *Engine_compileMaterial( + TEngine *tEngine, + const char *matSource, + size_t length, + TMaterialPlatform platform, + TMaterialTargetApi targetApi, + TMaterialOptimization optimization, + const char *definesJson, + uint8_t embedSource, + char *outError, + size_t outErrorCap, + size_t *outSize); + +/// Releases a buffer returned by [Engine_compileMaterial]. +EMSCRIPTEN_KEEPALIVE void Engine_freeCompiledMaterial(const uint8_t *data); + +/// As [Engine_compileMaterial], but the work runs on the engine's render +/// thread. The task writes the malloc'd package to *[outData] and its size to +/// *[outSize] (release it with [Engine_freeCompiledMaterial]), or nullptr on +/// failure with the message in [outError], then invokes [onComplete] with +/// [requestId]. +EMSCRIPTEN_KEEPALIVE void Engine_compileMaterialRenderThread( + TEngine *tEngine, + const char *matSource, + size_t length, + TMaterialPlatform platform, + TMaterialTargetApi targetApi, + TMaterialOptimization optimization, + const char *definesJson, + uint8_t embedSource, + char *outError, + size_t outErrorCap, + const uint8_t **outData, + size_t *outSize, + uint32_t requestId, + void (*onComplete)(int32_t requestId)); EMSCRIPTEN_KEEPALIVE void Engine_destroyMaterial(TEngine *tEngine, TMaterial *tMaterial); EMSCRIPTEN_KEEPALIVE void Engine_destroyMaterialInstance(TEngine *tEngine, TMaterialInstance *tMaterialInstance); EMSCRIPTEN_KEEPALIVE TScene *Engine_createScene(TEngine *tEngine); diff --git a/thermion_dart/native/include/c_api/TMaterialInstance.h b/thermion_dart/native/include/c_api/TMaterialInstance.h index 7be97c710..7a3c7f7b8 100644 --- a/thermion_dart/native/include/c_api/TMaterialInstance.h +++ b/thermion_dart/native/include/c_api/TMaterialInstance.h @@ -96,6 +96,7 @@ extern "C" EMSCRIPTEN_KEEPALIVE TMaterial *Material_createBoneOverlayMaterial(TEngine *tEngine); EMSCRIPTEN_KEEPALIVE bool Material_hasParameter(TMaterial *tMaterial, const char *propertyName); EMSCRIPTEN_KEEPALIVE bool MaterialInstance_isStencilWriteEnabled(TMaterialInstance *materialInstance); + EMSCRIPTEN_KEEPALIVE TMaterial *MaterialInstance_getMaterial(TMaterialInstance *materialInstance); EMSCRIPTEN_KEEPALIVE void MaterialInstance_setStencilWrite(TMaterialInstance *materialInstance, bool enabled); EMSCRIPTEN_KEEPALIVE void MaterialInstance_setCullingMode(TMaterialInstance *materialInstance, TCullingMode culling); EMSCRIPTEN_KEEPALIVE void MaterialInstance_setDoubleSided(TMaterialInstance *materialInstance, bool doubleSided); diff --git a/thermion_dart/native/include/c_api/TScene.h b/thermion_dart/native/include/c_api/TScene.h index df0182aa0..3f4981b3a 100644 --- a/thermion_dart/native/include/c_api/TScene.h +++ b/thermion_dart/native/include/c_api/TScene.h @@ -17,6 +17,16 @@ EMSCRIPTEN_KEEPALIVE TSkybox* Scene_getSkybox(TScene* tScene); EMSCRIPTEN_KEEPALIVE void Scene_setIndirectLight(TScene* tScene, TIndirectLight *tIndirectLight); EMSCRIPTEN_KEEPALIVE void Scene_addFilamentAsset(TScene* tScene, TFilamentAsset *asset); +/// Walks every renderable primitive in the scene and records the ones whose +/// current MaterialInstance belongs to [tMaterial]. +/// +/// Returns the TOTAL number of matches (which may exceed [capacity]). When +/// [outEntities]/[outPrimitives]/[outInstances] are non-null, up to +/// [capacity] matches are written to them. Call once with null buffers to +/// size the output, then again to fetch it. +EMSCRIPTEN_KEEPALIVE size_t Scene_scanForMaterial(TScene* tScene, TRenderableManager *tRenderableManager, TMaterial *tMaterial, + EntityId *outEntities, uint32_t *outPrimitives, TMaterialInstance **outInstances, size_t capacity); + #ifdef __cplusplus } #endif diff --git a/thermion_dart/native/src/c_api/TEngine.cpp b/thermion_dart/native/src/c_api/TEngine.cpp index 7643845d6..2d91d05a7 100644 --- a/thermion_dart/native/src/c_api/TEngine.cpp +++ b/thermion_dart/native/src/c_api/TEngine.cpp @@ -35,9 +35,196 @@ #include #include +#ifdef THERMION_RUNTIME_MATERIAL_COMPILE +#include +#include +#include +#include +#include + +// The prebuilt artifact's include tree does not ship utils/JobSystem.h; a +// forward declaration is all Engine_compileMaterial needs (it only passes +// engine->getJobSystem() by reference). +namespace utils +{ + class JobSystem; +} + +#include +#include +#include +#include +#include +#include +#endif + #include "Log.hpp" #include "MathUtils.hpp" +namespace thermion +{ + + void writeError(char *outError, size_t outErrorCap, const char *message) + { + if (outError == nullptr || outErrorCap == 0) + { + return; + } + snprintf(outError, outErrorCap, "%s", message); + } +#ifdef THERMION_RUNTIME_MATERIAL_COMPILE + // ===================================================================== + // Runtime material compilation (Phase 1 of + // docs/research/runtime-material-compile.md). + // + // The proven sequence, mirroring matc: MaterialBuilder::init() once, + // matp::MaterialParser::parse() of the (already include-resolved) + // source into a MaterialBuilder, then MaterialBuilder::build() on the + // engine's JobSystem. + // ===================================================================== + + /// Minimal matp::Config for runtime compilation. matc fills this from + /// command-line flags; we only need the platform/target/optimization + /// selection — output/input sinks and the string forms are unused by + /// MaterialParser::parse. + class RuntimeMaterialConfig : public matp::Config + { + public: + RuntimeMaterialConfig( + Platform platform, + TargetApi targetApi, + Optimization optimization, + bool includeSourceMaterial) + { + mPlatform = platform; + mTargetApi = targetApi; + mOptimizationLevel = optimization; + mIncludeSourceMaterial = includeSourceMaterial; + // Engine_create pins the engine to FEATURE_LEVEL_1; generate + // for the same level so packages always load. + mFeatureLevel = filament::backend::FeatureLevel::FEATURE_LEVEL_1; + } + + Output *getOutput() const noexcept override { return nullptr; } + Input *getInput() const noexcept override { return nullptr; } + std::string toString() const noexcept override { return "thermion_runtime_compile"; } + std::string toPIISafeString() const noexcept override { return "thermion_runtime_compile"; } + }; + + /// Serializes every compile. MaterialBuilder::init()/shutdown() are + /// refcounted but glslang's global initialization is not thread-safe, + /// so the first init and all builds share one mutex. We never call + /// shutdown — the builder state lives for the process lifetime, which + /// also removes any racing with a concurrent engine teardown. + std::mutex &materialCompileMutex() + { + static std::mutex mutex; + return mutex; + } + + /// Parses a flat JSON object of string -> string, e.g. + /// {"OCCLUSION": "1", "TINT": "0.5"}. Accepts whitespace between + /// tokens and the backslash escapes \" \\ \/ \n \t \r. Returns false + /// on malformed input (the whole compile then fails with an error + /// pointing at the defines). + bool parseDefinesJson(const char *json, std::vector> &out) + { + const char *p = json; + auto skipWhitespace = [&p]() + { + while (*p == ' ' || *p == '\t' || *p == '\n' || *p == '\r') + { + p++; + } + }; + auto parseString = [&](std::string &result) -> bool + { + if (*p != '"') + { + return false; + } + p++; + result.clear(); + while (*p != '"') + { + if (*p == '\0') + { + return false; + } + if (*p == '\\') + { + p++; + switch (*p) + { + case '"': result += '"'; break; + case '\\': result += '\\'; break; + case '/': result += '/'; break; + case 'n': result += '\n'; break; + case 't': result += '\t'; break; + case 'r': result += '\r'; break; + default: return false; + } + } + else + { + result += *p; + } + p++; + } + p++; // closing quote + return true; + }; + + skipWhitespace(); + if (*p != '{') + { + return false; + } + p++; + skipWhitespace(); + if (*p == '}') + { + return true; + } + while (true) + { + skipWhitespace(); + std::string key; + if (!parseString(key)) + { + return false; + } + skipWhitespace(); + if (*p != ':') + { + return false; + } + p++; + skipWhitespace(); + std::string value; + if (!parseString(value)) + { + return false; + } + out.emplace_back(std::move(key), std::move(value)); + skipWhitespace(); + if (*p == ',') + { + p++; + continue; + } + if (*p == '}') + { + return true; + } + return false; + } + } + +#endif + +} + #ifdef __cplusplus namespace thermion { @@ -52,6 +239,7 @@ namespace thermion const char *RenderThread_getActiveCanvasSelector(); #endif + EMSCRIPTEN_KEEPALIVE uint64_t TSWAP_CHAIN_CONFIG_TRANSPARENT = filament::backend::SWAP_CHAIN_CONFIG_TRANSPARENT; EMSCRIPTEN_KEEPALIVE uint64_t TSWAP_CHAIN_CONFIG_READABLE = filament::backend::SWAP_CHAIN_CONFIG_READABLE; EMSCRIPTEN_KEEPALIVE uint64_t TSWAP_CHAIN_CONFIG_APPLE_CVPIXELBUFFER = filament::backend::SWAP_CHAIN_CONFIG_APPLE_CVPIXELBUFFER; @@ -303,6 +491,170 @@ namespace thermion engine->destroy(mi); } +#ifdef THERMION_RUNTIME_MATERIAL_COMPILE + EMSCRIPTEN_KEEPALIVE const uint8_t *Engine_compileMaterial( + TEngine *tEngine, + const char *matSource, + size_t length, + TMaterialPlatform platform, + TMaterialTargetApi targetApi, + TMaterialOptimization optimization, + const char *definesJson, + uint8_t embedSource, + char *outError, + size_t outErrorCap, + size_t *outSize) + { + if (outSize != nullptr) + { + *outSize = 0; + } + auto *engine = reinterpret_cast(tEngine); + + using BuilderPlatform = filamat::MaterialBuilder::Platform; + using BuilderTargetApi = filamat::MaterialBuilder::TargetApi; + using BuilderOptimization = filamat::MaterialBuilder::Optimization; + + if (platform > T_MATERIAL_PLATFORM_ALL) + { + writeError(outError, outErrorCap, "invalid platform"); + return nullptr; + } + if (optimization > T_MATERIAL_OPTIMIZATION_PERFORMANCE) + { + writeError(outError, outErrorCap, "invalid optimization level"); + return nullptr; + } + + BuilderTargetApi builderTargetApi; + uint32_t resolved = targetApi; + if (targetApi == T_MATERIAL_TARGET_API_FROM_ENGINE) + { + builderTargetApi = filamat::targetApiFromBackend(engine->getBackend()); + } + else + { + if ((targetApi & ~T_MATERIAL_TARGET_API_ALL) != 0) + { + writeError(outError, outErrorCap, "invalid target API flags"); + return nullptr; + } + builderTargetApi = (BuilderTargetApi)(resolved); + } + + // Everything below shares one mutex: MaterialBuilder::init()'s + // glslang setup is not thread-safe, and builds on one engine's + // JobSystem should not race each other. + std::lock_guard lock(materialCompileMutex()); + static bool materialBuilderInitialized = false; + if (!materialBuilderInitialized) + { + filamat::MaterialBuilder::init(); + materialBuilderInitialized = true; + } + + std::vector> defines; + if (definesJson != nullptr && definesJson[0] != '\0') + { + if (!parseDefinesJson(definesJson, defines)) + { + writeError(outError, outErrorCap, + "definesJson must be a flat JSON object of strings, e.g. {\"KEY\": \"value\"}"); + return nullptr; + } + } + + // parse() takes a non-const buffer (it rewrites the source in + // place when applying substitutions). + std::unique_ptr buffer(new char[length + 1]); + memcpy((void *)buffer.get(), matSource, length); + ((char *)buffer.get())[length] = '\0'; + ssize_t size = (ssize_t)length; + + RuntimeMaterialConfig config( + (BuilderPlatform)platform, builderTargetApi, (BuilderOptimization)optimization, + embedSource != 0); + + filamat::MaterialBuilder builder; + builder.platform(config.getPlatform()) + .targetApi(config.getTargetApi()) + .optimization(config.getOptimizationLevel()) + .featureLevel(config.getFeatureLevel()) + .materialSource(std::string_view(buffer.get(), length)); + for (const auto &define : defines) + { + builder.shaderDefine(define.first.c_str(), define.second.c_str()); + } + + matp::MaterialParser parser; + utils::Status status = parser.parse(builder, config, size, buffer); + if (status.getCode() != utils::StatusCode::OK) + { + auto message = status.getMessage(); + char formatted[512]; + snprintf(formatted, sizeof(formatted), "material parse failed: %.*s", + (int)message.size(), message.data()); + writeError(outError, outErrorCap, formatted); + return nullptr; + } + + filamat::Package package = builder.build(engine->getJobSystem()); + if (!package.isValid()) + { + // Shader compilation diagnostics are emitted to the log by + // glslang; there is no in-band channel for them. + writeError(outError, outErrorCap, + "material build failed (see engine log for shader diagnostics)"); + return nullptr; + } + + uint8_t *result = (uint8_t *)malloc(package.getSize()); + if (result == nullptr) + { + writeError(outError, outErrorCap, "out of memory copying package"); + return nullptr; + } + memcpy(result, package.getData(), package.getSize()); + if (outSize != nullptr) + { + *outSize = package.getSize(); + } + return result; + } + + EMSCRIPTEN_KEEPALIVE void Engine_freeCompiledMaterial(const uint8_t *data) + { + free((void *)data); + } +#else + EMSCRIPTEN_KEEPALIVE const uint8_t *Engine_compileMaterial( + TEngine *tEngine, + const char *matSource, + size_t length, + TMaterialPlatform platform, + TMaterialTargetApi targetApi, + TMaterialOptimization optimization, + const char *definesJson, + uint8_t embedSource, + char *outError, + size_t outErrorCap, + size_t *outSize) + { + // filamat/matp are not linked into this build (see + // docs/research/runtime-material-compile.md section 5: Phase 1 + // covers desktop; mobile/web artifacts do not ship libmatp). + writeError(outError, outErrorCap, + "runtime material compilation is not supported on this platform"); + if (outSize != nullptr) + { + *outSize = 0; + } + return nullptr; + } + + EMSCRIPTEN_KEEPALIVE void Engine_freeCompiledMaterial(const uint8_t *data) {} +#endif + EMSCRIPTEN_KEEPALIVE void Engine_destroyTexture(TEngine *tEngine, TTexture *tTexture) { auto *engine = reinterpret_cast(tEngine); diff --git a/thermion_dart/native/src/c_api/TMaterialInstance.cpp b/thermion_dart/native/src/c_api/TMaterialInstance.cpp index 20f927d36..d0e9d3904 100644 --- a/thermion_dart/native/src/c_api/TMaterialInstance.cpp +++ b/thermion_dart/native/src/c_api/TMaterialInstance.cpp @@ -29,6 +29,16 @@ namespace thermion { #endif + EMSCRIPTEN_KEEPALIVE TMaterial *MaterialInstance_getMaterial(TMaterialInstance *tMaterialInstance) + { + auto *materialInstance = reinterpret_cast(tMaterialInstance); + // getMaterial returns const Material*; callers only compare the + // pointer against other material pointers, so dropping the + // qualifier is safe here. + auto *material = const_cast(materialInstance->getMaterial()); + return reinterpret_cast(material); + } + EMSCRIPTEN_KEEPALIVE TMaterialInstance *Material_createInstance(TMaterial *tMaterial) { auto *material = reinterpret_cast(tMaterial); diff --git a/thermion_dart/native/src/c_api/TScene.cpp b/thermion_dart/native/src/c_api/TScene.cpp index abf9db334..0af534b2e 100644 --- a/thermion_dart/native/src/c_api/TScene.cpp +++ b/thermion_dart/native/src/c_api/TScene.cpp @@ -4,6 +4,8 @@ #include #include #include +#include +#include #include #include #include @@ -55,12 +57,61 @@ namespace thermion scene->setIndirectLight(light); } - EMSCRIPTEN_KEEPALIVE void Scene_addFilamentAsset(TScene* tScene, TFilamentAsset *tAsset) { + EMSCRIPTEN_KEEPALIVE void Scene_addFilamentAsset(TScene* tScene, TFilamentAsset *tAsset) { auto *scene = reinterpret_cast(tScene); auto *asset = reinterpret_cast(tAsset); scene->addEntities(asset->getEntities(), asset->getEntityCount()); } + EMSCRIPTEN_KEEPALIVE size_t Scene_scanForMaterial(TScene *tScene, TRenderableManager *tRenderableManager, + TMaterial *tMaterial, EntityId *outEntities, uint32_t *outPrimitives, + TMaterialInstance **outInstances, size_t capacity) + { + auto *scene = reinterpret_cast(tScene); + auto *renderableManager = reinterpret_cast(tRenderableManager); + auto *material = reinterpret_cast(tMaterial); + + size_t count = 0; + scene->forEach( + [&](utils::Entity entity) + { + if (!renderableManager->hasComponent(entity)) + { + return; + } + auto renderable = renderableManager->getInstance(entity); + auto primitiveCount = renderableManager->getPrimitiveCount(renderable); + for (size_t primitive = 0; primitive < primitiveCount; primitive++) + { + auto *materialInstance = renderableManager->getMaterialInstanceAt(renderable, primitive); + if (materialInstance == nullptr || materialInstance->getMaterial() != material) + { + continue; + } + // Each output buffer is optional so callers can request + // a subset (e.g. entities+primitives but not + // instances); guard them individually. + if (count < capacity) + { + if (outEntities != nullptr) + { + outEntities[count] = (EntityId)entity.getId(); + } + if (outPrimitives != nullptr) + { + outPrimitives[count] = (uint32_t)primitive; + } + if (outInstances != nullptr) + { + outInstances[count] = reinterpret_cast(materialInstance); + } + } + count++; + } + }); + return count; + } + #ifdef __cplusplus } diff --git a/thermion_dart/native/src/c_api/ThermionDartRenderThreadApi.cpp b/thermion_dart/native/src/c_api/ThermionDartRenderThreadApi.cpp index 804327f72..72034de3f 100644 --- a/thermion_dart/native/src/c_api/ThermionDartRenderThreadApi.cpp +++ b/thermion_dart/native/src/c_api/ThermionDartRenderThreadApi.cpp @@ -626,6 +626,49 @@ extern "C" auto fut = rt->addTask(lambda); } + // Runs the .mat -> .filamat compile on the engine's render thread (the + // build uses the engine's JobSystem, so it is serialized with other engine + // work). Follows the readPixels pattern: the task fills [outData]/[outSize] + // (the buffer stays allocated until the caller releases it with + // Engine_freeCompiledMaterial) and then notifies [onComplete] with + // [requestId]. On failure *outData is set to nullptr and the message is in + // [outError]. + EMSCRIPTEN_KEEPALIVE void Engine_compileMaterialRenderThread( + TEngine *tEngine, + const char *matSource, + size_t length, + TMaterialPlatform platform, + TMaterialTargetApi targetApi, + TMaterialOptimization optimization, + const char *definesJson, + uint8_t embedSource, + char *outError, + size_t outErrorCap, + const uint8_t **outData, + size_t *outSize, + uint32_t requestId, + VoidCallback onComplete) + { + auto *rt = RT(tEngine); + std::packaged_task lambda( + [=]() mutable + { + size_t size = 0; + const uint8_t *data = Engine_compileMaterial( + tEngine, matSource, length, platform, targetApi, optimization, definesJson, embedSource, outError, outErrorCap, &size); + if (outData != nullptr) + { + *outData = data; + } + if (outSize != nullptr) + { + *outSize = size; + } + PROXY(onComplete(requestId)); + }); + auto fut = rt->addTask(lambda); + } + EMSCRIPTEN_KEEPALIVE void Engine_createFenceRenderThread(TEngine *tEngine, void (*onComplete)(TFence *)) { auto *rt = RT(tEngine); diff --git a/thermion_dart/test/material_compile_tests.dart b/thermion_dart/test/material_compile_tests.dart new file mode 100644 index 000000000..7b816ba09 --- /dev/null +++ b/thermion_dart/test/material_compile_tests.dart @@ -0,0 +1,274 @@ +import 'dart:io'; + +import 'package:path/path.dart' as p; +import 'package:test/test.dart'; +import 'package:thermion_dart/thermion_dart.dart'; + +import 'helpers.dart'; + +/// Returns the RGBA float at (x, y) of a captured float pixel buffer. +List pixelAt(Float32List buffer, int width, int height, int x, int y) { + final offset = (y * width + x) * 4; + return [buffer[offset], buffer[offset + 1], buffer[offset + 2], buffer[offset + 3]]; +} + +/// Pulls the parameter names out of a .mat source's `parameters` block, so a +/// golden compile can be checked for more than "it didn't throw". +Set parameterNames(String source) { + final blockStart = source.indexOf("parameters"); + if (blockStart < 0) { + return {}; + } + final blockEnd = source.indexOf("]", blockStart); + final block = source.substring(blockStart, blockEnd < 0 ? source.length : blockEnd); + return RegExp(r"name\s*:\s*([A-Za-z_][A-Za-z0-9_]*)").allMatches(block).map((m) => m.group(1)!).toSet(); +} + +/// A minimal parameterised unlit material, with [fragmentExtra] spliced into +/// the fragment shader so tests can vary the compiled output. +String colorMaterial(String fragmentExtra) => + """ +material { + name : RuntimeCompileColor, + requires : [ position ], + parameters : [ + { + type : float4, + name : color + } + ], + shadingModel : unlit, + blending : opaque, + culling : none, +} +fragment { + void material(inout MaterialInputs material) { + prepareMaterial(material); + material.baseColor = materialParams.color; + $fragmentExtra + } +} +"""; + +void main() async { + final testHelper = TestHelper("material_compile"); + await testHelper.setup(); + + final app = FilamentApp.instance!; + + // The shipped .mat sources — exactly what materials/build.sh compiles. + // (materials/ also holds unlit/depth_sampler/vdtm sources that the build + // does not ship; vdtm.mat is outright broken — `z` declared inside an if + // block and used outside — and would fail under matc too.) + final workspaceMaterials = p.normalize(p.join(testHelper.assetsDir, "..", "..", "materials")); + final shippedNames = [ + "bone_overlay", + "capture_uv", + "edge_outline", + "gizmo", + "grid", + "image", + "linear_depth", + "silhouette", + "translation_axis", + "unlit_fixed_size", + "wireframe", + ]; + final exampleMaterials = [ + "customattributes.mat", + "solidcolor.mat", + "viewspace.mat", + ].map((name) => p.join(testHelper.assetsDir, name)).toList(); + final allShipped = [...shippedNames.map((name) => p.join(workspaceMaterials, "$name.mat")), ...exampleMaterials]; + + test("golden: runtime compile accepts every shipped .mat", () async { + await testHelper.withViewer((viewer) async { + final failures = []; + for (final path in allShipped) { + final source = File(path).readAsStringSync(); + try { + final compiled = await app.compileMaterial(source, includePaths: [workspaceMaterials]); + if (compiled.isEmpty) { + failures.add("$path compiled to an empty package"); + continue; + } + final material = await app.createMaterial(compiled); + for (final param in parameterNames(source)) { + if (!await material.hasParameter(param)) { + failures.add("$path lost parameter $param in the runtime compile"); + } + } + await material.destroy(); + } catch (e) { + failures.add("$path: $e"); + } + } + // Report every failing file at once: a single thrown exception would + // hide the state of the files after it. + expect(failures, isEmpty, reason: failures.join("\n")); + }); + }); + + test("parse errors surface the compiler's message", () async { + await testHelper.withViewer((viewer) async { + await expectLater( + app.compileMaterial("material { this is not a valid material }"), + throwsA(isA().having((e) => e.message, "message", isNotEmpty)), + ); + }); + }); + + test("explicit target APIs produce loadable packages", () async { + await testHelper.withViewer((viewer) async { + // Compile for a single backend rather than deriving from the engine — + // the output must still be a valid package for Material::Builder. + final compiled = await app.compileMaterial( + colorMaterial(""), + targetApi: {MaterialTargetApi.opengl}, + platform: MaterialCompilePlatform.desktop, + optimization: MaterialOptimization.size, + ); + final material = await app.createMaterial(compiled); + expect(await material.hasParameter("color"), isTrue); + await material.destroy(); + }); + }); + + test("defines reach the shader preprocessor", () async { + await testHelper.withViewer((viewer) async { + final source = """ +material { + name : DefinesMaterial, + requires : [ position ], + parameters : [ + { + type : float, + name : factor + } + ], + shadingModel : unlit, + blending : opaque, + culling : none, +} +fragment { + void material(inout MaterialInputs material) { + prepareMaterial(material); +#ifdef TINT_RED + material.baseColor = float4(1.0, 0.0, 0.0, 1.0); +#else + material.baseColor = float4(0.0, 0.0, 1.0, 1.0); +#endif + } +} +"""; + final withoutDefine = await app.compileMaterial(source); + final withDefine = await app.compileMaterial(source, defines: {"TINT_RED": "1"}); + expect(withoutDefine, isNotEmpty); + expect(withDefine, isNotEmpty); + // Both variants load; they are different packages (different shaders). + expect(withDefine, isNot(equals(withoutDefine))); + + final material = await app.createMaterial(withDefine); + expect(await material.hasParameter("factor"), isTrue); + await material.destroy(); + }); + }); + + group("include resolution", () { + late Directory tmp; + + setUp(() { + tmp = Directory.systemTemp.createTempSync("thermion_includes"); + }); + + tearDown(() { + tmp.deleteSync(recursive: true); + }); + + test("nested includes are flattened", () async { + await testHelper.withViewer((viewer) async { + // Includes live inside shader blocks (matp's grammar only accepts + // the material document at the top level — same restriction matc's + // own include preprocessing has). + File( + p.join(tmp.path, "outer.h"), + ).writeAsStringSync("#include \"inner.h\"\nfloat tweak(float v) { return v * HALF; }\n"); + File(p.join(tmp.path, "inner.h")).writeAsStringSync("#define HALF (0.5)\n#define DOUBLE_IT(v) ((v) * 2.0)\n"); + final source = """ +material { + name : IncludeMaterial, + requires : [ position ], + shadingModel : unlit, + blending : opaque, + culling : none, +} +fragment { +#include "outer.h" + void material(inout MaterialInputs material) { + prepareMaterial(material); + material.baseColor = float4(tweak(DOUBLE_IT(0.25))); + } +} +"""; + final compiled = await app.compileMaterial(source, includePaths: [tmp.path]); + expect(compiled, isNotEmpty); + final material = await app.createMaterial(compiled); + await material.destroy(); + }); + }); + + test("missing includes throw with the offending name", () async { + await testHelper.withViewer((viewer) async { + await expectLater( + app.compileMaterial('#include "does_not_exist.h"\nmaterial { }', includePaths: [tmp.path]), + throwsA(isA().having((e) => e.message, "message", contains("does_not_exist.h"))), + ); + }); + }); + + test("circular includes are detected", () async { + await testHelper.withViewer((viewer) async { + File(p.join(tmp.path, "loop.h")).writeAsStringSync('#include "loop.h"\n'); + await expectLater( + app.compileMaterial('#include "loop.h"\nmaterial { }', includePaths: [tmp.path]), + throwsA(isA().having((e) => e.message, "message", contains("circular"))), + ); + }); + }); + }); + + test("compiled materials drive geometry and hot-reload end to end", () async { + await testHelper.withViewer((viewer) async { + const width = 512; + const height = 512; + + final material = await app.createMaterial(await app.compileMaterial(colorMaterial(""))); + final instance = await material.createInstance(); + await instance.setParameterFloat4("color", 0.0, 0.0, 1.0, 1.0); + final cube = await viewer.createGeometry( + GeometryUtils.cube(normals: false, uvs: false), + materialInstances: [instance], + ); + + Future> center() async { + final pixels = (await testHelper.capture(viewer.view, "compile_e2e"))[viewer.view]!; + return pixelAt(pixels.buffer.asFloat32List(), width, height, width ~/ 2, height ~/ 2); + } + + final before = await center(); + expect(before[2], greaterThan(0.4), reason: "runtime-compiled material renders blue"); + expect(before[0], lessThan(0.1)); + + // Recompile with the fragment forcing red, then hot-swap the package. + final recompiled = await app.compileMaterial(colorMaterial("material.baseColor = float4(1.0, 0.0, 0.0, 1.0);")); + final reloaded = await app.reloadMaterialFromBytes(material, recompiled); + + final after = await center(); + expect(after[0], greaterThan(0.4), reason: "recompiled material renders red"); + expect(after[2], lessThan(0.1)); + + await viewer.destroyAsset(cube); + await reloaded.destroy(); + }); + }); +} diff --git a/thermion_dart/test/material_reload_tests.dart b/thermion_dart/test/material_reload_tests.dart new file mode 100644 index 000000000..6daa657a2 --- /dev/null +++ b/thermion_dart/test/material_reload_tests.dart @@ -0,0 +1,161 @@ +import 'package:test/test.dart'; +import 'package:thermion_dart/thermion_dart.dart'; +import 'package:thermion_dart/src/filament/src/implementation/ffi_material.dart'; + +import 'helpers.dart'; + +/// Returns the RGBA float at (x, y) of a captured float pixel buffer. +List pixelAt(Float32List buffer, int width, int height, int x, int y) { + final offset = (y * width + x) * 4; + return [buffer[offset], buffer[offset + 1], buffer[offset + 2], buffer[offset + 3]]; +} + +void main() async { + final testHelper = TestHelper("material_reload"); + + await testHelper.setup(); + + final solidColorBytes = await loadResourceBytes("${testHelper.assetsDir}/solidcolor.filamat"); + + test('findRenderablesUsingMaterial returns attached primitives', () async { + await testHelper.withViewer((viewer) async { + final material = await FilamentApp.instance!.createMaterial(solidColorBytes); + final instance = await material.createInstance(); + await instance.setParameterFloat4("color", 0.0, 0.0, 1.0, 1.0); + final cube = await viewer.createGeometry( + GeometryUtils.cube(normals: false, uvs: false), + materialInstances: [instance], + ); + + final uses = await FilamentApp.instance!.findRenderablesUsingMaterial(material); + expect(uses.length, 1, reason: "exactly one primitive uses the material"); + expect(uses.single.entity, cube.entity); + expect(uses.single.primitiveIndex, 0); + expect( + uses.single.materialInstance, + same(instance), + reason: "looked-up instances must reuse the wrapper that recorded their state", + ); + + await viewer.destroyAsset(cube); + }, bg: kWhite); + }); + + test('reloadMaterialFromBytes re-points renderables and replays parameters', () async { + await testHelper.withViewer((viewer) async { + final material = await FilamentApp.instance!.createMaterial(solidColorBytes); + final instance = await material.createInstance(); + await instance.setParameterFloat4("color", 0.0, 0.0, 1.0, 1.0); + final cube = await viewer.createGeometry( + GeometryUtils.cube(normals: false, uvs: false), + materialInstances: [instance], + ); + + const width = 512; + const height = 512; + final beforePixels = (await testHelper.capture(viewer.view, "reload_before"))[viewer.view]!; + final beforeCenter = pixelAt(beforePixels.buffer.asFloat32List(), width, height, width ~/ 2, height ~/ 2); + expect(beforeCenter[2], greaterThan(0.4), reason: "cube renders blue before reload"); + expect(beforeCenter[0], lessThan(0.1)); + + final reloaded = await FilamentApp.instance!.reloadMaterialFromBytes(material, solidColorBytes); + expect(reloaded, isNot(same(material))); + + // The renderable now uses an instance of the NEW material. + final usesAfter = await FilamentApp.instance!.findRenderablesUsingMaterial(reloaded); + expect(usesAfter.length, 1); + expect(usesAfter.single.entity, cube.entity); + final newInstance = usesAfter.single.materialInstance as FFIMaterialInstance; + expect( + MaterialInstance_getMaterial(newInstance.pointer).address, + (reloaded as FFIMaterial).pointer.address, + reason: "attached instance must belong to the replacement material", + ); + + // The recorded parameter was replayed onto the replacement instance. + expect(newInstance.shadow.parameters["color"], equals([0.0, 0.0, 1.0, 1.0])); + + // Rendering is unchanged by the swap. + final afterPixels = (await testHelper.capture(viewer.view, "reload_after"))[viewer.view]!; + final afterCenter = pixelAt(afterPixels.buffer.asFloat32List(), width, height, width ~/ 2, height ~/ 2); + expect(afterCenter[2], greaterThan(0.4), reason: "cube still renders blue after reload"); + expect(afterCenter[0], lessThan(0.1)); + + // And the replacement instance is live: mutating it changes the image. + await newInstance.setParameterFloat4("color", 1.0, 0.0, 0.0, 1.0); + final redPixels = (await testHelper.capture(viewer.view, "reload_red"))[viewer.view]!; + final redCenter = pixelAt(redPixels.buffer.asFloat32List(), width, height, width ~/ 2, height ~/ 2); + expect(redCenter[0], greaterThan(0.4), reason: "mutating the replacement instance recolors the cube"); + expect(redCenter[2], lessThan(0.1)); + + await viewer.destroyAsset(cube); + }, bg: kWhite); + }); + + test('reloadMaterialFromBytes preserves instance sharing', () async { + await testHelper.withViewer((viewer) async { + final material = await FilamentApp.instance!.createMaterial(solidColorBytes); + final shared = await material.createInstance(); + await shared.setParameterFloat4("color", 0.0, 1.0, 0.0, 1.0); + final cubeA = await viewer.createGeometry( + GeometryUtils.cube(normals: false, uvs: false), + materialInstances: [shared], + ); + final cubeB = await viewer.createGeometry( + GeometryUtils.cube(normals: false, uvs: false), + materialInstances: [shared], + ); + await cubeA.setTransform(Matrix4.translation(Vector3(-1.6, 0.0, 0.0))); + await cubeB.setTransform(Matrix4.translation(Vector3(1.6, 0.0, 0.0))); + + final reloaded = await FilamentApp.instance!.reloadMaterialFromBytes(material, solidColorBytes); + final usesAfter = await FilamentApp.instance!.findRenderablesUsingMaterial(reloaded); + expect(usesAfter.length, 2, reason: "both cubes moved to the new material"); + expect( + usesAfter[0].materialInstance, + same(usesAfter[1].materialInstance), + reason: "renderables that shared one instance must share one replacement", + ); + expect(usesAfter.map((u) => u.entity).toSet(), {cubeA.entity, cubeB.entity}); + + await viewer.destroyAsset(cubeA); + await viewer.destroyAsset(cubeB); + }, bg: kWhite); + }); + + test('reloadMaterialFromBytes with destroyOld=false leaves the old material alive', () async { + await testHelper.withViewer((viewer) async { + final material = await FilamentApp.instance!.createMaterial(solidColorBytes); + final instance = await material.createInstance(); + await instance.setParameterFloat4("color", 0.0, 0.0, 1.0, 1.0); + final cube = await viewer.createGeometry( + GeometryUtils.cube(normals: false, uvs: false), + materialInstances: [instance], + ); + + final reloaded = await FilamentApp.instance!.reloadMaterialFromBytes( + material, + solidColorBytes, + destroyOld: false, + ); + expect( + await (material as FFIMaterial).hasParameter("color"), + isTrue, + reason: "old material must still be alive when destroyOld is false", + ); + + // Caller owns both materials and every instance now. Order matters: + // instances must not be destroyed while still attached to a renderable + // (detach by destroying the asset first), and Filament requires + // instances to be destroyed before their material. + final liveUses = await FilamentApp.instance!.findRenderablesUsingMaterial(reloaded); + await viewer.destroyAsset(cube); + for (final use in liveUses) { + await use.materialInstance.destroy(); + } + await (reloaded as FFIMaterial).destroy(); + await instance.destroy(); + await material.destroy(); + }, bg: kWhite); + }); +}