Struct VSVideoFormat

#[repr(C)]
pub struct VSVideoFormat {
    pub color_family: VSColorFamily,
    pub sample_type: VSSampleType,
    pub bits_per_sample: c_int,
    pub bytes_per_sample: c_int,
    pub sub_sampling_w: c_int,
    pub sub_sampling_h: c_int,
    pub num_planes: c_int,
}

Describes the format of a clip.

Use queryVideoFormat() to fill it in with proper error checking. Manually filling out the struct is allowed but discouraged since illegal combinations of values will cause undefined behavior.

Fields

color_family: VSColorFamily

See VSColorFamily.

sample_type: VSSampleType

See VSSampleType.

bits_per_sample: c_int

Number of significant bits.

bytes_per_sample: c_int

Number of bytes needed for a sample. This is always a power of 2 and the smallest possible that can fit the number of bits used per sample.

sub_sampling_w: c_int

log2 subsampling factor, applied to second and third plane

sub_sampling_h: c_int

log2 subsampling factor, applied to second and third plane.

Convenient numbers that can be used like so:

uv_width = y_width >> subSamplingW;

num_planes: c_int

Number of planes, implicit from colorFamily

Trait Implementations

impl Clone for VSVideoFormat

fn clone(&self) -> VSVideoFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VSVideoFormat

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

Formats the value using the given formatter.

impl Hash for VSVideoFormat

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for VSVideoFormat

fn eq(&self, other: &VSVideoFormat) -> 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 Eq for VSVideoFormat

impl StructuralPartialEq for VSVideoFormat