First pass at C++ docs. by Tod-Rive · Pull Request #671 · rive-app/rive-docs

Tod-Rive · 2026-05-11T22:37:50Z

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.

Initial generated C++

Organizational changes.

Copilot

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.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

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

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

…o cplusplus

Copilot

Pull request overview

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

lancesnider · 2026-05-12T17:18:42Z

          {
            "group": "Runtimes",
            "pages": [
+              {


Can you put this after Unity?

Architecturally I think it makes sense to have core first followed by the wrappers. At least as a dev, that's how I would expect it to flow. Happy to discuss and hear your thoughts.

Agreed, but it's also the most complex, the most intimidating, and the least likely for someone to use.

lancesnider · 2026-05-12T17:50:50Z

+This is the hook you use to react in C++ to states the designer set up — log
+analytics, play a sound, fire a callback into your engine.
+
+## Linear animations directly


Linear animations directly

Not recommended.

Please use Title Case.

This title is a bit of a fragment. Can we do somethig like:
-Running Linear animations directly

Linear Animations

Running Linear Animations

Changed. Should all titles have Title Case?

Yes, please.

Copilot

Pull request overview

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

+[Renderer](/runtimes/cpp/external-renderer) — including Rive's own GPU
+[Renderer](/runtimes/cpp/renderers) (Metal, Vulkan, D3D11, D3D12, OpenGL/WebGL).


@@ -0,0 +1,129 @@
+---
+title: "State Machines"
+description: "Advance scenes and forward pointer events."


+- `build_rive.sh` (no args) — debug build for the host.
+- `build_rive.sh release clean` — clean rebuild.
+- `build_rive.sh ninja release` — use Ninja instead of make.
+- `build_rive.sh ios release` / `build_rive.sh android release` —


+    D3DContextOptions options;
+    options.isIntel = adapterDesc.VendorId == 0x163C ||
+                      adapterDesc.VendorId == 0x8086 ||
+                      adapterDesc.VendorId == 0x8087;
+
+    std::unique_ptr<RenderContext> rc =
+        RenderContextD3DImpl::MakeContext(device, context, options);
+
+    auto* impl = rc->static_impl_cast<RenderContextD3DImpl>();
+    rcp<RenderTargetD3D> target = impl->makeRenderTarget(width, height);
+
+    // Each frame: bind the current backbuffer to the render target.
+    target->setTargetTexture(backbufferTexture);
+    ```
+
+    Swap-chain notes:
+    - Set `BufferUsage = DXGI_USAGE_RENDER_TARGET_OUTPUT | DXGI_USAGE_UNORDERED_ACCESS`.
+    - Use `DXGI_FORMAT_R8G8B8A8_UNORM` (or the `_SRGB` variant); other formats
+      may force the renderer onto an offscreen path.
+    - Set `options.isIntel = true` on Intel HD Graphics — works around a driver
+      bug in pixel-local-storage emulation.
+
+    For a working reference, see Rive's
+    [`tests/player`](https://github.com/rive-app/rive-runtime/tree/main/tests/player)
+    sample app and the D3D-specific wiring in
+    [`tests/common/offscreen_rendertarget_d3d.cpp`](https://github.com/rive-app/rive-runtime/blob/main/tests/common/offscreen_rendertarget_d3d.cpp).
+  </Tab>
+
+  <Tab title="D3D12">
+    Header: `rive/renderer/d3d12/render_context_d3d12_impl.hpp`
+
+    ```cpp
+    #include "rive/renderer/d3d12/render_context_d3d12_impl.hpp"
+
+    using namespace rive::gpu;
+
+    ComPtr<ID3D12Device>              device;
+    ComPtr<ID3D12GraphicsCommandList> initList; // recording state
+
+    D3DContextOptions options;
+    std::unique_ptr<RenderContext> rc =
+        RenderContextD3D12Impl::MakeContext(device, initList.Get(), options);
+
+    auto* impl = rc->static_impl_cast<RenderContextD3D12Impl>();
+    rcp<RenderTargetD3D12> target = impl->makeRenderTarget(width, height);
+    ```


Tod-Rive added 4 commits May 7, 2026 22:12

Initial generated C++

848f030

Initial generated C++

Organizational changes.

0186339

Organizational changes.

Replaced ascii graphics with images.

9e7c72d

Moved and updated images.

6808523

Tod-Rive requested review from aliasbinman, Copilot and csmartdalton May 11, 2026 22:37

Tod-Rive requested a review from a team as a code owner May 11, 2026 22:37

Copilot started reviewing on behalf of Tod-Rive May 11, 2026 22:38 View session

Copilot AI reviewed May 11, 2026

View reviewed changes

Tod-Rive and others added 2 commits May 11, 2026 18:43

Potential fix for pull request finding

dedb684

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Potential fix for pull request finding

d1ca176

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

mintlify Bot deployed to staging May 11, 2026 22:44 View deployment

mintlify Bot deployed to staging May 11, 2026 22:45 View deployment

Tod-Rive and others added 3 commits May 11, 2026 18:51

Potential fix for pull request finding

625acab

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Potential fix for pull request finding

fab2231

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Potential fix for pull request finding

49145c5

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

mintlify Bot deployed to staging May 11, 2026 22:52 View deployment

Potential fix for pull request finding

f5d3ea9

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

mintlify Bot deployed to staging May 11, 2026 22:53 View deployment

Potential fix for pull request finding

1d2ba3a

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Tod-Rive requested a review from Copilot May 11, 2026 22:53

mintlify Bot deployed to staging May 11, 2026 22:54 View deployment

Copilot started reviewing on behalf of Tod-Rive May 11, 2026 22:54 View session

mintlify Bot deployed to staging May 11, 2026 22:54 View deployment

Copilot AI reviewed May 11, 2026

View reviewed changes

Potential fix for pull request finding

35844d2

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

mintlify Bot deployed to staging May 11, 2026 23:02 View deployment

Potential fix for pull request finding

fda1ceb

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

mintlify Bot deployed to staging May 11, 2026 23:03 View deployment

Tod-Rive marked this pull request as draft May 12, 2026 15:41

Tod-Rive added 2 commits May 12, 2026 11:44

PR changes.

f3031e3

Merge branch 'cplusplus' of https://github.com/rive-app/rive-docs int…

20feacc

…o cplusplus

Tod-Rive requested a review from Copilot May 12, 2026 15:45

mintlify Bot deployed to staging May 12, 2026 15:45 View deployment

Copilot started reviewing on behalf of Tod-Rive May 12, 2026 15:46 View session

Copilot AI reviewed May 12, 2026

View reviewed changes

PR changes.

f62426b

mintlify Bot deployed to staging May 12, 2026 16:06 View deployment

PR Changes

92df79c

mintlify Bot deployed to staging May 12, 2026 16:09 View deployment

PR fixes

f3cd4d8

mintlify Bot deployed to staging May 12, 2026 16:23 View deployment

PR changes

bba1b43

mintlify Bot deployed to staging May 12, 2026 16:34 View deployment

lancesnider reviewed May 12, 2026

View reviewed changes

Updated build instructions.

e177a3d

mintlify Bot deployed to staging May 12, 2026 18:26 View deployment

Update renderers.mdx

cbae5a5

mintlify Bot deployed to staging May 13, 2026 19:43 View deployment

Tod-Rive changed the title ~~Firt pass at C++ docs.~~ First pass at C++ docs. May 13, 2026

PR changes.

0f15858

mintlify Bot deployed to staging May 13, 2026 20:44 View deployment

Tod-Rive requested review from Copilot and lancesnider May 13, 2026 20:53

Copilot started reviewing on behalf of Tod-Rive May 13, 2026 20:54 View session

Copilot AI reviewed May 13, 2026

View reviewed changes

		[Renderer](/runtimes/cpp/external-renderer) — including Rive's own GPU
		[Renderer](/runtimes/cpp/renderers) (Metal, Vulkan, D3D11, D3D12, OpenGL/WebGL).

Conversation

Tod-Rive commented May 11, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lancesnider May 12, 2026

Choose a reason for hiding this comment

Uh oh!

Tod-Rive May 13, 2026

Choose a reason for hiding this comment

Uh oh!

lancesnider May 13, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lancesnider May 12, 2026

Choose a reason for hiding this comment

Uh oh!

Tod-Rive May 13, 2026

Choose a reason for hiding this comment

Uh oh!

lancesnider May 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants