Reference
===============

This reference manual details modules, functions, and variables included in
Manim, describing what they are and what they do.  For learning how to use
Manim, see :doc:`tutorials`.  For a list of changes since the last release, see
the :doc:`changelog`.

.. warning:: The pages linked to here are currently a work in progress.

.. currentmodule:: manim

********************
Mathematical Objects
********************

.. autosummary::
   :toctree: reference

   ~mobject.changing
   ~mobject.coordinate_systems
   ~mobject.frame
   ~mobject.functions
   ~mobject.geometry
   ~mobject.matrix
   ~mobject.mobject
   ~mobject.mobject_update_utils
   ~mobject.number_line
   ~mobject.numbers
   ~mobject.probability
   ~mobject.shape_matchers
   ~mobject.three_d_shading_utils
   ~mobject.three_d_utils
   ~mobject.three_dimensions
   ~mobject.value_tracker
   ~mobject.vector_field
   ~mobject.svg.brace
   ~mobject.svg.code_mobject
   ~mobject.svg.drawings
   ~mobject.svg.svg_mobject
   ~mobject.svg.tex_mobject
   ~mobject.svg.text_mobject
   ~mobject.types.image_mobject
   ~mobject.types.point_cloud_mobject
   ~mobject.types.vectorized_mobject


******
Scenes
******

.. autosummary::
   :toctree: reference

   ~scene.graph_scene
   ~scene.moving_camera_scene
   ~scene.reconfigurable_scene
   ~scene.sample_space_scene
   ~scene.scene
   ~scene.scene_file_writer
   ~scene.three_d_scene
   ~scene.vector_space_scene
   ~scene.zoomed_scene


**********
Animations
**********

.. autosummary::
   :toctree: reference

   ~animation.animation
   ~animation.composition
   ~animation.creation
   ~animation.fading
   ~animation.growing
   ~animation.indication
   ~animation.movement
   ~animation.numbers
   ~animation.rotation
   ~animation.specialized
   ~animation.transform
   ~animation.update


*******
Cameras
*******

.. autosummary::
   :toctree: reference

   ~camera.camera
   ~camera.mapping_camera
   ~camera.moving_camera
   ~camera.multi_camera
   ~camera.three_d_camera


*********
Utilities
*********

.. autosummary::
   :toctree: reference

   ~utils.bezier
   ~utils.color
   ~utils.config_ops
   ~utils.hashing
   ~utils.images
   ~utils.iterables
   ~utils.paths
   ~utils.rate_functions
   ~utils.simple_functions
   ~utils.sounds
   ~utils.space_ops
   ~utils.strings
   ~utils.tex
   ~utils.tex_file_writing


*************
Other modules
*************

.. autosummary::
   :toctree: reference

   _config
   constants
   container


.. This is here so that sphinx doesn't complain about changelog.rst not being
   included in any toctree
.. toctree::
   :hidden:

   changelog