Enum TextEffectMaskPattern

The shape a CellMask traces across a region.

Namespace: Scylla.TextMode

Assembly: ScyllaTextMode.dll

Syntax

public enum TextEffectMaskPattern

Remarks

A mask gives every cell a value between 0 and 1 saying how early it is reached. What that ordering is used for depends on the effect: a reveal staggers its cells by it, and a transition swaps each cell to the new content when progress passes it. The same handful of patterns therefore produce both a sweeping fade and a directional wipe.

Fields

Name	Description
BarnDoor	Two halves parting from the center line, or closing onto it.
Blinds	The region divided into parallel bands, each filling from its own edge at the same time, like a set of slats opening together.
Box	Concentric rectangles growing out from the center, or closing in on it.
Checkerboard	Alternating blocks in a checker layout.
Clock	A hand sweeping around the center, like a clock wipe.
Custom	Ordered by a function supplied by the caller.
Diagonal	A gradient running corner to corner, so the sweep arrives at an angle.
Dissolve	Every cell in a random order, seeded so the same seed always dissolves the same way.
Linear	A straight gradient across the region along one axis, giving a clean directional wipe.
Noise	Ordered by a noise field, giving the blotchy, organic spread of a burn rather than the even scatter of a random dissolve.
Radial	Concentric circles growing out from the center, or closing in on it. Corrected for cell shape so the circle looks round rather than stretched.
Sequential	Reading order: left to right along each row, then down to the next. The natural choice for text, because it matches the order the words were written in.
Uniform	Every cell is reached at once, which is what an effect wants when it should not stagger at all.