Enum MotionCompensationMode 

#[non_exhaustive]
pub enum MotionCompensationMode {
    None,
    Mvtools {
        blksize: u32,
        overlap: u32,
        search_radius: u32,
        pyramid_levels: u32,
        estimation: MotionEstimation,
    },
}

How motion compensation is configured for a denoise pass.

None disables motion compensation entirely (zero-cost; no extra buffers are allocated). Mvtools enables an MVTools-inspired per-block estimator and warps neighbours toward the centre at denoise time.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

None

Mvtools

Fields

blksize: u32

Side length of each motion-estimation block in pixels at the finest pyramid level.

overlap: u32

Overlap between neighbouring blocks in pixels. Must be strictly less than blksize so the step (blksize - overlap) stays positive. Values > 0 reserve room for raised-cosine blending in the compensate step (v1 uses a winner-block rule).

search_radius: u32

Pixel search radius at the finest pyramid level. The coarse pass uses the same radius on the /2 image so its effective reach is doubled.

pyramid_levels: u32

Number of pyramid levels. 1 disables the hierarchical coarse pass; 2 adds a /2 coarse pass that seeds the fine pass. Bounded by [MAX_PYRAMID_LEVELS].

estimation: MotionEstimation

How temporal MVs are estimated. Auto (the default) picks the strategy from the temporal radius. Callers normally leave this at the default. Explicit Direct/Chained are mainly useful for pinning a variant in tests and benches.

Implementations

impl MotionCompensationMode

pub fn mvtools_default() -> Self

Convenience constructor for Mvtools with library defaults.

Pins estimation to Direct rather than the field’s own Auto default, so it never switches to Chained at larger temporal radii the way an Auto configuration does.

pub fn validate(&self) -> Result<(), Error>

Reject parameter combinations that the kernels can’t honour.

Trait Implementations

impl Clone for MotionCompensationMode

fn clone(&self) -> MotionCompensationMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MotionCompensationMode

impl Debug for MotionCompensationMode

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

Formats the value using the given formatter.

impl Default for MotionCompensationMode

fn default() -> MotionCompensationMode

Returns the “default value” for a type.

impl PartialEq for MotionCompensationMode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MotionCompensationMode