filmstrip-effects/dev.jordond.filmstrip.effects.geometry/Crop

Crop

class Crop(val aspect: AspectRatio, val fit: Fit = Fit.Crop, val anchor: Anchor = Anchor.Center) : EffectSpec(source)

Reframe to an aspect ratio, keeping the region around anchor.

Constructors

Crop

constructor(aspect: AspectRatio, fit: Fit = Fit.Crop, anchor: Anchor = Anchor.Center)

Properties

anchor

val anchor: Anchor

Where the retained region sits when fit is Fit.Crop. Centred by default.

aspect

val aspect: AspectRatio

The target aspect ratio.

beneathOverlays

open val beneathOverlays: Boolean

fit

val fit: Fit

How the frame is fitted to aspect. Fit.Crop cuts the frame down to it. Fit.Contain and Fit.Stretch make a canvas of aspect and letterbox or stretch the frame into it, and every effect after this one runs on that canvas, bars included.

open override val id: String

isInert

open val isInert: Boolean

requiresSdr

open val requiresSdr: Boolean

scope

open val scope: EffectScope

stage

open override val stage: EffectStage

Functions

retainedRect

fun Crop.retainedRect(inputSize: Size): NormalizedRect

Computes the region this crop keeps, as a fraction of the frame entering it.