public-mirrors/3b1b-manim
1
0
Fork 0
mirror of https://github.com/3b1b/manim.git synced 2025-09-01 00:48:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update docs

Browse source
This commit is contained in:
TonyCrane 2022-06-28 09:13:41 +08:00
parent 844d139ed4
commit 606ee5e4f1
No known key found for this signature in database
GPG key ID: 2313A5058A9C637C
2 changed files with 29 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
docs/source/documentation/custom_config.rst
View file

@ -98,6 +98,9 @@ Import line that need to execute when entering interactive mode directly.
- ``font``
Default font of Text
- ``text_alignment``
Default text alignment for LaTeX
- ``background_color``
Default background color
@ -113,6 +116,11 @@ means left(L) / middle(O) / right(R)).
The number of the monitor you want the preview window to pop up on. (default is 0)
``full_screen``
---------------
Whether open the window in full screen. (default is false)
``break_into_partial_movies``
-----------------------------
@ -123,22 +131,27 @@ to form the full scene.
Sometimes video-editing is made easier when working with the broken up scene, which
effectively has cuts at all the places you might want.
``camera_qualities``
``camera_resolutions``
--------------------
Export quality
Export resolutions
- ``low``
Low quality (default is 480p15)
Low resolutions (default is 480p)
- ``medium``
Medium quality (default is 720p30)
Medium resolutions (default is 720p)
- ``high``
High quality (default is 1080p30)
High resolutions (default is 1080p)
- ``ultra_high``
Ultra high quality (default is 4K60)
Ultra high resolutions (default is 4K)
- ``default_quality``
Default quality (one of the above four)
- ``default_resolutions``
Default resolutions (one of the above four, default is high)
``fps``
-------
Export frame rate. (default is 30)

14
docs/source/getting_started/configuration.rst
View file

@ -32,10 +32,11 @@ Some useful flags
All supported flags
^^^^^^^^^^^^^^^^^^^
========================================================== ====== =================================================================================================================================================================================================
========================================================== ====== =====================================================================================================================================================================================================
flag abbr function
========================================================== ====== =================================================================================================================================================================================================
========================================================== ====== =====================================================================================================================================================================================================
``--help`` ``-h`` Show the help message and exit
``--version`` ``-v`` Display the version of manimgl
``--write_file`` ``-w`` Render the scene as a movie file
``--skip_animations`` ``-s`` Skip to the last frame
``--low_quality`` ``-l`` Render at a low quality (for faster rendering)
@ -45,7 +46,7 @@ flag abbr function
``--full_screen`` ``-f`` Show window in full screen
``--presenter_mode`` ``-p`` Scene will stay paused during wait calls until space bar or right arrow is hit, like a slide show
``--save_pngs`` ``-g`` Save each frame as a png
``--save_as_gif`` ``-i`` Save the video as gif
``--gif`` ``-i`` Save the video as gif
``--transparent`` ``-t`` Render to a movie file with an alpha channel
``--quiet`` ``-q``
``--write_all`` ``-a`` Write all the scenes from a file
@ -54,14 +55,15 @@ flag abbr function
``--config`` Guide for automatic configuration
``--file_name FILE_NAME`` Name for the movie or image file
``--start_at_animation_number START_AT_ANIMATION_NUMBER`` ``-n`` Start rendering not from the first animation, but from another, specified by its index. If you passing two comma separated values, e.g. "3,6", it will end the rendering at the second value.
``--embed LINENO`` ``-e`` Takes a line number as an argument, and results in the scene being called as if the line ``self.embed()`` was inserted into the scene code at that line number
``--embed [EMBED]`` ``-e`` Creates a new file where the line ``self.embed`` is inserted into the Scenes construct method. If a string is passed in, the line will be inserted below the last line of code including that string.
``--resolution RESOLUTION`` ``-r`` Resolution, passed as "WxH", e.g. "1920x1080"
``--fps FPS`` Frame rate, as an integer
``--fps FPS`` Frame rate, as an integer
``--color COLOR`` ``-c`` Background color
``--leave_progress_bars`` Leave progress bars displayed in terminal
``--video_dir VIDEO_DIR`` Directory to write video
``--config_file CONFIG_FILE`` Path to the custom configuration file
========================================================== ====== =================================================================================================================================================================================================
``--log-level LOG_LEVEL`` Level of messages to Display, can be DEBUG / INFO / WARNING / ERROR / CRITICAL
========================================================== ====== =====================================================================================================================================================================================================
custom_config
--------------