muvid.environments

Environment cards + canonical establishing image generation.

Functions

add_environment(project, name, *[, ...])	Create or update an environment card.
get_environment_anchor_image(project, name)	Return the canonical environment image, or None if not yet rendered.
render_environment(project, name, *[, quality])	Generate the canonical establishing image for the environment.

muvid.environments.add_environment(project, name, *, description='', time_of_day='', lighting='')

Create or update an environment card.

Return type:

dict[str, Any]

muvid.environments.get_environment_anchor_image(project, name)

Return the canonical environment image, or None if not yet rendered.

Return type:

Path | None

muvid.environments.render_environment(project, name, *, quality='high')

Generate the canonical establishing image for the environment.

Saves to environments/<name>/establishing.png and stores the relative path on the card as reference_image_path.

Return type:

Path