Skip to main content

Comp

Struct Comp 

Source
pub struct Comp {
    pub canvas: Canvas,
    pub layers: Vec<CompLayer>,
    pub project: Arc<CompProject>,
    /* private fields */
}
Expand description

A composition: a canvas and layers, bottom first.

Fields§

§canvas: Canvas§layers: Vec<CompLayer>§project: Arc<CompProject>

Shared with nested comps.

Implementations§

Source§

impl Comp

Source

pub fn frames(&self) -> i64

Frames in the comp.

Source

pub fn span(&self, layer: &CompLayer) -> Range<i64> ⓘ

Comp frames where layer shows.

Source

pub fn pieces(&self) -> Vec<Range<i64>>

Pieces of the comp, cut at layer in/out points, none shorter than a second (unless the comp is).

Source

pub fn lower( &self, range: Range<i64>, out: Size, media: &dyn Media, ) -> Result<Piece>

Lowers comp frames range for a render of out px (lengths scale by out/canvas).

Source§

impl Comp

Source

pub fn from_file(path: &Path) -> Result<Self>

Reads NAME.comp.json or NAME.comp.yaml; relative media paths resolve against its directory.

Source

pub fn from_value(v: &Value, dir: &Path) -> Result<Self>

Reads a comp document; dir resolves relative media paths.

Trait Implementations§

Source§

impl Clone for Comp

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Comp

Source§

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

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

impl PartialEq for Comp

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Comp

Auto Trait Implementations§

§

impl Forget for Comp

§

impl Freeze for Comp

§

impl RefUnwindSafe for Comp

§

impl Send for Comp

§

impl Sync for Comp

§

impl Unpin for Comp

§

impl UnsafeUnpin for Comp

§

impl UnwindSafe for Comp

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.