Struct ProjectSettings 

#[non_exhaustive]
pub struct ProjectSettings {
    pub width: u32,
    pub height: u32,
    pub frame_rate: FrameRate,
    pub sample_rate: u32,
    pub background: Rgb,
    pub blend_space: BlendSpace,
    pub color: ColorPipeline,
}

Output-wide settings independent of a renderer or encoder.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

width: u32

Canvas width in output pixels, at most MAX_CANVAS_DIMENSION.

height: u32

Canvas height in output pixels, at most MAX_CANVAS_DIMENSION. The canvas area is at most MAX_CANVAS_PIXELS.

frame_rate: FrameRate

Timeline frame rate.

sample_rate: u32

Internal audio sample rate, within SAMPLE_RATE_RANGE.

background: Rgb

Opaque color under every layer, in preview and export alike.

Empty canvas, and whatever shows through a translucent layer, is this color rather than something a host or encoder decides.

blend_space: BlendSpace

The space in which clips’ blend modes are evaluated, in preview and export alike.

color: ColorPipeline

How sources’ colors come into the working space.

Implementations

impl ProjectSettings

pub fn new( width: u32, height: u32, frame_rate: FrameRate, sample_rate: u32, ) -> Result<Self, ModelError>

Creates validated output settings.

Errors

Returns a model error when dimensions or sample rate exceed supported bounds.

pub fn with_background(self, background: Rgb) -> Result<Self, ModelError>

Replaces the background color.

Errors

Returns ModelError::InvalidBackground for a non-finite or out-of-range component.

Trait Implementations

impl Clone for ProjectSettings

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectSettings

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProjectSettings

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ProjectSettings

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ProjectSettings

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 ProjectSettings