Skip to content
Back to search

sceneview

3D & AR SDK for Android (Jetpack Compose + Filament), Apple (SwiftUI + RealityKit), Web, Flutter and React Native. Opens glTF/GLB, 3MF, STL, OBJ and PLY on Android and USDZ on Apple, at real size in AR. Assistant-ready: in-repo MCP server, AGENTS.md and llms.txt — no assistant-specific setup.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/sceneview/sceneview with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/sceneview/sceneview'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/sceneview--sceneview/badge.svg)](/listings/sceneview--sceneview)

HTML

<a href="/listings/sceneview--sceneview"><img src="/api/listings/sceneview--sceneview/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

One minimal, working example per platform. The full reference for each is in [`llms.txt`](./llms.txt).

Android

// build.gradle.kts
implementation("io.github.sceneview:sceneview:4.52.0")
@Composable
fun ModelScreen() {
    SceneView(modifier = Modifier.fillMaxSize()) {          // orbit camera + default lighting
        rememberModelInstance(modelLoader, "models/helmet.glb")?.let { instance ->
            ModelNode(modelInstance = instance, scaleToUnits = 1.0f, autoAnimate = true)
        }
    }
}

`models/helmet.glb` lives in `src/main/assets/`. `rememberModelInstance` returns `null` until the model is loaded, then recomposes. Never call `modelLoader.createModel*` from a background coroutine: Filament calls must run on the main thread, and `rememberModelInstance` handles that.

AR (Android)

// build.gradle.kts
implementation("io.github.sceneview:arsceneview:4.52.0")   // includes the 3D module
@Composable
fun ARScreen() {
    var anchor by remember { mutableStateOf<Anchor?>(null) }

    ARSceneView(
        modifier = Modifier.fillMaxSize(),
        planeRenderer = true,
        onSessionUpdated = { _, frame ->
            if (anchor == null) {
                anchor = frame.getUpdatedPlanes()
                    .firstOrNull { it.type == Plane.Type.HORIZONTAL_UPWARD_FACING }
                    ?.let { frame.createAnchorOrNull(it.centerPose) }
            }
        }
    ) {
        val helmet = rememberModelInstance(modelLoader, "models/helmet.glb")
        anchor?.let { a ->
            AnchorNode(anchor = a) {
                helmet?.let { ModelNode(modelInstance = it, scaleToUnits = 0.5f) }
            }
        }
    }
}

Plane detected → `anchor` set → Compose recomposes → the model appears. **AR state is just Kotlin state.** For placement without a tap, grounded and gesture-ready, start from `AutoPlacementScene` (see [`llms.txt`](./llms.txt)).

iOS / macOS / visionOS (SwiftUI)

Swift Package Manager: `https://github.com/sceneview/sceneview.git`, from `4.39.0`.

import SwiftUI
import SceneViewSwift

struct ModelScreen: View {
    @State private var model: ModelNode?

    var body: some View {
        SceneView { root in
            if let model { root.addChild(model.entity) }
        }
        .contentID(model != nil)      // re-run the builder once the model has loaded
        .environment(.studio)
        .cameraControls(.orbit)
        .task { model = try? await ModelNode.load("helmet.usdz") }
    }
}

The content closure runs once unless its `.contentID(_:)` changes: without that line, a model that finishes loading after the scene appears is never added.

Web

<canvas id="viewer" style="width: 100%; height: 480px"></canvas>
<script src="https://cdn.jsdelivr.net/gh/sceneview/sceneview@v4.52.0/website-static/js/filament/filament.js"></script>
<script src="https://cdn.jsdelivr.net/gh/sceneview/sceneview@v4.52.0/website-static/js/sceneview.js"></script>
<script> SceneView.modelViewer("viewer", "model.glb") </script>

Compose Multiplatform (Android · iOS · desktop)

// commonMain dependencies
implementation("io.github.sceneview:sceneview-compose:4.52.0")
SceneViewer(model = ModelSource.Asset("models/helmet.glb"), modifier = Modifier.fillMaxSize())

A viewer by design — load, orbit, light, tap; no AR. Scope and the one-time iOS setup: [`sceneview-compose/`](sceneview-compose/README.md).

Flutter

// pubspec.yaml → flutter_sceneview: ^4.52.0
final controller = SceneViewController();

SceneView(
  controller: controller,
  onViewCreated: () => controller.loadModel(
    const ModelNode(modelPath: 'models/helmet.glb'),
  ),
)

React Native

// npm install @sceneview-sdk/react-native
import { SceneView } from '@sceneview-sdk/react-native';

<SceneView
  style={{ flex: 1 }}
  modelNodes={[{ src: 'models/helmet.glb', position: [0, 0, -2] }]}

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 635 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. # SceneView
  2. > **The AI-first 3D & AR SDK for Jetpack Compose — and the web.**
  3. Declarative 3D and AR for app developers who want a model on screen, or in the room, without a
  4. game engine: Filament + ARCore on Android, Filament.js + WebXR in the browser, and a Compose
  5. Multiplatform viewer. It is the
  6. maintained successor to Google Sceneform. Open source, Apache 2.0.
  7. | Building with | Add | Then write |
  8. |---|---|---|
  9. | Jetpack Compose — 3D | `io.github.sceneview:sceneview:4.69.7` | `SceneView { }` |
  10. | Jetpack Compose — AR | `io.github.sceneview:arsceneview:4.69.7` | `ARSceneView { }` or `PlacementScene` |
  11. | Android Views / XML | the same | `SceneView { }` inside a `ComposeView` |
  12. | Kotlin / Compose Multiplatform | `io.github.sceneview:sceneview-compose:4.69.7` | `SceneViewer(model = …)` in `commonMain` |
  13. | Web | `npm install sceneview-web` | `SceneView.modelViewer("canvas", "model.glb")` |
  14. Moving from Sceneform, or from SceneView 2.x code (`Scene(childNodes = …)`, `ARScene`)?
  15. [The mapping](https://sceneview.github.io/docs/sceneform-replacement/). Which artifact fits your app:
  16. [3D and AR library, per platform](https://sceneview.github.io/docs/3d-ar-library/).
  17. **Used in production.** More than 1,300 stars on GitHub, and over 500 public repositories declare
  18. SceneView as a dependency. It ships on Google Play in the Volkswagen, Audi, Porsche and CUPRA
  19. apps, Philips Hue, Medal and IKEA, is declared by the open-source apps Bitkey (Block) and Vocable
  20. (WillowTree), and is a dependency of the GeneXus Augmented Reality module and the TruVideo camera
  21. SDK. The Niantic Spatial SDK samples use it for AR. Lenskart ships
  22. [Sceneform Maintained](https://github.com/sceneview/sceneform-android), SceneView's predecessor, and Safie presented
  23. SceneView in [a public talk](https://speakerdeck.com/jeromecha/mobile-dev-japan-number-3-safie-viewer-android-and-sceneview).
  24. **AI-first** means one thing here: an assistant that reads [`llms.txt`](./llms.txt) or
  25. [the MCP server](./mcp/) writes SceneView code that works on the first try. When it doesn't, the
  26. API or the doc gets fixed.
  27. <!-- Platforms -->
  28. [![Android 3D](https://img.shields.io/maven-central/v/io.github.sceneview/sceneview?label=Android%203D&logo=android&color=34a853)](https://central.sonatype.com/artifact/io.github.sceneview/sceneview)
  29. [![Android AR](https://img.shields.io/maven-central/v/io.github.sceneview/arsceneview?label=Android%20AR&logo=android&color=34a853)](https://central.sonatype.com/artifact/io.github.sceneview/arsceneview)
  30. [![iOS / macOS / visionOS](https://img.shields.io/github/v/release/sceneview/sceneview?label=Swift&logo=swift&color=f05138)](https://github.com/sceneview/sceneview)
  31. [![sceneview-web](https://img.shields.io/npm/v/sceneview-web?label=sceneview-web&logo=javascript&color=f7df1e)](https://www.npmjs.com/package/sceneview-web)
  32. [![Flutter](https://img.shields.io/pub/v/flutter_sceneview?label=Flutter&logo=flutter&color=02569B)](https://pub.dev/packages/flutter_sceneview)
  33. [![React Native](https://img.shields.io/npm/v/@sceneview-sdk/react-native?label=React%20Native&logo=react&color=61DAFB)](https://www.npmjs.com/package/@sceneview-sdk/react-native)
  34. [![MCP Server](https://img.shields.io/npm/v/sceneview-mcp?label=MCP&logo=npm&color=d97706)](https://www.npmjs.com/package/sceneview-mcp)
  35. <!-- Status -->
  36. [![CI](https://img.shields.io/github/actions/workflow/status/sceneview/sceneview/ci.yml?branch=main&label=CI&logo=github)](https://github.com/sceneview/sceneview/actions/workflows/ci.yml)
  37. [![License](https://img.shields.io/github/license/sceneview/sceneview?color=blue)](https://github.com/sceneview/sceneview/blob/main/LICENSE)
  38. [![GitHub Stars](https://img.shields.io/github/stars/sceneview/sceneview?style=flat&color=yellow&logo=github)](https://github.com/sceneview/sceneview)
  39. [![Discord](https://img.shields.io/discord/893787194295222292?color=7389D8&label=Discord&logo=discord&logoColor=ffffff)](https://discord.gg/UbNDDBTNqb)
  40. [![Open Collective](https://img.shields.io/opencollective/all/sceneview?label=Open%20Collective&color=7FADF2&logo=opencollective)](https://opencollective.com/sceneview)
  41. ---
  42. ## Try it
  43. <p>
  44. <a href="https://play.google.com/store/apps/details?id=io.github.sceneview.demo"><img src="website-static/assets/brand/stores/google-play-badge-trimmed.png" alt="Get it on Google Play" height="56"></a>&nbsp;
  45. <a href="https://apps.apple.com/us/app/sceneview-demo-sdk-samples/id6761329763"><img src="website-static/assets/brand/stores/app-store.svg" alt="Download on the App Store" height="56"></a>&nbsp;
  46. <a href="https://sceneview.github.io/web-demo/"><img src="website-static/assets/brand/stores/web-demo.svg" alt="Open the web demo" height="56"></a>
  47. </p>
  48. The demo apps are built from [`samples/`](samples/). Any demo opens straight from a link:
  49. `https://sceneview.github.io/open?demo=<id>`. Start with
  50. [Cosmos](https://sceneview.github.io/open?demo=cosmos), the galaxy the catalogue opens on, or
  51. [3D Scan](https://sceneview.github.io/open?demo=ar-rerun), a space scanned with ARCore and rebuilt in 3D.
  52. <p align="center">
  53. <a href="https://sceneview.github.io/open?demo=ar-rerun"><img src="website-static/assets/demos/scan-room.webp" alt="3D Scan on a Pixel 9: a living room is scanned wall by wall, then rebuilt as a 3D model you can turn" width="300"></a>
  54. <br>
  55. <sub>A living room scanned in 3D Scan on a Pixel 9, then rebuilt as a model (sped up).</sub>
  56. </p>
  57. ### Help test the demos
  58. Install the Android demo, record your screen while you use a demo, and tell us what breaks or
  59. confuses you: [open an issue](https://github.com/sceneview/sceneview/issues/new?labels=user-feedback)
  60. with the recording attached, or send it from the app (any demo, Settings, then Send feedback).
  61. ---
  62. ## Quick start
  63. One minimal, working example per platform. The full reference for each is in
  64. [`llms.txt`](./llms.txt).
  65. ### Android
  66. ```kotlin
  67. // build.gradle.kts
  68. implementation("io.github.sceneview:sceneview:4.69.7")
  69. ```
  70. The app module needs `compileSdk = 37`, `minSdk` 24 or higher, AGP 9.4.0+, Kotlin 2.3 or newer and JVM
  71. target 21 for both Java and Kotlin: SceneView ships Java 21 bytecode with public `inline`
  72. functions. The [quickstart requirements](docs/docs/quickstart.md#requirements) give the Gradle
  73. snippet and the reason for each.
  74. Stuck on AGP 8 / compileSdk 36 / Kotlin 2.2? Use `4.18.0`, the newest release that builds there.
  75. ```kotlin
  76. import androidx.compose.foundation.layout.fillMaxSize
  77. import androidx.compose.runtime.Composable
  78. import androidx.compose.ui.Modifier
  79. import io.github.sceneview.SceneView
  80. import io.github.sceneview.rememberModelInstance
  81. @Composable
  82. fun ModelScreen() {
  83. SceneView(modifier = Modifier.fillMaxSize()) { // orbit camera + default lighting
  84. rememberModelInstance(modelLoader, "models/helmet.glb")?.let { instance ->
  85. ModelNode(modelInstance = instance, scaleToUnits = 1.0f, autoAnimate = true)
  86. }
  87. }
  88. }
  89. ```
  90. `models/helmet.glb` lives in `src/main/assets/`. `rememberModelInstance` returns `null` until the
  91. model is loaded, then recomposes. Never call `modelLoader.createModel*` from a background
  92. coroutine: Filament calls must run on the main thread, and `rememberModelInstance` handles that.
  93. ### AR (Android)
  94. ```kotlin
  95. // build.gradle.kts
  96. implementation("io.github.sceneview:arsceneview:4.69.7") // includes the 3D module
  97. ```
  98. ```kotlin
  99. import androidx.compose.foundation.layout.fillMaxSize
  100. import androidx.compose.runtime.*
  101. import androidx.compose.ui.Modifier
  102. import com.google.ar.core.Anchor
  103. import com.google.ar.core.Plane
  104. import io.github.sceneview.ar.ARSceneView
  105. import io.github.sceneview.ar.arcore.createAnchorOrNull
  106. import io.github.sceneview.ar.arcore.getUpdatedPlanes
  107. import io.github.sceneview.rememberModelInstance
  108. @Composable
  109. fun ARScreen() {
  110. var anchor by remember { mutableStateOf<Anchor?>(null) }
  111. ARSceneView(
  112. modifier = Modifier.fillMaxSize(),
  113. planeRenderer = true,
  114. onSessionUpdated = { _, frame ->
  115. if (anchor == null) {
  116. anchor = frame.getUpdatedPlanes()
  117. .firstOrNull { it.type == Plane.Type.HORIZONTAL_UPWARD_FACING }
  118. ?.let { it.createAnchorOrNull(it.centerPose) }
  119. }
  120. }
  121. ) {
  122. val helmet = rememberModelInstance(modelLoader, "models/helmet.glb")
  123. anchor?.let { a ->
  124. AnchorNode(anchor = a) {
  125. helmet?.let { ModelNode(modelInstance = it, scaleToUnits = 0.5f) }
  126. }
  127. }
  128. }
  129. }
  130. ```
  131. Plane detected → `anchor` set → Compose recomposes → the model appears. **AR state is just Kotlin
  132. state.** For placement without a tap, grounded and gesture-ready, start from
  133. `AutoPlacementScene` (see [`llms.txt`](./llms.txt)).
  134. `arsceneview` already declares the `CAMERA` permission and marks ARCore as optional. An AR
  135. Optional app declares `android.hardware.camera.ar` and `android.hardware.camera` as
  136. `<uses-feature … android:required="false" />`; an AR Required app overrides the ARCore value
  137. with `tools:replace="android:value"`. Both snippets are in the
  138. [AR manifest](docs/docs/quickstart.md#ar-manifest) section.
  139. ### Web
  140. ```html
  141. <canvas id="viewer" style="width: 100%; height: 480px"></canvas>
  142. <script src="https://cdn.jsdelivr.net/gh/sceneview/sceneview@v4.69.7/website-static/js/filament/filament.js"></script>
  143. <script src="https://cdn.jsdelivr.net/gh/sceneview/sceneview@v4.69.7/website-static/js/sceneview.js"></script>
  144. <script> SceneView.modelViewer("viewer", "model.glb") </script>
  145. ```
  146. ### Compose Multiplatform (Android · iOS · desktop)
  147. ```kotlin
  148. // commonMain dependencies
  149. implementation("io.github.sceneview:sceneview-compose:4.69.7")
  150. ```
  151. ```kotlin
  152. SceneViewer(model = ModelSource.Asset("models/helmet.glb"), modifier = Modifier.fillMaxSize())
  153. ```
  154. A viewer by design — load, orbit, light, tap; no AR. Scope and the one-time iOS setup:
  155. [`sceneview-compose/`](sceneview-compose/README.md).
  156. ### iOS, Flutter and React Native
  157. SceneView for SwiftUI (`SceneViewSwift`), Flutter (`flutter_sceneview`) and React Native
  158. (`@sceneview-sdk/react-native`) is deprecated: 4.68.0 is their last release. Published versions stay
  159. installable and the source stays in this repository — [what that means and the timeline](DEPRECATION.md).
  160. ### Your AI assistant
  161. ```bash
  162. claude mcp add sceneview -- npx -y sceneview-mcp # Claude Code
  163. codex mcp add sceneview -- npx -y sceneview-mcp # Codex
  164. ```
  165. Then ask: *"Add a 3D model viewer to my Compose screen."* Every other client is in
  166. [Use with AI](#use-with-ai).
  167. ---
  168. ## Runs on
  169. Each row is a published package plus an app or page you can open today, backed by a real
  170. capture of it.
  171. | Platform | Status | Install | Open it | Capture |
  172. |---|---|---|---|---|
  173. | **Android** | Shipped · Stable | [Maven Central](https://central.sonatype.com/artifact/io.github.sceneview/sceneview) | [Google Play](https://play.google.com/store/apps/details?id=io.github.sceneview.demo) | <img src="website-static/assets/demos/runs-on-android.jpg" alt="SceneView Android demo: Model Viewer rendering a helmet with Filament" height="160"> |
  174. | **iOS** | Shipped · Alpha | [Swift Package](SceneViewSwift/) | [App Store](https://apps.apple.com/us/app/sceneview-demo-sdk-samples/id6761329763) | <img src="website-static/assets/demos/runs-on-ios.jpg" alt="SceneView iOS demo: Model Viewer rendering a helmet with RealityKit" height="160"> |
  175. | **Web** | Shipped · Alpha | [npm `sceneview-web`](https://www.npmjs.com/package/sceneview-web) | [Live web demo](https://sceneview.github.io/web-demo/) | <img src="website-static/assets/demos/runs-on-web.jpg" alt="SceneView web demo: Toy Car rendered by Filament.js in a browser" height="100"> |
  176. *Shipped* means released and publicly reachable; the second word is the API maturity.
  177. The other platforms in the table below join this section once a capture backs them.
  178. ---
  179. ## Platforms
  180. | Platform | Renderer | Framework | Status |
  181. |---|---|---|---|
  182. | **Android** | Filament | Jetpack Compose | Stable |
  183. | **Android TV** | Filament | Compose TV | Alpha |
  184. | **iOS / macOS / visionOS** | RealityKit | SwiftUI | Deprecated — [4.68.0 is the last release](DEPRECATION.md) |
  185. | **Web** | Filament.js (WebGL2 / WASM) | JavaScript + Kotlin/JS | Alpha |
  186. | **Compose Multiplatform** | Filament (Android, desktop) · RealityKit (iOS) | `sceneview-compose` | Alpha — viewer subset |
  187. | **Desktop (JVM)** | Filament, via filament-kmp | Compose Desktop (`sceneview-compose`) | Alpha |
  188. | **Flutter** | Native per platform | PlatformView | Deprecated — [4.68.0 is the last release](DEPRECATION.md) |
  189. | **React Native** | Native per platform | Fabric | Deprecated — [4.68.0 is the last release](DEPRECATION.md) |
  190. | **AI assistants** | — | `llms.txt`, MCP server, skills | Stable |
  191. ## Install
  192. | Platform | Coordinate |
  193. |---|---|
  194. | Android 3D | `io.github.sceneview:sceneview:4.69.7` |
  195. | Android AR | `io.github.sceneview:arsceneview:4.69.7` |
  196. | Compose Multiplatform | `io.github.sceneview:sceneview-compose:4.69.7` |
  197. | KMP core only (math, collision, physics) | `io.github.sceneview:sceneview-core:4.69.7` |
  198. | Apple (SPM) — deprecated | `https://github.com/sceneview/sceneview.git`, exact `4.68.0` |
  199. | Web, script tag | the two `<script>` tags in [Web](#web) |
  200. | Web, bundler (Kotlin/JS) | `npm install sceneview-web` — see [SceneView Web](#sceneview-web) |
  201. | Flutter — deprecated | [`flutter_sceneview`](https://pub.dev/packages/flutter_sceneview) on pub.dev |
  202. | React Native — deprecated | [`@sceneview-sdk/react-native`](https://www.npmjs.com/package/@sceneview-sdk/react-native) on npm |
  203. | AI assistants | `npx -y sceneview-mcp` — see [Use with AI](#use-with-ai) |
  204. ---
  205. ## Use with AI
  206. Everything an assistant needs to write SceneView code ships with the SDK:
  207. - **[`llms.txt`](./llms.txt)** — the complete API reference in one file: composables, every node
  208. type, threading rules, recipes. Its Kotlin snippets are compiled in CI. Served at
  209. `https://sceneview.github.io/llms.txt` for tools without MCP support.
  210. - **Rules files** — `AGENTS.md` (Codex, Cursor, GitHub Copilot, Gemini in Android Studio and
  211. others), `CLAUDE.md` (Claude Code), `.github/copilot-instructions.md`, and `.cursorrules` for
  212. older Cursor versions.
  213. - **The [MCP server](./mcp/)** — free, no API key. The tools assistants reach for most:
  214. `validate_code` (checks a snippet for known pitfalls and unknown symbols before you run it; it does not check argument names),
  215. `get_node_reference` (the exact node signature, not an invented one), `list_samples` /
  216. `get_sample` (38 samples to start from), and `get_setup` / `get_ar_setup` (project wiring).
  217. ### MCP setup
  218. ```bash
  219. claude mcp add sceneview -- npx -y sceneview-mcp # Claude Code
  220. codex mcp add sceneview -- npx -y sceneview-mcp # Codex
  221. copilot mcp add sceneview -- npx -y sceneview-mcp # GitHub Copilot CLI
  222. ```
  223. ```json
  224. // Cursor (.cursor/mcp.json), Cline, JetBrains AI Assistant
  225. { "mcpServers": { "sceneview": { "command": "npx", "args": ["-y", "sceneview-mcp"] } } }
  226. // VS Code (.vscode/mcp.json) uses the "servers" key instead
  227. { "servers": { "sceneview": { "type": "stdio", "command": "npx", "args": ["-y", "sceneview-mcp"] } } }
  228. ```
  229. Clients that only speak HTTP (Gemini in Android Studio, ChatGPT) use the hosted endpoint
  230. `https://mcp.sceneview.dev/mcp`, or run their own with `npx sceneview-mcp --http`. Per-client
  231. snippets: [sceneview.github.io/#ai-setup](https://sceneview.github.io/#ai-setup). Listed on the
  232. [MCP Registry](https://registry.modelcontextprotocol.io).
  233. ### ChatGPT / Codex plugin
  234. This repository is also an OpenAI plugin: `.codex-plugin/plugin.json` points at the three
  235. skills under [`agents/`](agents/) (`sceneview`, `sceneview-ios`, `sceneview-web`). From a
  236. checkout:
  237. ```bash
  238. codex plugin marketplace add "$PWD" # absolute path — a relative one does not resolve
  239. codex plugin add sceneview@sceneview-local
  240. ```
  241. Codex also discovers the skills from `.agents/skills/` on its own. Over HTTP the MCP server
  242. carries an inline `view_3d_model` widget that renders a public GLB/glTF URL in the
  243. conversation. Listing copy and test prompts: [agents/OPENAI-PLUGIN.md](agents/OPENAI-PLUGIN.md).
  244. ### Claude Code plugin
  245. `/plugin marketplace add sceneview/claude-marketplace`, then `/plugin install sceneview@sceneview`,
  246. installs the same three skills as the Codex plugin together with the MCP server. The commands used
  247. to work on this repository are a separate plugin, `sceneview-contrib@sceneview` — see
  248. [sceneview/claude-marketplace](https://github.com/sceneview/claude-marketplace).
  249. Vertical MCP servers (Rerun AR debugging and others) are listed in the [MCP README](./mcp/README.md).
  250. ---
  251. ## Android in depth
  252. ### 3D scene
  253. `SceneView` is a composable that renders a Filament viewport. Nodes are composables inside it.
  254. ```kotlin
  255. val engine = rememberEngine()
  256. val modelLoader = rememberModelLoader(engine)
  257. val environmentLoader = rememberEnvironmentLoader(engine)
  258. SceneView(
  259. modifier = Modifier.fillMaxSize(),
  260. engine = engine,
  261. modelLoader = modelLoader,
  262. environment = rememberEnvironment(environmentLoader) {
  263. environmentLoader.createHDREnvironment("envs/studio.hdr")
  264. ?: createEnvironment(environmentLoader)
  265. },
  266. cameraManipulator = rememberCameraManipulator()
  267. ) {
  268. // Model — async loaded, appears when ready
  269. rememberModelInstance(modelLoader, "models/helmet.glb")?.let {
  270. ModelNode(modelInstance = it, scaleToUnits = 1.0f, autoAnimate = true)
  271. }
  272. // Geometry — procedural shapes
  273. CubeNode(size = Size(0.2f))
  274. SphereNode(radius = 0.1f, position = Position(x = 0.5f))
  275. // Nesting — same as Column { Row { } }
  276. Node(position = Position(y = 1.0f)) {
  277. LightNode(type = LightManager.Type.POINT, apply = { intensity(50_000f) })
  278. CubeNode(size = Size(0.05f))
  279. }
  280. }
  281. ```
  282. ### Node composables — 27 in 3D, 15 more in AR
  283. | Category | Nodes | What they do |
  284. |---|---|---|
  285. | **Models** | `ModelNode` | glTF/GLB with skeletal/morph animations. `isEditable = true` for gestures. |
  286. | **Primitives** | `CubeNode` · `SphereNode` · `CylinderNode` · `ConeNode` · `TorusNode` · `CapsuleNode` · `TubeNode` · `PlaneNode` | Procedural geometry, parametric size/segments |
  287. | **Curves & shapes** | `LineNode` · `PathNode` · `ShapeNode` | Single segments, polylines, extruded 2D polygons |
  288. | **Custom geometry** | `MeshNode` | Your own Filament `VertexBuffer` / `IndexBuffer` |
  289. | **Surfaces** | `ImageNode` · `VideoNode` · `BillboardNode` | PNG/JPG plane, video plane (MediaPlayer), camera-facing sprite |
  290. | **3D text** | `TextNode` | World-space text label that always faces the camera |
  291. | **Compose-in-3D** | `ViewNode` | Any Compose UI rendered as a 3D surface, fully touch-interactive |
  292. | **Gaussian splats** | `SplatNode` | Render a Gaussian-splat capture |
  293. | **Lighting & sky** | `LightNode` · `ReflectionProbeNode` · `DynamicSkyNode` · `FogNode` | Sun/dir/point/spot lights, local IBL, time-of-day sky, atmospheric fog |
  294. | **Physics** | `PhysicsNode` | Simple rigid-body simulation (gravity, collisions) |
  295. | **Cameras** | `CameraNode` · `SecondaryCamera` | Main and picture-in-picture cameras |
  296. | **Group** | `Node` | Empty pivot for nesting and transform inheritance |
  297. ### AR scene
  298. `ARSceneView` is `SceneView` with ARCore: the camera follows real-world tracking. See the
  299. [AR quick start](#ar-android) above.
  300. | Node | What it does |
  301. |---|---|
  302. | `AnchorNode` | Pin a node to a real-world ARCore `Anchor` |
  303. | `HitResultNode` · `DepthHitResultNode` | Live surface cursor from each frame's hit-test (planes or depth) |
  304. | `PoseNode` | Position a node at any ARCore `Pose` |
  305. | `PlaneNode` · `ReticleNode` | Render a detected plane, or a placement reticle |
  306. | `PointCloudNode` · `DepthMeshNode` · `SceneMeshNode` | Feature points, depth mesh, classified geospatial scene mesh |
  307. | `AugmentedImageNode` | Image tracking — pose + 2D extent of a detected image |
  308. | `AugmentedFaceNode` | Face mesh overlay (front camera) |
  309. | `CloudAnchorNode` | Persistent cross-device anchor (host + resolve) |
  310. | `StreetscapeGeometryNode` | **Geospatial** — semantic city mesh (buildings, terrain) |
  311. | `TerrainAnchorNode` | **Geospatial** — anchor pinned to ground at a lat/lng |
  312. | `RooftopAnchorNode` | **Geospatial** — anchor pinned to a building rooftop |
  313. | Feature | API surface |
  314. |---|---|
  315. | **Automatic placement** | `AutoPlacementScene` + `AutoPlacementModel` — grounded, gesture-ready, no tap |
  316. | **Plane / depth / instant placement** | `ARSceneView(planeRenderer = …, depthMode = …, instantPlacementMode = …)` |
  317. | **Geospatial (VPS)** | `Streetscape` + `Terrain` + `Rooftop` anchors via `Earth` session |
  318. | **Cloud Anchors** | `CloudAnchorNode.host(ttlDays = N)` + `.resolve(id)` |
  319. | **Augmented Faces & Images** | `AugmentedFaceNode`, `AugmentedImageDatabase`, runtime image add |
  320. | **Image Stabilization (EIS)** | `ARSceneView(imageStabilizationMode = ImageStabilizationMode.EIS)` |
  321. | **Camera exposure & focus** | `ARSceneView(sessionCameraConfig = …, focusMode = …, cameraExposure = …)` |
  322. | **Record & Replay** | `rememberARRecorder()` to capture, `ARSceneView(playbackDataset = file)` to replay 1:1 — see [AR debugging](#ar-debugging) |
  323. | **Rerun.io live debug** | `rememberRerunBridge()` streams poses, planes and point clouds to the Rerun viewer |
  324. | **Permission flow** | `ARPermissionHandler` — auto-detected from `ComponentActivity` |
  325. ### Capabilities
  326. | Capability | What it gives you | Where it lives |
  327. |---|---|---|
  328. | **Gestures** | Drag, pinch-to-scale, two-finger rotate, elevate, tap. Per-node opt-in via `isEditable`. | `NodeGestureDelegate`, `OnGestureListener` |
  329. | **Animations** | Skeletal/morph from glTF, plus per-node spring/property/smooth-transform. | `ModelNode.playAnimation()`, `NodeAnimationDelegate` |
  330. | **Physics** | Rigid-body dynamics — gravity, collisions, impulses. Pure Kotlin Multiplatform, no JNI. | `PhysicsNode`, `sceneview-core` |
  331. | **Collision & raycasting** | Ray vs box / sphere intersections, hit-testing, frustum culling. | `CollisionSystem`, `Ray`, `Box`, `Sphere` |
  332. | **Procedural geometry** | Cube/sphere/cylinder/cone/torus/capsule generators, extrusion from 2D shapes (Earcut + Delaunator). | `sceneview-core` geometry + triangulation |
  333. | **HDR environment** | IBL lighting + skybox from `.hdr` / `.ktx`. Async load + reactive swap. | `EnvironmentLoader`, `rememberEnvironment` |
  334. | **Custom materials** | Filament `.filamat` materials with parameters, plus built-in unlit / lit / overlay variants. | `MaterialLoader` |
  335. | **Post-processing** | Bloom, depth of field, SSAO, vignette, color grading, tone mapping. | `View.bloomOptions`, `dynamicResolutionOptions`, … |
  336. | **Compose UI in 3D** | Any `@Composable` as a textured plane in world space. Touches are forwarded, so `Button.onClick`, ripples and inner scrolling work. | `ViewNode` + `ViewNode.WindowManager` |
  337. | **Multiple cameras** | Picture-in-picture, mini-map, security-camera views. | `SecondaryCamera` |
  338. | **Reactive scene graph** | Change state → the tree updates. No imperative `parent.addChild()`. | `SceneScope` / `ARSceneScope` DSL |
  339. ---
  340. ## Model formats
  341. | Format | Android | Apple | Web |
  342. |---|---|---|---|
  343. | glTF / GLB | ✅ | — convert to USDZ (`tools/convert-usdz.sh`) | ✅ |
  344. | USDZ / Reality / USD | — | ✅ RealityKit | — |
  345. | STL (binary + ASCII) | ✅ converted to GLB in memory | ✅ ModelIO, millimetres by default | — |
  346. | OBJ + MTL | ✅ converted to GLB, material colours | ✅ ModelIO | — |
  347. | PLY (binary + ASCII) | ✅ converted to GLB, vertex colours | ✅ ModelIO, vertex colours | — |
  348. | 3MF | ✅ converted to GLB, declared units honoured | ✅ SceneViewSwift parser, declared units honoured | — |
  349. There is no per-format API on Android: `rememberModelInstance(modelLoader, path)` accepts all of
  350. them. On Apple, RealityKit reads no glTF, so `.gltf` / `.glb` are deliberately not in
  351. `ModelFormat`; USD/Reality load through RealityKit and the mesh formats through `MeshAsset`. The format is decided by the file's bytes, not its extension, so a file shared into your
  352. app as `application/octet-stream` with no name still opens. The converters are dependency-free
  353. Kotlin in `sceneview-core`. Tracked next:
  354. [one `ModelFormat` entry point](https://github.com/sceneview/sceneview/issues/3489) and
  355. [every format on the web](https://github.com/sceneview/sceneview/issues/3491). Details:
  356. [Model formats](https://sceneview.github.io/docs/formats/).
  357. ---
  358. ## Apple (iOS / macOS / visionOS)
  359. Native Swift Package built on RealityKit, with a node set mirroring the Android API. Content you
  360. can build synchronously uses the `@NodeBuilder` form:
  361. ```swift
  362. SceneView {
  363. GeometryNode.cube(size: 0.1, color: .blue)
  364. .position(.init(x: 0.5, y: 0, z: 0))
  365. LightNode.directional(intensity: 1000)
  366. }
  367. .environment(.studio)
  368. .cameraControls(.orbit)
  369. ```
  370. AR on iOS — tap a detected plane to place content:
  371. ```swift
  372. ARSceneView(
  373. planeDetection: .horizontal,
  374. onTapOnPlane: { position, arView in
  375. let anchor = AnchorNode.world(position: position)
  376. anchor.add(GeometryNode.cube(size: 0.1, color: .blue).entity)
  377. arView.scene.addAnchor(anchor.entity)
  378. }
  379. )
  380. ```
  381. **Nodes** — `ModelNode` · `GeometryNode` (cube/sphere/cylinder/cone/torus/capsule/plane) ·
  382. `LightNode` · `ImageNode` · `VideoNode` · `TextNode` · `ViewNode` · `BillboardNode` · `MeshNode` ·
  383. `LineNode` · `PathNode` · `ShapeNode` · `PhysicsNode` · `ReflectionProbeNode` · `DynamicSkyNode` ·
  384. `FogNode` · `CameraNode` · `AnchorNode` · `AugmentedImageNode` · `SceneReconstructionNode`
  385. (visionOS scene mesh). Plus an iOS `RerunBridge` with the same wire format as Android.
  386. Full guide: [SceneViewSwift/README.md](SceneViewSwift/README.md).
  387. ---
  388. ## SceneView Web
  389. Two `<script>` tags and one call (see [Web](#web) above). The wrapper is ~24 KB gzipped; the
  390. engine it drives is Filament — the same renderer as Android SceneView — compiled to WebAssembly
  391. (~2.3 MB gzipped).
  392. **JavaScript API (script tag):**
  393. - `SceneView.modelViewer(canvasOrId, url, options?)` — all-in-one viewer with orbit + auto-rotate
  394. - `SceneView.create(canvasOrId, options?)` — empty viewer, load a model later
  395. - `viewer.loadModel(url)` — load or replace a glTF/GLB model
  396. - `viewer.setAutoRotate(enabled)` — toggle rotation
  397. - `viewer.dispose()` — release resources
  398. **Kotlin/JS (`sceneview-web`, npm only)** — the power-user API: `OrbitCameraController`, the
  399. geometry DSL, reactive node updates, and **WebXR** through `ARSceneView` (`immersive-ar`,
  400. hit-test, anchors, light estimation), `VRSceneView` (`immersive-vr`, controllers) and the
  401. low-level `WebXRSession`. The module builds a webpack bundle, so it has no Maven coordinate:
  402. ```bash
  403. npm install sceneview-web
  404. ```
  405. The package expects a `Filament` global and does not include the `SceneView.modelViewer` script
  406. helpers. A Kotlin Multiplatform project that only needs the shared core (collision, math,
  407. geometry, animation, physics — no renderer) uses
  408. `implementation("io.github.sceneview:sceneview-core-js:4.69.7")`.
  409. [Landing page](https://sceneview.github.io/) · [Web demo](https://sceneview.github.io/web-demo/) · [npm](https://www.npmjs.com/package/sceneview-web)
  410. ---
  411. ## The Compose-native successor to Sceneform
  412. Google [archived Sceneform](https://github.com/google-ar/sceneform-android-sdk) in 2021 and ships
  413. no first-party declarative AR renderer. SceneView descends from the maintained Sceneform
  414. community fork: ARCore for perception, Filament for rendering, Jetpack Compose for the API, and
  415. glTF (`.glb` / `.gltf`) instead of the deprecated `.sfb` format.
  416. Coming from Sceneform? The [migration guide](https://sceneview.github.io/docs/migration/) maps it
  417. concept by concept (`ArFragment` → `ARSceneView { }`, `ModelRenderable` →
  418. `rememberModelInstance`, and so on).
  419. ---
  420. ## AR debugging
  421. - **Record & Replay** — capture an ARCore session once with `rememberARRecorder()`, replay it 1:1
  422. at your desk with `ARSceneView(playbackDataset = file)`. See
  423. [`docs/docs/ar-recording.md`](docs/docs/ar-recording.md) and the
  424. [Record & Playback demo](samples/android-demo/RECORDING_PLAYBACK.md).
  425. - **Hosted Rerun viewer** — export a scan's **Rerun recording** from the 3D Scan demo, host the `.rrd` file at
  426. an https address that ends in `.rrd`, and open
  427. `https://sceneview.github.io/rerun/?url=<encoded-url>` to scrub the session frame by frame in a
  428. browser, with no local install. The host has to allow cross-origin requests (CORS): a public
  429. GitHub repository's `raw.githubusercontent.com` link and GitHub Pages do, a GitHub release
  430. asset does not (checked 2026-10-13); an R2 or S3 bucket does with a CORS rule that allows
  431. `https://sceneview.github.io`. Architecture and the Kotlin API
  432. (`RerunBridge.requestSaveAndShare`) are in the *AR Debug — Rerun.io* section of
  433. [`llms.txt`](./llms.txt).
  434. ---
  435. ## Architecture
  436. Each platform uses its **native renderer**. Shared logic lives in Kotlin Multiplatform.
  437. ```
  438. sceneview-core (Kotlin Multiplatform)
  439. ├── math, collision, geometry, physics, animation, model-format converters
  440. │
  441. ├── sceneview (Android) → Filament + Jetpack Compose
  442. ├── arsceneview (Android) → ARCore
  443. ├── sceneview-compose (KMP) → one SceneViewer for Android, iOS and desktop
  444. ├── SceneViewSwift (Apple) → RealityKit + SwiftUI
  445. ├── sceneview-web (Web) → Filament.js + WebXR
  446. └── flutter/ · react-native/ → bridges to the native views
  447. ```
  448. ## Samples
  449. | Sample | Platform | Run |
  450. |---|---|---|
  451. | `samples/android-demo` | Android — 3D & AR | `./gradlew :samples:android-demo:assembleDebug` |
  452. | `samples/android-tv-demo` | Android TV | `./gradlew :samples:android-tv-demo:assembleDebug` |
  453. | `samples/ios-demo` | iOS — 3D & AR | Open in Xcode |
  454. | `samples/web-demo` | Web | `cd samples/web-demo && cp ../../website-static/js/sceneview.js site/js/sceneview.js && npx http-server site -p 8080` |
  455. | `samples/desktop-demo` | Desktop (JDK 21+) | `./gradlew :samples:desktop-demo:run` |
  456. | `samples/flutter-demo` | Flutter | `cd samples/flutter-demo && flutter run` |
  457. | `samples/react-native-demo` | React Native | See its README |
  458. ## Used in
  459. In Google Play apps (checked in their published builds: the Volkswagen Group and Philips Hue apps on
  460. November 17, 2026, Medal and IKEA on November 9, 2026):
  461. - **[Volkswagen](https://www.volkswagen.com/)** — [Volkswagen](https://play.google.com/store/apps/details?id=com.volkswagen.weconnect).
  462. - **[Audi](https://www.audi.com/)** — [myAudi](https://play.google.com/store/apps/details?id=de.myaudi.mobile.assistant).
  463. - **[Porsche](https://www.porsche.com/)** — [My Porsche](https://play.google.com/store/apps/details?id=de.porsche.one).
  464. - **[CUPRA](https://www.cupra.com/)** — [My CUPRA](https://play.google.com/store/apps/details?id=com.cupra.mycupra).
  465. - **[Philips Hue](https://www.philips-hue.com/)** — [Philips Hue](https://play.google.com/store/apps/details?id=com.philips.lighting.hue2): ships SceneView's AR module (`ARSceneView`).
  466. - **[Medal](https://medal.tv/)** — [Medal](https://play.google.com/store/apps/details?id=tv.medal.recorder).
  467. - **[IKEA](https://www.ikea.com/)** — [IKEA](https://play.google.com/store/apps/details?id=com.ingka.ikea.app).
  468. Declared in their public source code or published build files (checked November 17, 2026):
  469. - **[Meshtastic](https://github.com/meshtastic/Meshtastic-Android/blob/main/feature/node/build.gradle.kts)**: the Android app's 3D and AR device viewer (SceneView 4.69.5).
  470. - **[Bitkey by Block](https://github.com/proto-at-block/bitkey/blob/main/app/gradle/libs.versions.toml)**: 3D rendering of the hardware wallet in the Android app (SceneView 2.3.0).
  471. - **[Vocable AAC by WillowTree](https://github.com/willowtreeapps/vocable-android/blob/main/gradle/libs.versions.toml)**: head tracking for hands-free communication (ARSceneView 2.3.3).
  472. - **[Niantic Spatial](https://github.com/nianticspatial/nsdk-samples-kotlin/blob/main/NsdkSamples/NsdkSamples/build.gradle.kts)**: the Kotlin samples of its spatial SDK (ARSceneView 2.3.1).
  473. - **[GeneXus](https://central.sonatype.com/artifact/com.genexus.android/AugmentedReality)**: its Android augmented reality module, in the Maven Central POM (SceneView 2.3.0).
  474. - **[TruVideo](https://central.sonatype.com/artifact/com.truvideo.com/sdk-camera)**: its camera SDK, in the Maven Central POM (ARSceneView 2.3.0).
  475. ## Built with SceneView
  476. - **[3D AR Model Viewer](https://play.google.com/store/apps/details?id=com.gorisse.thomas.arcamera)** —
  477. open a 3D file from any app or link (GLB, glTF, STL, OBJ, PLY, 3MF) and see it in your room at
  478. real size.
  479. - **[Will It Fit](https://play.google.com/store/apps/details?id=com.gorisse.thomas.willitfit)** —
  480. enter a piece of furniture's dimensions and see whether it fits before you buy.
  481. ---
  482. ## Maintainer
  483. [Thomas Gorisse](https://github.com/ThomasGorisse) — Mobile SDKs and the AI agent pipeline behind them · Creator of SceneView, open-source 3D & AR
  484. ## Links
  485. - [Website](https://sceneview.github.io/) · [Web demo](https://sceneview.github.io/web-demo/) · [Documentation](https://sceneview.github.io/docs/)
  486. - [Discord](https://discord.gg/UbNDDBTNqb) · [Contributing](CONTRIBUTING.md) · [Changelog](CHANGELOG.md) · [Migration v2 → v3](MIGRATION.md)
  487. ## Sponsors
  488. <!-- Same message as the website home page (#fund) and companies.html#sponsor: edit the three together.
  489. Generic on purpose: no company is named. Open Collective first, GitHub Sponsors second, nothing else. -->
  490. ### SceneView runs in commercial products. Sponsor it.
  491. Commercial products ship SceneView. Almost nobody contributes back, in code or in funding, while the maintainers carry every fix and every release. If SceneView is part of your product, **sponsor it.**
  492. **Sponsor.** Funds the fixes, Filament upgrades and releases your product depends on. Open Source Collective issues the invoice and the receipt; your company is listed nowhere unless you ask.
  493. **[Sponsor on Open Collective](https://opencollective.com/sceneview)** · or through [GitHub Sponsors](https://github.com/sponsors/sceneview)
  494. Questions about SceneView in your product: [hello@sceneview.dev](mailto:hello@sceneview.dev).
  495. <a href="https://opencollective.com/sceneview"><img src="https://opencollective.com/sceneview/organizations.svg?avatarHeight=56&width=830" alt="Logos of the companies sponsoring SceneView on Open Collective"></a>
  496. <a href="https://opencollective.com/sceneview"><img src="https://opencollective.com/sceneview/individuals.svg?avatarHeight=40&width=830&button=false" alt="Avatars of the people backing SceneView on Open Collective"></a>
  497. [How sponsorship works](.github/SPONSORS.md)

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.