Skip to main content

Caption

Struct Caption 

Source
pub struct Caption {
    pub words: Vec<CaptionWord>,
    pub active_color: String,
    pub mode: CaptionStyle,
    pub max_width: Option<f32>,
    pub pill_color: Option<String>,
    pub style: CssStyle,
    pub timing: TimingConfig,
    pub timeline: Vec<TimelineStep>,
    pub stagger: Option<f32>,
}
👎Deprecated since 0.7.1:

caption is a frozen composition. Compose a for-each over the words with start_at/end_at per word and an expression picking the active one instead — see crates/rustmotion/skills/rules/composition-recipes.md. Kept for compatibility; scheduled for removal in a future major version via rustmotion migrate (#335).

Fields§

§words: Vec<CaptionWord>
👎Deprecated since 0.7.1:

caption is a frozen composition. Compose a for-each over the words with start_at/end_at per word and an expression picking the active one instead — see crates/rustmotion/skills/rules/composition-recipes.md. Kept for compatibility; scheduled for removal in a future major version via rustmotion migrate (#335).

§active_color: String
👎Deprecated since 0.7.1:

caption is a frozen composition. Compose a for-each over the words with start_at/end_at per word and an expression picking the active one instead — see crates/rustmotion/skills/rules/composition-recipes.md. Kept for compatibility; scheduled for removal in a future major version via rustmotion migrate (#335).

§mode: CaptionStyle
👎Deprecated since 0.7.1:

caption is a frozen composition. Compose a for-each over the words with start_at/end_at per word and an expression picking the active one instead — see crates/rustmotion/skills/rules/composition-recipes.md. Kept for compatibility; scheduled for removal in a future major version via rustmotion migrate (#335).

§max_width: Option<f32>
👎Deprecated since 0.7.1:

caption is a frozen composition. Compose a for-each over the words with start_at/end_at per word and an expression picking the active one instead — see crates/rustmotion/skills/rules/composition-recipes.md. Kept for compatibility; scheduled for removal in a future major version via rustmotion migrate (#335).

§pill_color: Option<String>
👎Deprecated since 0.7.1:

caption is a frozen composition. Compose a for-each over the words with start_at/end_at per word and an expression picking the active one instead — see crates/rustmotion/skills/rules/composition-recipes.md. Kept for compatibility; scheduled for removal in a future major version via rustmotion migrate (#335).

Pill background color behind the active word (word_pop / karaoke_pop modes). Defaults to black at 70% opacity.

§style: CssStyle
👎Deprecated since 0.7.1:

caption is a frozen composition. Compose a for-each over the words with start_at/end_at per word and an expression picking the active one instead — see crates/rustmotion/skills/rules/composition-recipes.md. Kept for compatibility; scheduled for removal in a future major version via rustmotion migrate (#335).

§timing: TimingConfig
👎Deprecated since 0.7.1:

caption is a frozen composition. Compose a for-each over the words with start_at/end_at per word and an expression picking the active one instead — see crates/rustmotion/skills/rules/composition-recipes.md. Kept for compatibility; scheduled for removal in a future major version via rustmotion migrate (#335).

§timeline: Vec<TimelineStep>
👎Deprecated since 0.7.1:

caption is a frozen composition. Compose a for-each over the words with start_at/end_at per word and an expression picking the active one instead — see crates/rustmotion/skills/rules/composition-recipes.md. Kept for compatibility; scheduled for removal in a future major version via rustmotion migrate (#335).

§stagger: Option<f32>
👎Deprecated since 0.7.1:

caption is a frozen composition. Compose a for-each over the words with start_at/end_at per word and an expression picking the active one instead — see crates/rustmotion/skills/rules/composition-recipes.md. Kept for compatibility; scheduled for removal in a future major version via rustmotion migrate (#335).

Trait Implementations§

Source§

impl Animatable for Caption

Source§

impl Debug for Caption

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Caption

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for Caption

Source§

fn schema_name() -> String

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword. Read more
Source§

impl Painter for Caption

Source§

fn paint_content( &self, canvas: &Canvas, layout: &BoxLayout, _props: &AnimatedProperties, ctx: &PaintCtx, )

Source§

fn intrinsic_size( &self, _available: AvailableSize, _ctx: &MeasureCtx, ) -> Option<(f32, f32)>

Source§

impl Serialize for Caption

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Styled for Caption

Source§

impl StyledMut for Caption

Source§

fn style_config_mut(&mut self) -> &mut CssStyle

Source§

impl Timed for Caption

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.