TextStudio2DPaint
public struct TextStudio2DPaintTyped paint shared by fills, strokes, glows, shadows, and decorations.
Methods
Section titled “Methods”
Solid(Color)
Section titled “Solid(Color)”public static TextStudio2DPaint Solid(Color color)Creates solid-color paint mapped to each glyph.
Parameters
| Name | Type |
|---|---|
color | UnityEngine.Color |
Returns
TextStudio.TextStudio2DPaint
Gradient(TextStudio2DPaintKind, TextStudio2DMappingSpace, TextStudio2DGradientStop[], float, Vector2?, Vector2?, Vector2)
Section titled “Gradient(TextStudio2DPaintKind, TextStudio2DMappingSpace, TextStudio2DGradientStop[], float, Vector2?, Vector2?, Vector2)”public static TextStudio2DPaint Gradient(TextStudio2DPaintKind kind, TextStudio2DMappingSpace mapping, TextStudio2DGradientStop[] stops, float angle = 0, Vector2? center = null, Vector2? scale = null, Vector2 offset = null)Creates linear, radial, or conic gradient paint with copied stops, the specified mapping and transform, and clamped spread.
Parameters
| Name | Type |
|---|---|
kind | TextStudio.TextStudio2DPaintKind |
mapping | TextStudio.TextStudio2DMappingSpace |
stops | TextStudio.TextStudio2DGradientStop[] |
angle | System.Single |
center | System.Nullable{UnityEngine.Vector2} |
scale | System.Nullable{UnityEngine.Vector2} |
offset | UnityEngine.Vector2 |
Returns
TextStudio.TextStudio2DPaint
Gradient(TextStudio2DPaintKind, TextStudio2DMappingSpace, TextStudio2DGradientStop[], float, Vector2?, Vector2?, Vector2, TextStudio2DGradientSpread)
Section titled “Gradient(TextStudio2DPaintKind, TextStudio2DMappingSpace, TextStudio2DGradientStop[], float, Vector2?, Vector2?, Vector2, TextStudio2DGradientSpread)”public static TextStudio2DPaint Gradient(TextStudio2DPaintKind kind, TextStudio2DMappingSpace mapping, TextStudio2DGradientStop[] stops, float angle, Vector2? center, Vector2? scale, Vector2 offset, TextStudio2DGradientSpread spread)Creates linear, radial, or conic gradient paint with copied stops and the specified mapping, transform, and spread mode.
Parameters
| Name | Type |
|---|---|
kind | TextStudio.TextStudio2DPaintKind |
mapping | TextStudio.TextStudio2DMappingSpace |
stops | TextStudio.TextStudio2DGradientStop[] |
angle | System.Single |
center | System.Nullable{UnityEngine.Vector2} |
scale | System.Nullable{UnityEngine.Vector2} |
offset | UnityEngine.Vector2 |
spread | TextStudio.TextStudio2DGradientSpread |
Returns
TextStudio.TextStudio2DPaint
FourCorner(TextStudio2DMappingSpace, TextStudio2DFourCornerGradient, Vector2?, Vector2?, Vector2)
Section titled “FourCorner(TextStudio2DMappingSpace, TextStudio2DFourCornerGradient, Vector2?, Vector2?, Vector2)”public static TextStudio2DPaint FourCorner(TextStudio2DMappingSpace mapping, TextStudio2DFourCornerGradient gradient, Vector2? center = null, Vector2? scale = null, Vector2 offset = null)Creates paint that interpolates four corner colors within the specified mapping space and transform.
Parameters
| Name | Type |
|---|---|
mapping | TextStudio.TextStudio2DMappingSpace |
gradient | TextStudio.TextStudio2DFourCornerGradient |
center | System.Nullable{UnityEngine.Vector2} |
scale | System.Nullable{UnityEngine.Vector2} |
offset | UnityEngine.Vector2 |
Returns
TextStudio.TextStudio2DPaint
DistanceGradient(TextStudio2DDistanceDomain, TextStudio2DGradientStop[], Vector2, TextStudio2DGradientSpread)
Section titled “DistanceGradient(TextStudio2DDistanceDomain, TextStudio2DGradientStop[], Vector2, TextStudio2DGradientSpread)”public static TextStudio2DPaint DistanceGradient(TextStudio2DDistanceDomain domain, TextStudio2DGradientStop[] stops, Vector2 distanceRange, TextStudio2DGradientSpread spread = TextStudio2DGradientSpread.Clamp)Creates a gradient driven by a layer-specific signed-distance measurement.
Parameters
| Name | Type |
|---|---|
domain | TextStudio.TextStudio2DDistanceDomain |
stops | TextStudio.TextStudio2DGradientStop[] |
distanceRange | UnityEngine.Vector2 |
spread | TextStudio.TextStudio2DGradientSpread |
Returns
TextStudio.TextStudio2DPaint
TexturePaint(Texture2D, string, TextStudio2DMappingSpace, Vector2?, Vector2, Color?)
Section titled “TexturePaint(Texture2D, string, TextStudio2DMappingSpace, Vector2?, Vector2, Color?)”public static TextStudio2DPaint TexturePaint(Texture2D texture, string stableResourceId, TextStudio2DMappingSpace mapping = TextStudio2DMappingSpace.Glyph, Vector2? scale = null, Vector2 offset = null, Color? tint = null)Creates texture paint with a stable resource identifier, mapping space, scale, offset, and optional tint.
Parameters
| Name | Type |
|---|---|
texture | UnityEngine.Texture2D |
stableResourceId | System.String |
mapping | TextStudio.TextStudio2DMappingSpace |
scale | System.Nullable{UnityEngine.Vector2} |
offset | UnityEngine.Vector2 |
tint | System.Nullable{UnityEngine.Color} |
Returns
TextStudio.TextStudio2DPaint
PatternPaint(Texture2D, string, TextStudio2DMappingSpace, Vector2?, Vector2, Color?)
Section titled “PatternPaint(Texture2D, string, TextStudio2DMappingSpace, Vector2?, Vector2, Color?)”public static TextStudio2DPaint PatternPaint(Texture2D texture, string stableResourceId, TextStudio2DMappingSpace mapping = TextStudio2DMappingSpace.Glyph, Vector2? scale = null, Vector2 offset = null, Color? tint = null)Creates pattern paint with a stable texture resource identifier, mapping space, scale, offset, and optional tint.
Parameters
| Name | Type |
|---|---|
texture | UnityEngine.Texture2D |
stableResourceId | System.String |
mapping | TextStudio.TextStudio2DMappingSpace |
scale | System.Nullable{UnityEngine.Vector2} |
offset | UnityEngine.Vector2 |
tint | System.Nullable{UnityEngine.Color} |
Returns
TextStudio.TextStudio2DPaint
Noise(Color, float, float, int, TextStudio2DMappingSpace)
Section titled “Noise(Color, float, float, int, TextStudio2DMappingSpace)”public static TextStudio2DPaint Noise(Color color, float scale, float detail, int seed, TextStudio2DMappingSpace mapping = TextStudio2DMappingSpace.Text)Creates deterministic procedural noise paint with the specified color, frequency, detail, seed, and mapping space.
Parameters
| Name | Type |
|---|---|
color | UnityEngine.Color |
scale | System.Single |
detail | System.Single |
seed | System.Int32 |
mapping | TextStudio.TextStudio2DMappingSpace |
Returns
TextStudio.TextStudio2DPaint
GetGradientStop(int)
Section titled “GetGradientStop(int)”public TextStudio2DGradientStop GetGradientStop(int index)Returns the gradient stop at the specified index, throwing if the index is outside the stop array.
Parameters
| Name | Type |
|---|---|
index | System.Int32 |
Returns
TextStudio.TextStudio2DGradientStop
WithSpread(TextStudio2DGradientSpread)
Section titled “WithSpread(TextStudio2DGradientSpread)”public TextStudio2DPaint WithSpread(TextStudio2DGradientSpread spread)Returns a paint copy with the specified gradient spread mode marked as a local override.
Parameters
| Name | Type |
|---|---|
spread | TextStudio.TextStudio2DGradientSpread |
Returns
TextStudio.TextStudio2DPaint
WithGradientDither(bool)
Section titled “WithGradientDither(bool)”public TextStudio2DPaint WithGradientDither(bool enabled = true)Returns a paint copy with stable screen-pixel gradient dithering marked as a local override. Alpha is unchanged. The noise spans one 8-bit display step, remains present on high-precision targets, and leaves colors outside SDR unchanged.
Parameters
| Name | Type |
|---|---|
enabled | System.Boolean |
Returns
TextStudio.TextStudio2DPaint
WithTextureFit(TextStudio2DTextureFit)
Section titled “WithTextureFit(TextStudio2DTextureFit)”public TextStudio2DPaint WithTextureFit(TextStudio2DTextureFit fit)Returns a paint copy with the specified texture fitting mode marked as a local override.
Parameters
| Name | Type |
|---|---|
fit | TextStudio.TextStudio2DTextureFit |
Returns
TextStudio.TextStudio2DPaint
Reference(TextStudio2DPaintAsset)
Section titled “Reference(TextStudio2DPaintAsset)”public static TextStudio2DPaint Reference(TextStudio2DPaintAsset source)Creates a binding to a paint asset with no local overrides.
Parameters
| Name | Type |
|---|---|
source | TextStudio.TextStudio2DPaintAsset |
Returns
TextStudio.TextStudio2DPaint
WithOverrides(TextStudio2DPaintOverrides)
Section titled “WithOverrides(TextStudio2DPaintOverrides)”public TextStudio2DPaint WithOverrides(TextStudio2DPaintOverrides overrides)Returns a paint copy with the specified set of local overrides for referenced paint.
Parameters
| Name | Type |
|---|---|
overrides | TextStudio.TextStudio2DPaintOverrides |
Returns
TextStudio.TextStudio2DPaint
WithMapping(TextStudio2DMappingSpace, TextStudio2DRangeMapping)
Section titled “WithMapping(TextStudio2DMappingSpace, TextStudio2DRangeMapping)”public TextStudio2DPaint WithMapping(TextStudio2DMappingSpace mapping, TextStudio2DRangeMapping range = TextStudio2DRangeMapping.EachMatch)Returns a paint copy with locally overridden mapping space and range mapping behavior.
Parameters
| Name | Type |
|---|---|
mapping | TextStudio.TextStudio2DMappingSpace |
range | TextStudio.TextStudio2DRangeMapping |
Returns
TextStudio.TextStudio2DPaint
WithTint(Color)
Section titled “WithTint(Color)”public TextStudio2DPaint WithTint(Color tint)Returns a paint copy with the supplied tint marked as a local override.
Parameters
| Name | Type |
|---|---|
tint | UnityEngine.Color |
Returns
TextStudio.TextStudio2DPaint
WithTransform(float, Vector2, Vector2, Vector2)
Section titled “WithTransform(float, Vector2, Vector2, Vector2)”public TextStudio2DPaint WithTransform(float angle, Vector2 center, Vector2 scale, Vector2 offset)Returns a paint copy with locally overridden angle, center, scale, and offset.
Parameters
| Name | Type |
|---|---|
angle | System.Single |
center | UnityEngine.Vector2 |
scale | UnityEngine.Vector2 |
offset | UnityEngine.Vector2 |
Returns
TextStudio.TextStudio2DPaint
MakeLocal()
Section titled “MakeLocal()”public TextStudio2DPaint MakeLocal()Copies the resolved value and severs the asset reference.
Returns
TextStudio.TextStudio2DPaint
Properties
Section titled “Properties”
public TextStudio2DPaintKind Kind { get; }Returns
TextStudio.TextStudio2DPaintKind
Mapping
Section titled “Mapping”public TextStudio2DMappingSpace Mapping { get; }Returns
TextStudio.TextStudio2DMappingSpace
Spread
Section titled “Spread”public TextStudio2DGradientSpread Spread { get; }Returns
TextStudio.TextStudio2DGradientSpread
GradientDither
Section titled “GradientDither”public bool GradientDither { get; }Returns
System.Boolean
public Color Color { get; }Returns
UnityEngine.Color
GradientStopCount
Section titled “GradientStopCount”public int GradientStopCount { get; }Returns
System.Int32
FourCornerGradient
Section titled “FourCornerGradient”public TextStudio2DFourCornerGradient FourCornerGradient { get; }Returns
TextStudio.TextStudio2DFourCornerGradient
public float Angle { get; }Returns
System.Single
Center
Section titled “Center”public Vector2 Center { get; }Returns
UnityEngine.Vector2
public Vector2 Scale { get; }Returns
UnityEngine.Vector2
Offset
Section titled “Offset”public Vector2 Offset { get; }Returns
UnityEngine.Vector2
Texture
Section titled “Texture”public Texture2D Texture { get; }Returns
UnityEngine.Texture2D
ResourceId
Section titled “ResourceId”public string ResourceId { get; }Returns
System.String
TextureFit
Section titled “TextureFit”public TextStudio2DTextureFit TextureFit { get; }Returns
TextStudio.TextStudio2DTextureFit
DistanceDomain
Section titled “DistanceDomain”public TextStudio2DDistanceDomain DistanceDomain { get; }Returns
TextStudio.TextStudio2DDistanceDomain
DistanceRange
Section titled “DistanceRange”public Vector2 DistanceRange { get; }Returns
UnityEngine.Vector2
NoiseScale
Section titled “NoiseScale”public float NoiseScale { get; }Returns
System.Single
NoiseDetail
Section titled “NoiseDetail”public float NoiseDetail { get; }Returns
System.Single
NoiseSeed
Section titled “NoiseSeed”public int NoiseSeed { get; }Returns
System.Int32
Source
Section titled “Source”public TextStudio2DPaintAsset Source { get; }Returns
TextStudio.TextStudio2DPaintAsset
UsesSharedSource
Section titled “UsesSharedSource”public bool UsesSharedSource { get; }Returns
System.Boolean
Overrides
Section titled “Overrides”public TextStudio2DPaintOverrides Overrides { get; }Returns
TextStudio.TextStudio2DPaintOverrides
RangeMapping
Section titled “RangeMapping”public TextStudio2DRangeMapping RangeMapping { get; }Returns
TextStudio.TextStudio2DRangeMapping