Skip to content

TextStudio2DGraphicEffectSpec

StructTextStudioTextStudio
public struct TextStudio2DGraphicEffectSpec

Compact parameters shared by the editorial effect family. Presets provide finished defaults; fluent modifiers expose deterministic expert controls without shader variants.

TextStudio2DGraphicEffectSpec(TextStudio2DGraphicEffectKind, TextStudio2DMappingSpace, float, float, float, float, float, float, Vector2, Color, Color, int)

Section titled “TextStudio2DGraphicEffectSpec(TextStudio2DGraphicEffectKind, TextStudio2DMappingSpace, float, float, float, float, float, float, Vector2, Color, Color, int)”
public TextStudio2DGraphicEffectSpec(TextStudio2DGraphicEffectKind kind, TextStudio2DMappingSpace mapping, float intensity, float scale, float detail, float width, float softness, float angle, Vector2 offset, Color primaryColor, Color secondaryColor, int seed)

Creates a graphic-effect specification with the supplied mapping, intensity, pattern geometry, colors, and deterministic seed.

Parameters

Name Type
kind TextStudio.TextStudio2DGraphicEffectKind
mapping TextStudio.TextStudio2DMappingSpace
intensity System.Single
scale System.Single
detail System.Single
width System.Single
softness System.Single
angle System.Single
offset UnityEngine.Vector2
primaryColor UnityEngine.Color
secondaryColor UnityEngine.Color
seed System.Int32

public static TextStudio2DGraphicEffectSpec Preset(TextStudio2DGraphicEffectKind kind)

Returns a polished deterministic starting point for an editorial family.

Parameters

Name Type
kind TextStudio.TextStudio2DGraphicEffectKind

Returns

TextStudio.TextStudio2DGraphicEffectSpec

WithGeometry(float, float, float, float, float, float, Vector2)

Section titled “WithGeometry(float, float, float, float, float, float, Vector2)”
public TextStudio2DGraphicEffectSpec WithGeometry(float intensity, float scale, float detail, float width, float softness, float angle, Vector2 offset)

Returns a graphic-effect copy with the supplied intensity, scale, detail, width, softness, angle, and offset.

Parameters

Name Type
intensity System.Single
scale System.Single
detail System.Single
width System.Single
softness System.Single
angle System.Single
offset UnityEngine.Vector2

Returns

TextStudio.TextStudio2DGraphicEffectSpec

public TextStudio2DGraphicEffectSpec WithColors(Color primary, Color secondary)

Returns a graphic-effect copy with the supplied primary and secondary colors.

Parameters

Name Type
primary UnityEngine.Color
secondary UnityEngine.Color

Returns

TextStudio.TextStudio2DGraphicEffectSpec

public TextStudio2DGraphicEffectSpec WithMapping(TextStudio2DMappingSpace mapping)

Returns a graphic-effect copy using the supplied mapping space.

Parameters

Name Type
mapping TextStudio.TextStudio2DMappingSpace

Returns

TextStudio.TextStudio2DGraphicEffectSpec

public TextStudio2DGraphicEffectSpec WithSeed(int seed)

Returns a graphic-effect copy using the supplied deterministic seed.

Parameters

Name Type
seed System.Int32

Returns

TextStudio.TextStudio2DGraphicEffectSpec

WithHalftoneSizeRamp(TextStudio2DHalftoneSizeRamp)

Section titled “WithHalftoneSizeRamp(TextStudio2DHalftoneSizeRamp)”
public TextStudio2DGraphicEffectSpec WithHalftoneSizeRamp(TextStudio2DHalftoneSizeRamp ramp)

Sets optional directional dot sizing used by the Halftone family.

Parameters

Name Type
ramp TextStudio.TextStudio2DHalftoneSizeRamp

Returns

TextStudio.TextStudio2DGraphicEffectSpec

public TextStudio2DGraphicEffectSpec WithHalftoneSizeRamp(float minimumRadius, float maximumRadius, float angleDegrees)

Enables a directional halftone dot-size ramp.

Parameters

Name Type
minimumRadius System.Single
maximumRadius System.Single
angleDegrees System.Single

Returns

TextStudio.TextStudio2DGraphicEffectSpec

public TextStudio2DGraphicEffectKind Kind { get; }

Returns

TextStudio.TextStudio2DGraphicEffectKind

public TextStudio2DMappingSpace Mapping { get; }

Returns

TextStudio.TextStudio2DMappingSpace

public float Intensity { get; }

Returns

System.Single

public float Scale { get; }

Returns

System.Single

public float Detail { get; }

Returns

System.Single

public float Width { get; }

Returns

System.Single

public float Softness { get; }

Returns

System.Single

public float Angle { get; }

Returns

System.Single

public Vector2 Offset { get; }

Returns

UnityEngine.Vector2

public Color PrimaryColor { get; }

Returns

UnityEngine.Color

public Color SecondaryColor { get; }

Returns

UnityEngine.Color

public int Seed { get; }

Returns

System.Int32

public TextStudio2DHalftoneSizeRamp HalftoneSizeRamp { get; }

Returns

TextStudio.TextStudio2DHalftoneSizeRamp