Skip to content

TextStudioRenderDirectiveWriter

StructTextStudioTextStudio
public readonly struct TextStudioRenderDirectiveWriter

Allocation-free writer for target-scoped typed renderer directives.

ApplyGlyph(int, string, Vector4, float, EffectBlendMode, TextStudioSurfaceMask)

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

Attempts to blend a renderer property onto one glyph within this writer’s visual authority and marks it dirty on success The registered property determines the vector value type.

Parameters

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

Returns

System.Boolean

ApplyGlyph(int, TextStudioRenderPropertyId, in TextStudioRenderPropertyValue, float, EffectBlendMode, TextStudioSurfaceMask)

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

Attempts to blend a renderer property onto one glyph within this writer’s visual authority and marks it dirty on success.

Parameters

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

Returns

System.Boolean

ApplyGlyphUInt(int, string, uint, float, EffectBlendMode, TextStudioSurfaceMask)

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

Attempts to blend an unsigned renderer property onto one authorized glyph and marks it dirty on success.

Parameters

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

Returns

System.Boolean

ApplyRange(int, int, string, Vector4, float, EffectBlendMode, TextStudioSurfaceMask)

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

Attempts to blend a renderer property across an authorized glyph range and marks affected glyphs dirty on success The registered property determines the vector value type.

Parameters

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

Returns

System.Boolean

ApplyRange(int, int, TextStudioRenderPropertyId, in TextStudioRenderPropertyValue, float, EffectBlendMode, TextStudioSurfaceMask)

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

Attempts to blend a renderer property across an authorized glyph range and marks affected glyphs dirty on success.

Parameters

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

Returns

System.Boolean

ApplyRangeUInt(int, int, string, uint, float, EffectBlendMode, TextStudioSurfaceMask)

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

Attempts to blend an unsigned renderer property across an authorized glyph range and marks affected glyphs dirty on success.

Parameters

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

Returns

System.Boolean

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

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

Attempts to blend a renderer property across all glyphs when the range is covered by this writer’s visual authority The registered property determines the vector value type.

Parameters

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

Returns

System.Boolean

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

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

Attempts to blend a renderer property across all glyphs when the range is covered by this writer’s visual authority.

Parameters

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

Returns

System.Boolean

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

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

Attempts to blend an unsigned renderer property across all glyphs when the range is covered by this writer’s visual authority.

Parameters

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

Returns

System.Boolean

public int Count { get; }

Returns

System.Int32

public TextStudioGlyphAuthorityChannels Channels { get; }

Returns

TextStudio.TextStudioGlyphAuthorityChannels