Skip to content

TextStudioEffectUnitContext

StructTextStudioTextStudio
public readonly struct TextStudioEffectUnitContext

Renderer-neutral per-unit source geometry, color, semantic indices, and world-space snapshots for effect evaluation.

public readonly TextStudioEffectAreaMode area

Returns

TextStudio.TextStudioEffectAreaMode

public readonly int groupSize

Returns

System.Int32

public readonly int unitIndex

Returns

System.Int32

public readonly int unitCount

Returns

System.Int32

public readonly int unitStartGlyph

Returns

System.Int32

public readonly int unitGlyphCount

Returns

System.Int32

public readonly int indexInUnit

Returns

System.Int32

public readonly float normalizedIndexInUnit

Returns

System.Single

public readonly float normalizedUnitIndex

Returns

System.Single

public readonly float normalizedIndexInBinding

Returns

System.Single

public readonly int randomSeedIndex

Returns

System.Int32

public readonly float playbackOffset

Returns

System.Single

TextStudioEffectUnitContext(TextStudioEffectAreaMode, int, int, int, int, int, int, float, float)

Section titled “TextStudioEffectUnitContext(TextStudioEffectAreaMode, int, int, int, int, int, int, float, float)”
public TextStudioEffectUnitContext(TextStudioEffectAreaMode area, int groupSize, int unitIndex, int unitCount, int unitStartGlyph, int unitGlyphCount, int indexInUnit, float normalizedIndexInBinding, float playbackOffset)

Creates semantic indices and normalized positions for one evaluated unit.

Parameters

Name Type
area TextStudio.TextStudioEffectAreaMode
groupSize System.Int32
unitIndex System.Int32
unitCount System.Int32
unitStartGlyph System.Int32
unitGlyphCount System.Int32
indexInUnit System.Int32
normalizedIndexInBinding System.Single
playbackOffset System.Single

public static TextStudioEffectUnitContext SingleGlyph(int glyphIndex, int totalGlyphs)

Creates per-glyph context when word, line, and paragraph segmentation are unavailable.

Parameters

Name Type
glyphIndex System.Int32
totalGlyphs System.Int32

Returns

TextStudio.TextStudioEffectUnitContext