Introduction

PhysicsScene is a Jetpack Compose library that maps existing composables into a Box2D-driven scene.

This documentation is structured like an API portal: top navigation for global actions, left sidebar for section browsing, and focused content pages in the center.

Top bar features
Use the GitHub icon in the header to jump to the repository. Use the theme control in the header to switch between light, dark, and auto mode.

Documentation map

Start

Install the library and run your first scene quickly.

Open Getting Started

Low-Level API

Understand PhysicsScene, modifier registration, commands, snapshots, and event flow.

Open API section

Effects

Choose built-in effects or shape your own using CustomEffect.

Open Effects section

Examples

See practical compositions mirrored from :app-demo.

Open Examples section

Core building blocks

1. PhysicsScene(...) hosts simulation and shard rendering.
2. Modifier.physicsBody(...) registers composables as bodies.
3. PhysicsSceneState dispatches commands and exposes snapshots.

Credits

PhysicsScene runs on top of Box2D (com.badlogicgames.gdx:gdx-box2d).