API reference

Generated from the source with dart doc, one tree per package. For what a package is for rather than what it exports, start at the package index; for how the pieces fit together, read ARCHITECTURE.md.

• flame_flutter3d_audioSound for a Flame game bridged to flutter3d: the game's audio scene as a component, silent until the player's first input, and loops that play for as long as their component lives.
• flame_flutter3dA bridge to the Flame 2D game engine: Flame draws its own layer, flutter3d draws its own, and the two stay reconciled — transforms, lifecycle, physics contacts, input and the actor system.
• flutter3d_appWhat any Flutter application on flutter3d is assembled from: which backend to open and the runtime fallback, the surface a frame reaches Flutter through, widgets drawn in the scene, a level loaded into a scene, and storage.
• flutter3d_audioPositional audio for flutter3d: attenuation, panning and voice limiting, with a pluggable backend.
• flutter3d_conformanceThe behaviour a flutter3d_hardware backend has to have, as tests it can run against itself. Flat: no Flutter import of its own, and flutter3d_shaders (its one dependency that used to carry the SDK in) no longer does either.
• flutter3d_coreThe engine's rendering core with no Flutter SDK behind it: scene graph, animation, the render graph, and model/material loading down to the one call each still needs an injected reader or decoder for.
• flutter3d_cpuA software backend for flutter3d_hardware: no GPU, no shading language, and therefore the sharpest test of whether the interface is an interface.
• flutter3d_editor_coreThe headless half of a level editor: a document you can nudge, undo and write back, the handles a pointer hits, and the project a template turns into.
• flutter3d_editor_mcpA level editor an agent can drive: the editor's own commands offered as tools over stdio, with one document open per process.
• flutter3d_editor_widgetsShared editor controls — a number field, a colour field, a section label, a range slider, an enum dropdown, a texture slot row, a texture path field, a colour swatch field and the FieldRow they assemble into, so far — over EditorWidgetsTheme, so the modeller and the level editor stop keeping their own copies.
• flutter3d_game_platformerA second genre: a runner who jumps twice and dashes, things to collect, hazards to fall into, and checkpoints to come back at.
• flutter3d_game_racingA third genre: a car with grip it can lose, a track measured in metres, and the lap that comes of going round it.
• flutter3d_game_shooterThe parts of a first-person shooter that are not parts of an engine: monsters, weapons, an inventory, and the step order that ties them together.
• flutter3d_game_strategyA fourth genre: ground made of samples, units that move as a crowd rather than one at a time, and orders given to a selection instead of to a body.
• flutter3d_gameWhat a game on flutter3d adds to an application: touch, keyboard, mouse and gamepad input, the run being played, the screens that are not the game, and the actors and fixtures a simulation moves, drawn.
• flutter3d_hardwareThe graphics vocabulary flutter3d is written against: formats, handles, a command encoder and a device. Names no graphics API. No Flutter, no renderer.
• flutter3d_impellerThe flutter_gpu backend for flutter3d: one implementation of flutter3d_hardware, and the only place in the stack that names a graphics API.
• flutter3d_labVirtual laboratory simulations — edu-04's pendulum is the first. Plain Dart, so a server can replay a lab run with no Flutter SDK in it.
• flutter3d_ltiLTI 1.3 launch and xAPI reporting: OIDC login, id_token verification against a platform's JWKS, an Assignment and Grade Services client, and an xAPI statement client — no shelf, no jaspr, no Flutter.
• flutter3d_mcp_kitWhat every flutter3d MCP server shares: a table of tools that are their own handlers, answers that refuse without failing, and a loopback HTTP transport a running application can offer a session over.
• flutter3d_meshAn editable mesh for flutter3d: half-edge topology on persistent typed arrays, selections, and the operations a modeller runs on them.
• flutter3d_model_coreThe headless half of a model editor: a project of objects and materials, the commands that change one, the history that takes them back, and what it refuses to export.
• flutter3d_model_mcpA model editor an agent can drive: an MCP server over stdio whose tools are the editor's own commands, one project per process.
• flutter3d_net_webrtcA NetTransport over a real WebRTC data channel — net-01's rollback engine, P2P, with net-02's relay carrying only the SDP/ICE handshake.
• flutter3d_netRollback netcode over `sim`: input frames per step, prediction, correction, and the transport behind an interface so a game never names WebRTC or a socket.
• flutter3d_particlesA pooled CPU particle simulation for flutter3d, and the contributor that draws it. Its particles can be a light source, which is the part no other engine on this platform has.
• flutter3d_physicsCollision shapes, a broadphase, queries, a character controller and an XPBD cloth solver. No Flutter, no renderer, no game.
• flutter3d_samplesThe models flutter3d's decoders are tested against and its demo browses: the official Khronos glTF sample assets, the Utah teapot, and the .f3d files converted from them.
• flutter3d_shadersThe engine's shader sources, in GLSL, for every backend to compile.
• flutter3d_sim_mcpA level an agent can play blind, of whatever game a host hands it — ai-00 — and why a frame of it is wrong: a debug view of normals and depth, the HDR value of one pixel, the passes the frame graph ran — par-02.
• flutter3d_simThe simulation: a fixed step, an ECS, levels, navigation, saves and replays. Plain Dart, so it runs on a server.
• flutter3d_stereoStereo rendering for flutter3d: a rig of two eyes under a head, the widget that draws the pair into one frame, and the settings a pair can actually have.
• flutter3d_testingRenders a flutter3d scene with no GPU and compares it against a reference image, so a game gets pixel regression tests on a machine with no display.
• flutter3d_webglA WebGL2 backend for flutter3d: the second implementation of flutter3d_hardware, and the one that tells us whether the HAL is a seam or a description of Impeller.
• flutter3d_webgpuA WebGPU backend for flutter3d: the fourth implementation of flutter3d_hardware, and the first one whose API bakes per-draw state into the pipeline object.
• flutter3dA 3D engine on Flutter GPU: scene graph, glTF/OBJ/.f3d loading, PBR, shadows, bloom, skinning.
• pad_inputReads a gamepad's sticks, triggers and buttons as a snapshot the caller asks for, with a dead zone applied and no opinion about what any button means.
• pointer_lockLocks the mouse pointer in place and reports its motion as relative deltas, which Flutter offers on no desktop platform and does not surface in a browser.