TextStudio2DSurfaceTreatment

StructTextStudioTextStudio

public struct TextStudio2DSurfaceTreatment

One independently painted treatment of an owned decoration surface.

Methods

CreateFill(string, TextStudio2DPaint, TextStudio2DFillSpec)

public static TextStudio2DSurfaceTreatment CreateFill(string name, TextStudio2DPaint paint, TextStudio2DFillSpec fill = default)

Creates a named decoration-surface fill treatment with an independent paint copy and the supplied fill settings.

Parameters

Name	Type
name	System.String
paint	TextStudio.TextStudio2DPaint
fill	TextStudio.TextStudio2DFillSpec

Returns

TextStudio.TextStudio2DSurfaceTreatment

CreateStroke(string, TextStudio2DPaint, TextStudio2DStrokeSpec)

public static TextStudio2DSurfaceTreatment CreateStroke(string name, TextStudio2DPaint paint, TextStudio2DStrokeSpec stroke)

Creates a named decoration-surface stroke treatment with independent paint and stroke-pattern copies.

Parameters

Name	Type
name	System.String
paint	TextStudio.TextStudio2DPaint
stroke	TextStudio.TextStudio2DStrokeSpec

Returns

TextStudio.TextStudio2DSurfaceTreatment

CreateShadow(string, bool, TextStudio2DPaint, TextStudio2DShadowSpec)

public static TextStudio2DSurfaceTreatment CreateShadow(string name, bool inner, TextStudio2DPaint paint, TextStudio2DShadowSpec shadow)

Creates a named inner or outer shadow treatment for a decoration surface using the supplied paint and shadow settings.

Parameters

Name	Type
name	System.String
inner	System.Boolean
paint	TextStudio.TextStudio2DPaint
shadow	TextStudio.TextStudio2DShadowSpec

Returns

TextStudio.TextStudio2DSurfaceTreatment

CreateGlow(string, bool, TextStudio2DPaint, TextStudio2DGlowSpec)

public static TextStudio2DSurfaceTreatment CreateGlow(string name, bool inner, TextStudio2DPaint paint, TextStudio2DGlowSpec glow)

Creates a named inner or outer glow treatment for a decoration surface using the supplied paint and glow settings.

Parameters

Name	Type
name	System.String
inner	System.Boolean
paint	TextStudio.TextStudio2DPaint
glow	TextStudio.TextStudio2DGlowSpec

Returns

TextStudio.TextStudio2DSurfaceTreatment

CreateBevel(string, TextStudio2DBevelSpec)

public static TextStudio2DSurfaceTreatment CreateBevel(string name, TextStudio2DBevelSpec bevel)

Creates a named bevel treatment for a decoration surface with the supplied relief and lighting settings.

Parameters

Name	Type
name	System.String
bevel	TextStudio.TextStudio2DBevelSpec

Returns

TextStudio.TextStudio2DSurfaceTreatment

CreateMaterialResponse(string, TextStudio2DMaterialResponseSpec)

public static TextStudio2DSurfaceTreatment CreateMaterialResponse(string name, TextStudio2DMaterialResponseSpec response)

Creates a named material-response treatment for a decoration surface with the supplied surface and lighting settings.

Parameters

Name	Type
name	System.String
response	TextStudio.TextStudio2DMaterialResponseSpec

Returns

TextStudio.TextStudio2DSurfaceTreatment

WithIdentity(TextStudioStackItemId)

public TextStudio2DSurfaceTreatment WithIdentity(TextStudioStackItemId identity)

Returns a surface-treatment copy with the supplied persistent stack-item identity.

Parameters

Name	Type
identity	TextStudio.TextStudioStackItemId

Returns

TextStudio.TextStudio2DSurfaceTreatment

WithState(bool)

public TextStudio2DSurfaceTreatment WithState(bool enabled)

Returns a surface-treatment copy with the supplied enabled state.

Parameters

Name	Type
enabled	System.Boolean

Returns

TextStudio.TextStudio2DSurfaceTreatment

WithCompositing(float, TextStudio2DBlendMode)

public TextStudio2DSurfaceTreatment WithCompositing(float opacity, TextStudio2DBlendMode blendMode = TextStudio2DBlendMode.Normal)

Returns a surface-treatment copy with the supplied opacity and blend mode.

Parameters

Name	Type
opacity	System.Single
blendMode	TextStudio.TextStudio2DBlendMode

Returns

TextStudio.TextStudio2DSurfaceTreatment

WithAnimatedTint(bool)

public TextStudio2DSurfaceTreatment WithAnimatedTint(bool participates)

Returns a surface-treatment copy with the supplied participation in animated tinting.

Parameters

Name	Type
participates	System.Boolean

Returns

TextStudio.TextStudio2DSurfaceTreatment

WithPaint(TextStudio2DPaint)

public TextStudio2DSurfaceTreatment WithPaint(TextStudio2DPaint paint)

Returns a surface-treatment copy with an independently copied paint binding.

Parameters

Name	Type
paint	TextStudio.TextStudio2DPaint

Returns

TextStudio.TextStudio2DSurfaceTreatment

Properties

ItemId

public TextStudioStackItemId ItemId { get; }

Returns

TextStudio.TextStudioStackItemId

DisplayName

public string DisplayName { get; }

Returns

System.String

Kind

public TextStudio2DLayerKind Kind { get; }

Returns

TextStudio.TextStudio2DLayerKind

IsEnabled

public bool IsEnabled { get; }

Returns

System.Boolean

Opacity

public float Opacity { get; }

Returns

System.Single

BlendMode

public TextStudio2DBlendMode BlendMode { get; }

Returns

TextStudio.TextStudio2DBlendMode

ParticipatesInAnimatedTint

public bool ParticipatesInAnimatedTint { get; }

Returns

System.Boolean

Paint

public TextStudio2DPaint Paint { get; }

Returns

TextStudio.TextStudio2DPaint

Fill

public TextStudio2DFillSpec Fill { get; }

Returns

TextStudio.TextStudio2DFillSpec

Stroke

public TextStudio2DStrokeSpec Stroke { get; }

Returns

TextStudio.TextStudio2DStrokeSpec

Shadow

public TextStudio2DShadowSpec Shadow { get; }

Returns

TextStudio.TextStudio2DShadowSpec

Glow

public TextStudio2DGlowSpec Glow { get; }

Returns

TextStudio.TextStudio2DGlowSpec

Bevel

public TextStudio2DBevelSpec Bevel { get; }

Returns

TextStudio.TextStudio2DBevelSpec

MaterialResponse

public TextStudio2DMaterialResponseSpec MaterialResponse { get; }

Returns

TextStudio.TextStudio2DMaterialResponseSpec