Skip to main content
Ctrl+K
Genesis 1.0.0 documentation - Home Genesis 1.0.0 documentation - Home
  • User Guide
  • API Reference
  • GitHub
  • Discord
  • PyPI
  • User Guide
  • API Reference
  • GitHub
  • Discord
  • PyPI

Section Navigation

  • Scene
    • Scene
    • Simulator
  • Entity
    • RigidEntity
      • RigidEntity
      • RigidLink
      • RigidJoint
      • RigidGeom
      • RigidVisGeom
    • MPMEntity
    • FEMEntity
    • PBDEntity
      • PBDParticleEntity
      • PBDFreeParticleEntity
      • PBD2DEntity
      • PBD3DEntity
      • PBDTetEntity
    • SPHEntity
    • DroneEntity
    • HybridEntity
    • Emitter
  • Visualization & Rendering
    • Visualizer
    • Viewer
    • Renderers
      • Rasterizer
      • Raytracer
      • BatchRenderer
    • Cameras
      • Camera
    • Lights
  • Sensors
    • Camera
    • Contact Sensors
    • IMU Sensor
    • Raycaster Sensor
  • Recording & Playback
    • Recorder
    • RecorderManager
    • File Writers
    • Plotters
  • Physics Engine
    • Solvers
      • RigidSolver
      • MPMSolver
      • FEMSolver
      • PBDSolver
      • SPHSolver
      • SFSolver
      • ToolSolver
    • Couplers
      • LegacyCoupler
      • SAPCoupler
      • IPCCoupler
    • States
  • Material
    • gs.materials.Rigid
    • MPM
      • gs.materials.MPM.Elastic
      • gs.materials.MPM.ElastoPlastic
      • gs.materials.MPM.Liquid
      • gs.materials.MPM.Muscle
      • gs.materials.MPM.Sand
      • gs.materials.MPM.Snow
    • FEM
      • gs.materials.FEM.Elastic
      • gs.materials.FEM.Muscle
    • PBD
      • gs.materials.PBD.Elastic
      • gs.materials.PBD.Cloth
      • gs.materials.PBD.Liquid
      • gs.materials.PBD.Particle
    • SPH
      • gs.materials.SPH.Liquid
    • gs.materials.Hybrid
  • Options
    • gs.options.Options
    • Simulator, Coupler & Solver Options
      • gs.options.SimOptions
      • gs.options.CouplerOptions
      • gs.options.ToolOptions
      • gs.options.RigidOptions
      • gs.options.MPMOptions
      • gs.options.SPHOptions
      • gs.options.PBDOptions
      • gs.options.FEMOptions
      • gs.options.SFOptions
    • Morph
      • gs.morphs.Morph
      • Primitive
        • gs.morphs.Primitive
        • gs.morphs.Box
        • gs.morphs.Sphere
        • gs.morphs.Cylinder
        • gs.morphs.Plane
      • FileMorph
        • gs.morphs.FileMorph
        • gs.morphs.Mesh
        • gs.morphs.URDF
        • gs.morphs.MJCF
        • gs.morphs.Terrain
        • gs.morphs.Drone
    • Renderer
      • gs.renderers.Renderer
      • gs.renderers.Rasterizer
      • gs.renderers.RayTracer
      • gs.renderers.RayTracer
    • Surface
      • gs.surfaces.Surface
      • Plastic
        • gs.surfaces.Plastic
        • gs.surfaces.Rough
        • gs.surfaces.Smooth
        • gs.surfaces.Reflective
        • gs.surfaces.Collision
        • gs.surfaces.Default
      • Metal
        • gs.surfaces.Metal
        • gs.surfaces.Iron
        • gs.surfaces.Aluminium
        • gs.surfaces.Copper
        • gs.surfaces.Gold
      • Emission
        • gs.surfaces.Emission
      • Glass
        • gs.surfaces.Glass
        • gs.surfaces.Water
    • Texture
      • gs.textures.Texture
      • gs.textures.ColorTexture
      • gs.textures.ImageTexture
    • Viewer & Visualization
      • gs.options.ViewerOptions
      • gs.options.VisOptions
  • Utilities & Helpers
    • Constants & Enums
    • Device & Platform Utilities
    • Tensor Utilities
    • Geometry Utilities
    • File I/O Utilities
  • Differentiable Simulation
    • Tensor
    • Creation Operations
  • API Reference

API Reference#

This section provides comprehensive documentation for the Genesis API. The reference is organized by functionality to help you find the classes and functions you need.

Core Components#

  • Scene
    • Scene
    • Simulator
  • Entity
    • RigidEntity
    • MPMEntity
    • FEMEntity
    • PBDEntity
    • SPHEntity
    • DroneEntity
    • HybridEntity
    • Emitter

Visualization & Rendering#

  • Visualization & Rendering
    • Visualizer
    • Viewer
    • Renderers
    • Cameras
    • Lights

Sensors & Perception#

  • Sensors
    • Camera
    • Contact Sensors
    • IMU Sensor
    • Raycaster Sensor

Data Recording & Playback#

  • Recording & Playback
    • Recorder
    • RecorderManager
    • File Writers
    • Plotters

Physics Engine#

  • Physics Engine
    • Solvers
    • Couplers
    • States

Configuration & Options#

  • Material
    • gs.materials.Rigid
    • MPM
    • FEM
    • PBD
    • SPH
    • gs.materials.Hybrid
  • Options
    • gs.options.Options
    • Simulator, Coupler & Solver Options
    • Morph
    • Renderer
    • Surface
    • Texture
    • Viewer & Visualization

Utilities & Helpers#

  • Utilities & Helpers
    • Constants & Enums
    • Device & Platform Utilities
    • Tensor Utilities
    • Geometry Utilities
    • File I/O Utilities

Differentiable Simulation#

  • Differentiable Simulation
    • Tensor
    • Creation Operations

previous

⏱️ Profiling

next

Scene

On this page
  • Core Components
  • Visualization & Rendering
  • Sensors & Perception
  • Data Recording & Playback
  • Physics Engine
  • Configuration & Options
  • Utilities & Helpers
  • Differentiable Simulation
Edit on GitHub

This Page

  • Show Source

© Copyright 2024-2026, Genesis Developers.

Created using Sphinx 6.2.1.

Built with the PyData Sphinx Theme 0.16.1.