Skip to main content

ranim/cmd/
mod.rs

1/// Things for render to video
2#[cfg(all(not(target_family = "wasm"), feature = "render"))]
3pub mod render;
4#[cfg(all(not(target_family = "wasm"), feature = "render"))]
5pub use render::{
6    RenderJob, render_scene, render_scene_job, render_scene_once, render_scene_output,
7    render_scene_output_with_progress,
8};
9
10/// Render a scene by name.
11///
12/// ```rust,ignore
13/// render_scene!(fading);
14/// render_scene!(ranim_020::code_structure);
15/// ```
16#[cfg(all(not(target_family = "wasm"), feature = "render"))]
17#[macro_export]
18macro_rules! render_scene {
19    ($($scene:tt)::+) => {
20        $crate::cmd::render_scene(&$($scene)::+::scene(), 2)
21    };
22}
23
24/// The preview application
25#[cfg(feature = "preview")]
26#[allow(missing_docs)]
27pub mod preview;
28#[cfg(feature = "preview")]
29pub use preview::{preview_constructor_with_name, preview_scene, preview_scene_with_name};
30
31/// Preview a scene by name.
32///
33/// ```rust,ignore
34/// ranim::preview_scene!(fading);
35/// ranim::preview_scene!(ranim_020::code_structure);
36/// ```
37#[macro_export]
38macro_rules! preview_scene {
39    ($($scene:tt)::+) => {
40        $crate::cmd::preview_scene(&$($scene)::+::scene())
41    };
42}