Docsv3.3.0
Back to API Reference
Class

EffectModifier

abstract
Inherits:BaseModifier
Implements:ILayer

Base class for modifiers that append duplicate glyph geometry behind or in front of the face (outline, shadow, extrude, glow, custom effects).

Remarks

Contract: At the geometry-consumer tail of onGlyph, after glyph transformations, the subclass's OnGlyphEffect decides whether the current glyph needs an effect quad and, if so, calls EnqueueDuplicate with an arbitrary payload integer — typically an index into the modifier's own per-emit data table. At onMainPassFinalize, the per-modifier emit queue is flushed via OnFlush. The default implementation reserves 4 vertices for each pending emit (copying source geometry, recording the quad at the modifier's LayerSequence) and calls OnEmitQuad so the subclass can fill colour, UV2, offsets. Multi-layer effects override OnFlush to flush per-layer buffers. Painter order is the single layer axis: every quad — face and duplicates — records its LayerSequence, and the generator sorts the index buffer by it, so stacking follows the order layers appear in Styles. The base class deliberately knows nothing about colour, dilate, softness, offsets, gradients, or any effect-specific parameter. Those live entirely inside the subclass. Common write patterns (solid colour + UV2, per-vertex gradient, offset, expand) are exposed via the static CoverageQuadOps helpers so subclasses share the implementation without sharing the data layout.

Derived Types(3)

Types that inherit from EffectModifier.

C
ExtrudeModifier
Adds a 3D extrude/bevel effect by appending a stack of progressively offset duplicate quads behind the face, shaded across a near→far colour gradient.
C
GlitchModifier
RGB-split glitch bursts: during a burst the glyph doubles into magenta and cyan copies pushed in opposite directions under a crisp original, with horizontal jerks and rare blink-outs. Re-rolls [[Rate]] times per phase unit; deterministic per phase, so scrubbing reproduces the same bursts.
C
PaintLayerModifier
Shared engine for paint layers (fill, stroke, shadow, glow, inner-shadow). Resolves a [[TextPaint]] from the parameter, precomputes gradient/texture mapping per styled range, and stamps coverage quads through [[CoverageQuadOps]]. Thin subclasses only pick a coverage mode and parse their geometry params — all paint/mapping logic lives here once.
public int LayerSequence{ get; set }
public bool RendersBehindFill{ get }
public bool ClaimsFill{ get }
protected abstract void OnGlyphEffect()

Called once per glyph during mesh generation. The subclass decides whether the current glyph (currentCluster) needs an effect quad and invokes EnqueueDuplicate if so. Emoji glyphs must be skipped (uniText.MeshGenerator.font.IsColor).

protected LayerBlend ResolveBlend()

Resolves this effect's range blend override against its inherited mode.

protected LayerBlend ResolveBlend()

Resolves this effect's range blend override against its inherited mode by the parameter's own slot — for effects that read no other parameter through a reader.

protected PaintSpread ResolveSpread()

Resolves this effect's range spread override against its inherited value. Reads the final parameter slot, so call it after every other parameter the effect reads.

protected abstract void OnEmitQuad(int sourceBaseIdx, int destBaseIdx, int payload)

Writes the actual per-vertex data into a reserved effect-quad slot. The base has already copied geometry (positions, UV0, UV1) from the source face quad and queued the triangle indices; destBaseIdx points at the first of the four duplicate vertices. The subclass writes Colors, Uvs2, and (if needed) re-positions Vertices through CoverageQuadOps helpers.

protected override void OnEnable()
protected override void OnDisable()
protected override void OnDestroy()
protected virtual void ResetOwnRequests()

Resets per-cycle emit state. Subclasses with extra buffers (e.g. multi-layer effects) override and chain to clear their own storage.

protected void EnqueueDuplicate(int sourceBaseIdx, int payload)

Queues a duplicate of the given face quad for emission at onMainPassFinalize, recorded at this modifier's LayerSequence — raised by the generator's current sequenceBias, captured here — so it stacks at its layer position inside whichever band the glyph is emitted into.

protected virtual void OnFlush()

Flushes the pending emit queue. Default implementation processes emits in the order they were enqueued — correct for single-layer effects. Multi-layer effects (e.g. extrude) override and iterate their own per-layer buffers in layer-major order, calling ReserveQuad + OnEmitQuad directly.

protected static int ReserveQuad()

Reserves a 4-vertex effect-quad slot: copies positions, UV0 and UV1 from the source quad, records the quad at sequence with blend, and advances vertexCount.

Back to API Reference