motionloom 0.1.0

MotionLoom DSL parser and renderer for video effects, scene graphs, motion graphics, and world graphs.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

//! Recommended MotionLoom public API surface.
//!
//! This module intentionally re-exports the main integration APIs without
//! exposing MotionLoom's internal module tree.
//!
//! Prefer this module for new host applications, examples, and third-party
//! integrations.
//!
//! # Parse and render
//!
//! ```no_run
//! use motionloom::api::{SceneRenderProfile, parse_graph_script, render_scene_graph_frame};
//!
//! # async fn run(script: &str) -> Result<(), Box<dyn std::error::Error>> {
//! let graph = parse_graph_script(script)?;
//! let frame = render_scene_graph_frame(&graph, 0, SceneRenderProfile::Gpu).await?;
//! frame.save("frame.png")?;
//! # Ok(())
//! # }
//! ```
//!
//! # Reusable renderer
//!
//! ```no_run
//! use motionloom::api::{SceneRenderProfile, SceneRenderer, parse_graph_script};
//!
//! # async fn run(script: &str) -> Result<(), Box<dyn std::error::Error>> {
//! let graph = parse_graph_script(script)?;
//! let mut renderer = SceneRenderer::new(SceneRenderProfile::Gpu).await?;
//! let frame_0 = renderer.render_frame(&graph, 0).await?;
//! let frame_1 = renderer.render_frame(&graph, 1).await?;
//! frame_0.save("frame_0000.png")?;
//! frame_1.save("frame_0001.png")?;
//! # Ok(())
//! # }
//! ```
//!
//! # Root document export
//!
//! `parse_motionloom_document` and the `render_motionloom_document_*`
//! functions auto-route scene, process, and world documents where supported.
//!
//! ```no_run
//! use std::path::Path;
//! use motionloom::api::render_motionloom_document_to_png_sequence_with_progress;
//!
//! # async fn run(script: &str) -> Result<(), Box<dyn std::error::Error>> {
//! render_motionloom_document_to_png_sequence_with_progress(
//!     script,
//!     ".",
//!     Path::new("frames"),
//!     30,
//!     |progress| eprintln!("{}/{}", progress.rendered_frames(), progress.total_frames()),
//! ).await?;
//! # Ok(())
//! # }
//! ```
//!
//! # Process catalog
//!
//! ```no_run
//! use motionloom::api::{process_effect_for_id, process_effects};
//!
//! for effect in process_effects() {
//!     println!("{}: {}", effect.id, effect.display_name);
//! }
//!
//! let bloom = process_effect_for_id("glow_bloom");
//! assert!(bloom.is_some());
//! ```

pub use crate::{
    AssetResolver, AssetSource, GpuCompatibilityIssue, GpuCompatibilityReport,
    GpuCompatibilitySeverity, GpuCompatibilityTarget, GraphParseError, GraphScript,
    MemoryAssetResolver, MotionLoomDocument, MotionLoomError, MotionLoomRenderProgress,
    MotionLoomSceneRenderError, PathAssetResolver, ProcessCategory, ProcessEffectDefinition,
    ProcessGraph, RootGraphError, RuntimeCompileError, RuntimeFrameOutput,
    RuntimeProcessEffectInstance, RuntimeProcessParamValue, RuntimeProgram, SceneGpuTexture,
    ScenePlatformPreviewSurface, ScenePreviewBackend, ScenePreviewPath, ScenePreviewPixelFormat,
    ScenePreviewSurface, ScenePreviewSurfaceOptions, SceneRenderError, SceneRenderProfile,
    SceneRenderProgress, SceneRenderer, clear_scene_asset_roots, compile_runtime_program,
    inspect_gpu_compatibility, inspect_root_graph, is_graph_script, is_known_process_kernel,
    is_process_graph_script, kernel_source_by_name, next_scene_output_path,
    next_scene_output_path_for_profile, parse_graph_script, parse_motionloom_document,
    parse_process_graph_script, process_effect_for_id, process_effects,
    process_effects_for_category, render_motionloom_document_to_png_sequence_with_progress,
    render_motionloom_document_to_png_sequence_with_progress_and_cancel,
    render_motionloom_document_to_video_with_progress,
    render_motionloom_document_to_video_with_progress_and_cancel, render_scene_graph_frame,
    render_scene_graph_frame_with_resolver, render_scene_graph_to_png_sequence_with_progress,
    render_scene_graph_to_png_sequence_with_progress_and_cancel, render_scene_graph_to_video,
    render_scene_graph_to_video_with_progress,
    render_scene_graph_to_video_with_progress_and_cancel, set_scene_asset_roots,
};

#[cfg(all(unix, not(target_os = "macos"), not(target_arch = "wasm32")))]
pub use crate::DmabufPlane;

#[cfg(target_os = "windows")]
pub use crate::{WindowsD3DSharedHandle, WindowsD3DSharedSurface};