dioxuscut-core 0.1.3

Core Dioxus components and hooks for Dioxuscut — Composition, Sequence, AbsoluteFill, etc.
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

//! `use_video_config` hook — returns the `VideoConfig` for the current composition.
//!
//! Equivalent to Remotion's `useVideoConfig()`.
//!
//! # Usage
//! ```rust,ignore
//! use dioxuscut_core::hooks::use_video_config;
//!
//! fn MyComponent() -> Element {
//!     let config = use_video_config();
//!     rsx! { div { "FPS: {config.fps}" } }
//! }
//! ```

use crate::timeline::context::VideoConfigContext;
use crate::types::VideoConfig;
use dioxus::prelude::*;

/// Returns the [`VideoConfig`] of the enclosing `<Composition>`.
///
/// # Panics
/// Panics in debug mode if called outside a `<Composition>`.
pub fn use_video_config() -> VideoConfig {
    let config = use_context::<Signal<VideoConfigContext>>();
    let snapshot = config.read();
    snapshot.0.clone()
}