Struct Effect

pub struct Effect {
    pub kind: EffectKind,
    pub enabled: bool,
    pub params: Vec<Animated>,
    pub mask: Option<Mask>,
    pub shader: String,
    pub start: f64,
    pub len: f64,
}

An effect instance on a clip; params[i] follows kind.params()[i] (each keyframeable).

Fields

kind: EffectKind

enabled: bool

params: Vec<Animated>

mask: Option<Mask>

Limits the effect to (or outside) a shape.

shader: String

EffectKind::Shader only: the GLSL fragment shader source.

start: f64

Clip-local second the effect switches on (CapCut-style window inside the clip).

len: f64

How long it stays on; <= 0 means “to the end of the clip”, which is what every effect written before this field existed deserialises to.

Implementations

impl Effect

pub fn new(kind: EffectKind) -> Self

pub fn on_at(&self, t: f64) -> bool

Is the effect on at clip-local time t? Enabled + inside its window (the default window is the whole clip, so this is just enabled for every project that never touched the timing).

pub fn at(&self, i: usize, t: f64) -> f64

Parameter i at clip-local time t (spec default when missing, e.g. older files).

pub fn specs(&self) -> &'static [ParamSpec]

Trait Implementations

impl Clone for Effect

fn clone(&self) -> Effect

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Effect

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Effect

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Effect

fn eq(&self, other: &Effect) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Effect

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Effect