Enum VSFilterMode

#[repr(C)]
pub enum VSFilterMode {
    Parallel = 0,
    ParallelRequests = 1,
    Unordered = 2,
    FrameState = 3,
}

Controls how a filter will be multithreaded, if at all.

Variants

Parallel = 0

Completely parallel execution. Multiple threads will call a filter’s “getFrame” function, to fetch several frames in parallel.

ParallelRequests = 1

For filters that are serial in nature but can request in advance one or more frames they need. A filter’s “getFrame” function will be called from multiple threads at a time with activation reason VSActivationReason::Initial, but only one thread will call it with activation reason VSActivationReason::AllFramesReady at a time.

Unordered = 2

Only one thread can call the filter’s “getFrame” function at a time. Useful for filters that modify or examine their internal state to determine which frames to request.

While the “getFrame” function will only run in one thread at a time, the calls can happen in any order. For example, it can be called with reason VSActivationReason::Initial for frame 0, then again with reason VSActivationReason::Initial for frame 1, then with reason VSActivationReason::AllFramesReady for frame 0.

FrameState = 3

For compatibility with other filtering architectures. DO NOT USE IN NEW FILTERS. The filter’s “getFrame” function only ever gets called from one thread at a time. Unlike Unordered, only one frame is processed at a time.

Trait Implementations

impl Clone for VSFilterMode

fn clone(&self) -> VSFilterMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VSFilterMode

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

Formats the value using the given formatter.

impl Hash for VSFilterMode

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 Ord for VSFilterMode

fn cmp(&self, other: &VSFilterMode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for VSFilterMode

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

fn partial_cmp(&self, other: &VSFilterMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for VSFilterMode

impl Eq for VSFilterMode

impl StructuralPartialEq for VSFilterMode