ThreeMojo documentation

ThreeMojo is a port of three.js to Mojo. It renders 3D scenes in software on the CPU, or on a GPU, and writes the result to an image file.

The documentation follows Diátaxis. Each page has one job.

Tutorials

Learn by doing.

• Render your first scene
• Light, texture and animate a scene

How-to guides

Get a task done.

• Install
• Run the checks
• Use the GPU backend
• Measure coverage
• Measure examples
• Add a feature
• Write documentation

Reference

Look something up.

• Scene graph
• Rotations
• Cameras
• Geometry
• Geometry addons
• Lofts and clipping groups
• Sculptor
• Procedural generators
• Meshes and assets
• Scene objects
• Animated objects
• Lines
• Points and sprites
• Helpers
• Raycasting
• Curves and paths
• Animation
• Skinning
• Materials
• Node materials
• TSL functions
• Lights
• Lighting addons
• Fog
• Textures
• Renderer
• Renderer hooks and material flags
• Rasterization
• GPU backend
• Render target and framebuffer
• Post-processing
• GPU computation
• Compute nodes
• Progressive light map
• Gaussian splats
• Voxel global illumination
• SVG renderer
• Image files
• Model files
• More model files
• Exporters
• Scene JSON
• Windowing and controls
• Math
• Math addons
• Units
• Coverage tool
• Commands
• Examples
• Benchmarks
• Extensions
• Physics
• Physics query snapshots
• Continuous collision
• Tick force restoration
• Image decode queue
• Norm consumers
• Water
• Animals
  • Animal anatomy
  • Anatomy validity
• Buildings
  • Numerics
  • Building topology
  • Building model
  • IFC exchange
  • Procedural towers
  • Floor plans and interiors
  • Frame analysis
  • Shell analysis
  • Building energy
• CARLA
  • CARLA geometry
  • CARLA maps
  • CARLA lane orientation
  • CARLA fixed-s nearest
  • CARLA point distance
  • CARLA physics
  • CARLA world
  • CARLA sensors
  • CARLA traffic manager
  • CARLA agents
  • CARLA recorder
  • CARLA rendering
  • CARLA assets
• Femur
• Tibia
• Fibula
• Patella
• Knee
• Muscles
• Vessels
• Lymph
• Nerves
• Integument
• Leg
• Foot
• Pelvis
• Torso
• Arm
• Hand
• Head
• Genome
• Game humanoid
• Humanoid fidelity
• Audio-aligned game faces
• Converted assets
• Mesh quality
• Segment inertia

Explanation

Understand why.

• Why a software rasterizer
• Why the scene graph is an array
• Why color is linear
• Why a normal is not a color
• Why interpolation is perspective-correct
• Why coverage uses fixed point
• Why shading is per fragment
• Why mipmaps
• Why transparency is sorted
• Why render hooks are a trait
• Why types and checks both exist
• Why the CPU and GPU share code
• Why the CPU renderer uses bands
• Why the PNG reader checks structure
• Why extensions sit beside the port
• The CUDA teardown hang
• The Mojo compiler hang

Where the pages live

The source of every page is docs/wiki/ in the repository. make docs-check checks the writing rules. make wiki-publish copies the pages to this wiki, and the CI workflow does the same on every push to main. Edit the files in the repository, not the wiki.