Skip to main content

FrameRateRatio

Struct FrameRateRatio 

Source
pub struct FrameRateRatio {
    pub numerator: u32,
    pub denominator: u32,
}
Expand description

A rational frame rate expressed as numerator / denominator.

This complements the crate::FrameRate enum with arbitrary-precision rational arithmetic so that custom frame rates (e.g. 48000/1001) can be represented without adding new enum variants.

Fields§

§numerator: u32

Numerator of the frame rate fraction.

§denominator: u32

Denominator of the frame rate fraction.

Implementations§

Source§

impl FrameRateRatio

Source

pub fn new(numerator: u32, denominator: u32) -> Option<Self>

Create a new FrameRateRatio.

Returns None if denominator is zero.

Source

pub fn fps_f64(&self) -> f64

Exact floating-point value of the frame rate.

Source

pub fn is_drop_frame_compatible(&self) -> bool

Whether this frame rate is compatible with SMPTE drop-frame timecode.

Drop frame is only defined for the 30000/1001 (≈ 29.97) and 60000/1001 (≈ 59.94) rates.

Source

pub fn matches(&self, other: &FrameRateRatio) -> bool

Whether this ratio is numerically equal to other (cross-multiply check).

Source

pub fn common_frame_rates() -> Vec<FrameRateRatio>

A list of common broadcast frame rates.

Source

pub fn nominal_fps(&self) -> u32

Nominal integer frames per second (rounded).

Trait Implementations§

Source§

impl Clone for FrameRateRatio

Source§

fn clone(&self) -> FrameRateRatio

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FrameRateRatio

Source§

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

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

impl Display for FrameRateRatio

Source§

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

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

impl PartialEq for FrameRateRatio

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for FrameRateRatio

Source§

impl Eq for FrameRateRatio

Source§

impl StructuralPartialEq for FrameRateRatio

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> 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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.