Skip to content

First pass at C++ docs.#671

Open
Tod-Rive wants to merge 31 commits into
mainfrom
cplusplus
Open

First pass at C++ docs.#671
Tod-Rive wants to merge 31 commits into
mainfrom
cplusplus

Conversation

@Tod-Rive
Copy link
Copy Markdown
Contributor

This is mostly Claude generated. I've made some changes to the output but this need a good once-over by someone familiar with the C++ API.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an initial set of C++ runtime documentation pages to the docs site, covering core concepts (File/Artboard/Scene), rendering backends, the render loop, state machines/inputs, data binding, and asset loading, and wires them into the left-nav.

Changes:

  • Added a new runtimes/cpp/ doc section with pages for getting started, rendering, state machines, data binding, asset loading, and external renderer integration.
  • Documented the GPU RenderContext lifecycle (beginFrame/flush), resize handling, and fixed-timestep simulation guidance.
  • Updated docs.json to expose the new C++ section in the “Runtimes” navigation.

Reviewed changes

Copilot reviewed 10 out of 12 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
runtimes/cpp/index.mdx Adds C++ runtime overview page and entry-point links.
runtimes/cpp/getting-started.mdx Adds build + first render-loop walkthrough.
runtimes/cpp/file-and-artboard.mdx Adds file import, artboard querying/instancing, layout sizing, and lifetime guidance.
runtimes/cpp/state-machines.mdx Adds scene lifecycle, pointer forwarding, input access, and state-change introspection.
runtimes/cpp/data-binding.mdx Adds ViewModel runtime/instance/property usage docs and examples.
runtimes/cpp/asset-loading.mdx Adds FileAssetLoader guidance with sync/async examples and caveats.
runtimes/cpp/rendering-loop.mdx Adds detailed beginFrame/flush sequencing, frame descriptors, and operational notes.
runtimes/cpp/renderers.mdx Adds per-backend RenderContext setup snippets (D3D11/12, Metal, Vulkan, GL/WebGL).
runtimes/cpp/external-renderer.mdx Documents implementing Renderer/Factory to plug into custom backends.
docs.json Adds the new C++ pages to the Runtimes sidebar nav.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread runtimes/cpp/file-and-artboard.mdx Outdated
Comment thread runtimes/cpp/file-and-artboard.mdx Outdated
Comment thread runtimes/cpp/file-and-artboard.mdx Outdated
Comment thread runtimes/cpp/state-machines.mdx Outdated
Comment thread runtimes/cpp/state-machines.mdx Outdated
Comment thread runtimes/cpp/external-renderer.mdx Outdated
Comment thread runtimes/cpp/asset-loading.mdx
Comment thread runtimes/cpp/asset-loading.mdx
Comment thread runtimes/cpp/getting-started.mdx
Tod-Rive and others added 2 commits May 11, 2026 18:43
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Tod-Rive and others added 3 commits May 11, 2026 18:51
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 10 out of 12 changed files in this pull request and generated 6 comments.

Comment thread runtimes/cpp/file-and-artboard.mdx Outdated
Comment thread runtimes/cpp/state-machines.mdx
Comment thread runtimes/cpp/state-machines.mdx Outdated
Comment thread runtimes/cpp/data-binding.mdx
Comment thread runtimes/cpp/getting-started.mdx
Comment thread runtimes/cpp/rendering-loop.mdx Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@Tod-Rive Tod-Rive changed the title Firt pass at C++ docs. First pass at C++ docs. May 13, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 10 out of 12 changed files in this pull request and generated 4 comments.

Comment thread runtimes/cpp/overview.mdx Outdated
Comment thread runtimes/cpp/state-machines.mdx
Comment thread runtimes/cpp/getting-started.mdx
Comment thread runtimes/cpp/renderers.mdx
@Tod-Rive Tod-Rive marked this pull request as ready for review May 25, 2026 18:16
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.

3 participants