TextStudioRenderPropertyWriter
public readonly struct TextStudioRenderPropertyWriterScoped allocation-free writer passed to effects.
Methods
Section titled “Methods”
ForGlyph(int)
Section titled “ForGlyph(int)”public TextStudioRenderPropertyWriter ForGlyph(int glyphIndex)Returns a writer scoped to the requested glyph within this writer’s existing glyph range.
Parameters
| Name | Type |
|---|---|
glyphIndex |
System.Int32 |
Returns
TextStudio.TextStudioRenderPropertyWriter
ForRange(int, int)
Section titled “ForRange(int, int)”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
| Name | Type |
|---|---|
firstGlyphIndex |
System.Int32 |
glyphCount |
System.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
| Name | Type |
|---|---|
propertyId |
System.String |
value |
UnityEngine.Vector4 |
influence |
System.Single |
blendMode |
TextStudio.EffectBlendMode |
surfaceMask |
TextStudio.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
| Name | Type |
|---|---|
propertyId |
TextStudio.TextStudioRenderPropertyId |
value |
TextStudio.TextStudioRenderPropertyValue |
influence |
System.Single |
blendMode |
TextStudio.EffectBlendMode |
surfaceMask |
TextStudio.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
| Name | Type |
|---|---|
propertyId |
System.String |
value |
System.UInt32 |
influence |
System.Single |
blendMode |
TextStudio.EffectBlendMode |
surfaceMask |
TextStudio.TextStudioSurfaceMask |
Returns
System.Boolean
Properties
Section titled “Properties”
IsValid
Section titled “IsValid”public bool IsValid { get; }Returns
System.Boolean
FirstGlyphIndex
Section titled “FirstGlyphIndex”public int FirstGlyphIndex { get; }Returns
System.Int32
GlyphCount
Section titled “GlyphCount”public int GlyphCount { get; }Returns
System.Int32