TextStudioRenderDirectiveWriter
public readonly struct TextStudioRenderDirectiveWriterAllocation-free writer for target-scoped typed renderer directives.
Methods
Section titled “Methods”
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
| Name | Type |
|---|---|
glyphIndex | System.Int32 |
propertyId | System.String |
value | UnityEngine.Vector4 |
influence | System.Single |
blendMode | TextStudio.EffectBlendMode |
surfaceMask | TextStudio.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
| Name | Type |
|---|---|
glyphIndex | System.Int32 |
propertyId | TextStudio.TextStudioRenderPropertyId |
value | TextStudio.TextStudioRenderPropertyValue |
influence | System.Single |
blendMode | TextStudio.EffectBlendMode |
surfaceMask | TextStudio.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
| Name | Type |
|---|---|
glyphIndex | System.Int32 |
propertyId | System.String |
value | System.UInt32 |
influence | System.Single |
blendMode | TextStudio.EffectBlendMode |
surfaceMask | TextStudio.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
| Name | Type |
|---|---|
firstGlyphIndex | System.Int32 |
glyphCount | System.Int32 |
propertyId | System.String |
value | UnityEngine.Vector4 |
influence | System.Single |
blendMode | TextStudio.EffectBlendMode |
surfaceMask | TextStudio.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
| Name | Type |
|---|---|
firstGlyphIndex | System.Int32 |
glyphCount | System.Int32 |
propertyId | TextStudio.TextStudioRenderPropertyId |
value | TextStudio.TextStudioRenderPropertyValue |
influence | System.Single |
blendMode | TextStudio.EffectBlendMode |
surfaceMask | TextStudio.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
| Name | Type |
|---|---|
firstGlyphIndex | System.Int32 |
glyphCount | System.Int32 |
propertyId | System.String |
value | System.UInt32 |
influence | System.Single |
blendMode | TextStudio.EffectBlendMode |
surfaceMask | TextStudio.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
| Name | Type |
|---|---|
propertyId | System.String |
value | UnityEngine.Vector4 |
influence | System.Single |
blendMode | TextStudio.EffectBlendMode |
surfaceMask | TextStudio.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
| Name | Type |
|---|---|
propertyId | TextStudio.TextStudioRenderPropertyId |
value | TextStudio.TextStudioRenderPropertyValue |
influence | System.Single |
blendMode | TextStudio.EffectBlendMode |
surfaceMask | TextStudio.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
| Name | Type |
|---|---|
propertyId | System.String |
value | System.UInt32 |
influence | System.Single |
blendMode | TextStudio.EffectBlendMode |
surfaceMask | TextStudio.TextStudioSurfaceMask |
Returns
System.Boolean
Properties
Section titled “Properties”
public int Count { get; }Returns
System.Int32
Channels
Section titled “Channels”public TextStudioGlyphAuthorityChannels Channels { get; }Returns
TextStudio.TextStudioGlyphAuthorityChannels