Skip to content

docs: add backend architecture sequence diagram#164

Open
Guo-astro wants to merge 1 commit intotoyota-connected:v2.0from
Guo-astro:docs/backend-sequence-diagram
Open

docs: add backend architecture sequence diagram#164
Guo-astro wants to merge 1 commit intotoyota-connected:v2.0from
Guo-astro:docs/backend-sequence-diagram

Conversation

@Guo-astro
Copy link
Copy Markdown

Add documentation for the rendering backend architecture.

Summary

This PR adds a new documentation page that describes the backend abstraction layer and its interaction with Flutter Engine.

Contents

  • Overview of available backends (WaylandEgl, WaylandVulkan, Headless)
  • Component reference table
  • Mermaid sequence diagram covering the complete lifecycle:
    1. Initialization
    2. Surface creation
    3. Engine start
    4. Render loop (OpenGL and Vulkan paths)
    5. IO thread resource loading
    6. External texture handling
    7. Window resize
    8. Shutdown
  • FlutterRendererConfig callback reference
  • Explanation of multi-context architecture

Files Changed

  • docs/source/backend-architecture.md (new)

Document the rendering backend lifecycle including:
- Initialization flow for EGL, Vulkan, and Headless backends
- Surface creation
- Flutter Engine integration via FlutterRendererConfig
- Per-frame render loop for OpenGL and Vulkan paths
- IO thread resource loading
- External texture handling
- Window resize handling
- Shutdown sequence
@Guo-astro Guo-astro requested a review from jwinarske as a code owner January 7, 2026 01:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants