Skip to content

TextStudioRenderPropertyWriter

StructTextStudioTextStudio
public readonly struct TextStudioRenderPropertyWriter

Scoped allocation-free writer passed to effects.

public TextStudioRenderPropertyWriter ForGlyph(int glyphIndex)

Returns a writer scoped to the requested glyph within this writer’s existing glyph range.

Parameters

NameType
glyphIndexSystem.Int32

Returns

TextStudio.TextStudioRenderPropertyWriter

public TextStudioRenderPropertyWriter ForRange(int firstGlyphIndex, int glyphCount)

Returns a writer scoped to the intersection of the requested glyph range and this writer’s existing range.

Parameters

NameType
firstGlyphIndexSystem.Int32
glyphCountSystem.Int32

Returns

TextStudio.TextStudioRenderPropertyWriter

Apply(string, Vector4, float, EffectBlendMode, TextStudioSurfaceMask)

Section titled “Apply(string, Vector4, float, EffectBlendMode, TextStudioSurfaceMask)”
public bool Apply(string propertyId, Vector4 value, float influence = 1, EffectBlendMode blendMode = EffectBlendMode.Override, TextStudioSurfaceMask surfaceMask = TextStudioSurfaceMask.All)

Attempts to blend a registered non-unsigned property value into the scoped glyphs using influence and the supported surface mask.

Parameters

NameType
propertyIdSystem.String
valueUnityEngine.Vector4
influenceSystem.Single
blendModeTextStudio.EffectBlendMode
surfaceMaskTextStudio.TextStudioSurfaceMask

Returns

System.Boolean

Apply(TextStudioRenderPropertyId, in TextStudioRenderPropertyValue, float, EffectBlendMode, TextStudioSurfaceMask)

Section titled “Apply(TextStudioRenderPropertyId, in TextStudioRenderPropertyValue, float, EffectBlendMode, TextStudioSurfaceMask)”
public bool Apply(TextStudioRenderPropertyId propertyId, in TextStudioRenderPropertyValue value, float influence = 1, EffectBlendMode blendMode = EffectBlendMode.Override, TextStudioSurfaceMask surfaceMask = TextStudioSurfaceMask.All)

Attempts to blend a matching typed property value into the scoped glyphs using influence and the supported surface mask.

Parameters

NameType
propertyIdTextStudio.TextStudioRenderPropertyId
valueTextStudio.TextStudioRenderPropertyValue
influenceSystem.Single
blendModeTextStudio.EffectBlendMode
surfaceMaskTextStudio.TextStudioSurfaceMask

Returns

System.Boolean

ApplyUInt(string, uint, float, EffectBlendMode, TextStudioSurfaceMask)

Section titled “ApplyUInt(string, uint, float, EffectBlendMode, TextStudioSurfaceMask)”
public bool ApplyUInt(string propertyId, uint value, float influence = 1, EffectBlendMode blendMode = EffectBlendMode.Override, TextStudioSurfaceMask surfaceMask = TextStudioSurfaceMask.All)

Attempts to blend an unsigned integer property value into the scoped glyphs using influence and the supported surface mask.

Parameters

NameType
propertyIdSystem.String
valueSystem.UInt32
influenceSystem.Single
blendModeTextStudio.EffectBlendMode
surfaceMaskTextStudio.TextStudioSurfaceMask

Returns

System.Boolean

public bool IsValid { get; }

Returns

System.Boolean

public int FirstGlyphIndex { get; }

Returns

System.Int32

public int GlyphCount { get; }

Returns

System.Int32