dioxuscut-core 0.1.2

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
28
29
30

//! `use_current_frame` hook — returns the current render frame.
//!
//! Equivalent to Remotion's `useCurrentFrame()`.
//!
//! # Usage
//! ```rust,ignore
//! use dioxuscut_core::hooks::use_current_frame;
//!
//! fn MyComponent() -> Element {
//!     let frame = use_current_frame();
//!     rsx! { div { "Frame: {frame}" } }
//! }
//! ```

use crate::timeline::context::TimelineContext;
use dioxus::prelude::*;

/// Returns the current frame number for this component.
///
/// The frame is relative to the component's position in the timeline
/// (i.e., already offset by any enclosing `<Sequence>`).
///
/// # Panics
///
/// Panics if called outside a `<Composition>` context.
pub fn use_current_frame() -> u32 {
    let timeline = use_context::<Signal<TimelineContext>>();
    let snapshot = timeline.read();
    snapshot.frame
}