Skip to content

Configuration

The film's code
import manimgx as m

m.config.pixel_width, m.config.pixel_height = 1080, 1920


class ConfigurationHero(m.Scene):
    def construct(self) -> None:
        frame = m.Rectangle(
            width=m.config.frame_width - 0.2,
            height=m.config.frame_height - 0.2,
            color=m.BLUE,
        )
        square = m.Square(side_length=8, color=m.YELLOW).scale(0.97)
        label = m.Text("1080 × 1920", font_size=56)
        self.play(m.Create(frame), m.Create(square), m.Write(label))
        self.wait()

m.config holds what every scene is made with: the video's size in pixels, its frame rate, its background, and the frame's size in units. Set it after import manimgx as m, before the scene is made; the command line's options set it too (-r 1080x1920, --fps 30).

The frame has the video's shape, and its short side is 8 units: a wide video shows about 14.2 × 8 units, a tall one 8 × 14.2, and the 8 × 8 square in the middle is in both.

m.config

The configuration every scene is made and rendered with, as m.config: a Config. Set its fields before making a scene: m.config.pixel_width, m.config.pixel_height = 1280, 720.

Config

The configuration scenes are made and rendered with: the video's size, frame rate and background, and the frame's size in scene units.

There is one, config. Set its fields before making a scene: a scene's camera, and the mobjects that fill the frame, take their sizes and the background from it when they are made, and render takes the video's size and frame rate when it starts. It can be read and set as a dictionary too, as Manim code does: config["frame_width"], config["pixel_height"] = 720.

The frame has the video's proportions, and its short side is 8 units: a wide video (16:9) shows about 14.2 × 8 units, a tall one (9:16) 8 × 14.2. So what fits in the 8 × 8 square at the center fits both, at the same size.

pixel_width

The width of the video, in pixels (default 1920).

pixel_height

The height of the video, in pixels (default 1080). For a tall video (9:16), make it the larger: config.pixel_width, config.pixel_height = 1080, 1920.

frame_rate

How many frames a second the film has (default 60): frame k shows the scene at exactly k / frame_rate seconds. A video needs a whole number.

simulation_rate

How many times a second the simulation clock ticks (default 60).

A time-based updater that is not a flow is simulated: it steps at each tick of this clock and at the end of each play and wait, never at frames, so it takes the same steps at any frame rate, and a frame shows it as its last step left it. While one is in the scene, the scene computes every tick. At 60 frames a second each frame is a tick, so the ticks cost nothing more; at a frame rate that divides it (10, 12, 15, 20, 30), every frame falls on a tick too.

background_color

The color of the background (default black).

background_opacity

The opacity of the background, from 0 to 1 (default 1).

frame_height

The height of the frame, in scene units. Unless set, the frame's short side is 8 units: a wide video's frame is 8 high, a tall one's as high as its proportions make it when it is 8 wide (about 14.2 at 9:16). Its width follows from the video's proportions.

config.frame_height
Source

src/manimgx/config.py

62
63
64
65
66
67
68
69
def frame_height(self) -> float:
    """The height of the frame, in scene units. Unless set, the frame's short side is
    8 units: a wide video's frame is 8 high, a tall one's as high as its proportions
    make it when it is 8 wide (about 14.2 at 9:16). Its width follows from the
    video's proportions."""
    if self._frame_height is not None:
        return self._frame_height
    return 8.0 * max(1.0, self.pixel_height / self.pixel_width)

frame_width

The width of the frame, in scene units: frame_height times the video's aspect ratio (about 14.2 at 16:9, 8 at 9:16).

config.frame_width
Source

src/manimgx/config.py

76
77
78
79
def frame_width(self) -> float:
    """The width of the frame, in scene units: `frame_height` times the video's
    aspect ratio (about 14.2 at 16:9, 8 at 9:16)."""
    return self.frame_height * self.pixel_width / self.pixel_height

frame_x_radius

Half the frame's width, in scene units: the x of its right edge.

config.frame_x_radius
Source

src/manimgx/config.py

82
83
84
def frame_x_radius(self) -> float:
    """Half the frame's width, in scene units: the x of its right edge."""
    return self.frame_width / 2

frame_y_radius

Half the frame's height, in scene units (4 for a wide video): the y of its top edge.

config.frame_y_radius
Source

src/manimgx/config.py

87
88
89
90
def frame_y_radius(self) -> float:
    """Half the frame's height, in scene units (4 for a wide video): the y of its top
    edge."""
    return self.frame_height / 2

top

The middle of the frame's top edge: frame_y_radius up from the origin.

config.top
Source

src/manimgx/config.py

93
94
95
def top(self) -> "Point3D":
    """The middle of the frame's top edge: `frame_y_radius` up from the origin."""
    return self.frame_y_radius * np.array([0.0, 1.0, 0.0])

bottom

The middle of the frame's bottom edge: frame_y_radius down from the origin.

config.bottom
Source

src/manimgx/config.py

 98
 99
100
101
def bottom(self) -> "Point3D":
    """The middle of the frame's bottom edge: `frame_y_radius` down from the
    origin."""
    return -self.top

right_side

The middle of the frame's right edge: frame_x_radius right of the origin.

config.right_side
Source

src/manimgx/config.py

104
105
106
107
def right_side(self) -> "Point3D":
    """The middle of the frame's right edge: `frame_x_radius` right of the
    origin."""
    return self.frame_x_radius * np.array([1.0, 0.0, 0.0])

left_side

The middle of the frame's left edge: frame_x_radius left of the origin.

config.left_side
Source

src/manimgx/config.py

110
111
112
def left_side(self) -> "Point3D":
    """The middle of the frame's left edge: `frame_x_radius` left of the origin."""
    return -self.right_side

aspect_ratio

The video's width over its height: pixel_width / pixel_height (16:9 by default).

config.aspect_ratio
Source

src/manimgx/config.py

115
116
117
118
def aspect_ratio(self) -> float:
    """The video's width over its height: `pixel_width / pixel_height` (16:9 by
    default)."""
    return self.pixel_width / self.pixel_height

background

The color of the background, as a ManimColor.

config.background
Source

src/manimgx/config.py

121
122
123
def background(self) -> ManimColor:
    """The color of the background, as a [`ManimColor`][manimgx.ManimColor]."""
    return ManimColor(self.background_color)