Skip to content

TextStudio2DLayer

StructTextStudioTextStudio
public struct TextStudio2DLayer : ITextStudioStackItem

One persistent, independently addressable row in a 2D appearance stack.

public static TextStudio2DLayer CreateFill(string displayName, TextStudio2DPaint paint)

Creates a named fill layer with an independent paint copy and default fill settings.

Parameters

NameType
displayNameSystem.String
paintTextStudio.TextStudio2DPaint

Returns

TextStudio.TextStudio2DLayer

CreateFill(string, TextStudio2DPaint, TextStudio2DFillSpec)

Section titled “CreateFill(string, TextStudio2DPaint, TextStudio2DFillSpec)”
public static TextStudio2DLayer CreateFill(string displayName, TextStudio2DPaint paint, TextStudio2DFillSpec fill)

Creates a named fill layer with an independent paint copy and the supplied fill specification.

Parameters

NameType
displayNameSystem.String
paintTextStudio.TextStudio2DPaint
fillTextStudio.TextStudio2DFillSpec

Returns

TextStudio.TextStudio2DLayer

CreateStroke(string, TextStudio2DPaint, TextStudio2DStrokeSpec)

Section titled “CreateStroke(string, TextStudio2DPaint, TextStudio2DStrokeSpec)”
public static TextStudio2DLayer CreateStroke(string displayName, TextStudio2DPaint paint, TextStudio2DStrokeSpec stroke)

Creates a named stroke layer with independent paint and stroke-pattern copies.

Parameters

NameType
displayNameSystem.String
paintTextStudio.TextStudio2DPaint
strokeTextStudio.TextStudio2DStrokeSpec

Returns

TextStudio.TextStudio2DLayer

CreateShadow(string, bool, TextStudio2DPaint, TextStudio2DShadowSpec)

Section titled “CreateShadow(string, bool, TextStudio2DPaint, TextStudio2DShadowSpec)”
public static TextStudio2DLayer CreateShadow(string displayName, bool inner, TextStudio2DPaint paint, TextStudio2DShadowSpec shadow)

Creates a named inner or outer shadow layer with an independent paint copy and the supplied shadow settings.

Parameters

NameType
displayNameSystem.String
innerSystem.Boolean
paintTextStudio.TextStudio2DPaint
shadowTextStudio.TextStudio2DShadowSpec

Returns

TextStudio.TextStudio2DLayer

CreateGlow(string, bool, TextStudio2DPaint, TextStudio2DGlowSpec)

Section titled “CreateGlow(string, bool, TextStudio2DPaint, TextStudio2DGlowSpec)”
public static TextStudio2DLayer CreateGlow(string displayName, bool inner, TextStudio2DPaint paint, TextStudio2DGlowSpec glow)

Creates a named inner or outer glow layer with an independent paint copy and the supplied glow settings.

Parameters

NameType
displayNameSystem.String
innerSystem.Boolean
paintTextStudio.TextStudio2DPaint
glowTextStudio.TextStudio2DGlowSpec

Returns

TextStudio.TextStudio2DLayer

CreateBevel(string, TextStudio2DBevelSpec)

Section titled “CreateBevel(string, TextStudio2DBevelSpec)”
public static TextStudio2DLayer CreateBevel(string displayName, TextStudio2DBevelSpec bevel)

Creates a named bevel layer with the supplied relief and lighting settings.

Parameters

NameType
displayNameSystem.String
bevelTextStudio.TextStudio2DBevelSpec

Returns

TextStudio.TextStudio2DLayer

CreateFauxDepth(string, TextStudio2DPaint, TextStudio2DFauxDepthSpec)

Section titled “CreateFauxDepth(string, TextStudio2DPaint, TextStudio2DFauxDepthSpec)”
public static TextStudio2DLayer CreateFauxDepth(string displayName, TextStudio2DPaint paint, TextStudio2DFauxDepthSpec fauxDepth)

Creates a named faux-depth layer with an independent paint copy and the supplied extrusion settings.

Parameters

NameType
displayNameSystem.String
paintTextStudio.TextStudio2DPaint
fauxDepthTextStudio.TextStudio2DFauxDepthSpec

Returns

TextStudio.TextStudio2DLayer

CreateDecoration(string, TextStudio2DPaint, TextStudio2DDecorationSpec)

Section titled “CreateDecoration(string, TextStudio2DPaint, TextStudio2DDecorationSpec)”
public static TextStudio2DLayer CreateDecoration(string displayName, TextStudio2DPaint paint, TextStudio2DDecorationSpec decoration)

Creates a named decoration layer whose surface treatments are replaced by a fill using the supplied paint.

Parameters

NameType
displayNameSystem.String
paintTextStudio.TextStudio2DPaint
decorationTextStudio.TextStudio2DDecorationSpec

Returns

TextStudio.TextStudio2DLayer

CreateDecoration(string, TextStudio2DDecorationSpec)

Section titled “CreateDecoration(string, TextStudio2DDecorationSpec)”
public static TextStudio2DLayer CreateDecoration(string displayName, TextStudio2DDecorationSpec decoration)

Creates a named decoration layer with an independently copied decoration specification.

Parameters

NameType
displayNameSystem.String
decorationTextStudio.TextStudio2DDecorationSpec

Returns

TextStudio.TextStudio2DLayer

public static TextStudio2DLayer CreateMask(string displayName, TextStudio2DMaskSpec mask)

Creates a named mask layer with the supplied source, inversion, and feathering settings.

Parameters

NameType
displayNameSystem.String
maskTextStudio.TextStudio2DMaskSpec

Returns

TextStudio.TextStudio2DLayer

public static TextStudio2DLayer CreateGroup(string displayName)

Creates a named group layer for organizing child appearance layers.

Parameters

NameType
displayNameSystem.String

Returns

TextStudio.TextStudio2DLayer

CreateMaterialResponse(string, TextStudio2DMaterialResponseSpec)

Section titled “CreateMaterialResponse(string, TextStudio2DMaterialResponseSpec)”
public static TextStudio2DLayer CreateMaterialResponse(string displayName, TextStudio2DMaterialResponseSpec materialResponse)

Creates a named material-response layer with the supplied surface and lighting settings.

Parameters

NameType
displayNameSystem.String
materialResponseTextStudio.TextStudio2DMaterialResponseSpec

Returns

TextStudio.TextStudio2DLayer

CreateGraphicEffect(string, TextStudio2DGraphicEffectSpec)

Section titled “CreateGraphicEffect(string, TextStudio2DGraphicEffectSpec)”
public static TextStudio2DLayer CreateGraphicEffect(string displayName, TextStudio2DGraphicEffectSpec graphicEffect)

Creates a named graphic-effect layer with the supplied pattern and color settings.

Parameters

NameType
displayNameSystem.String
graphicEffectTextStudio.TextStudio2DGraphicEffectSpec

Returns

TextStudio.TextStudio2DLayer

CreateAnimatedEffect(string, TextStudio2DAnimatedEffectSpec)

Section titled “CreateAnimatedEffect(string, TextStudio2DAnimatedEffectSpec)”
public static TextStudio2DLayer CreateAnimatedEffect(string displayName, TextStudio2DAnimatedEffectSpec animatedEffect)

Creates a named animated-effect layer with the supplied timing, shape, color, and motion settings.

Parameters

NameType
displayNameSystem.String
animatedEffectTextStudio.TextStudio2DAnimatedEffectSpec

Returns

TextStudio.TextStudio2DLayer

CreateColorAdjustment(string, TextStudio2DColorAdjustmentSpec)

Section titled “CreateColorAdjustment(string, TextStudio2DColorAdjustmentSpec)”
public static TextStudio2DLayer CreateColorAdjustment(string displayName, TextStudio2DColorAdjustmentSpec colorAdjustment)

Creates a named color-adjustment layer with the supplied transform.

Parameters

NameType
displayNameSystem.String
colorAdjustmentTextStudio.TextStudio2DColorAdjustmentSpec

Returns

TextStudio.TextStudio2DLayer

CreateCompositeAdjustment(string, TextStudio2DColorAdjustmentSpec)

Section titled “CreateCompositeAdjustment(string, TextStudio2DColorAdjustmentSpec)”
public static TextStudio2DLayer CreateCompositeAdjustment(string displayName, TextStudio2DColorAdjustmentSpec adjustment)

Creates a named composite-adjustment layer with the supplied color transform.

Parameters

NameType
displayNameSystem.String
adjustmentTextStudio.TextStudio2DColorAdjustmentSpec

Returns

TextStudio.TextStudio2DLayer

public TextStudio2DLayer WithIdentity(TextStudioStackItemId itemId)

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

Parameters

NameType
itemIdTextStudio.TextStudioStackItemId

Returns

TextStudio.TextStudio2DLayer

public TextStudio2DLayer WithState(bool enabled, bool solo = false)

Returns a layer copy with the supplied enabled state, allowing solo mode only while enabled.

Parameters

NameType
enabledSystem.Boolean
soloSystem.Boolean

Returns

TextStudio.TextStudio2DLayer

WithCompositing(float, TextStudio2DBlendMode)

Section titled “WithCompositing(float, TextStudio2DBlendMode)”
public TextStudio2DLayer WithCompositing(float opacity, TextStudio2DBlendMode blendMode = TextStudio2DBlendMode.Normal)

Returns a layer copy with the supplied opacity and blend mode.

Parameters

NameType
opacitySystem.Single
blendModeTextStudio.TextStudio2DBlendMode

Returns

TextStudio.TextStudio2DLayer

WithExecution(TextStudio2DExecutionPath, TextStudio2DQualityTier)

Section titled “WithExecution(TextStudio2DExecutionPath, TextStudio2DQualityTier)”
public TextStudio2DLayer WithExecution(TextStudio2DExecutionPath executionPath, TextStudio2DQualityTier qualityTier = TextStudio2DQualityTier.Balanced)

Returns a layer copy with the supplied execution path and quality tier.

Parameters

NameType
executionPathTextStudio.TextStudio2DExecutionPath
qualityTierTextStudio.TextStudio2DQualityTier

Returns

TextStudio.TextStudio2DLayer

WithSelector(TextStudioApplicationSelector)

Section titled “WithSelector(TextStudioApplicationSelector)”
public TextStudio2DLayer WithSelector(TextStudioApplicationSelector selector)

Returns a layer copy with the supplied application selector.

Parameters

NameType
selectorTextStudio.TextStudioApplicationSelector

Returns

TextStudio.TextStudio2DLayer

public TextStudio2DLayer WithGroupOrder(TextStudio2DGroupOrder order)

Sets the ordering of this group’s child layers; nested groups remain isolated owners.

Parameters

NameType
orderTextStudio.TextStudio2DGroupOrder

Returns

TextStudio.TextStudio2DLayer

WithSharedSurfaceOrder(TextStudio2DSharedSurfaceOrder)

Section titled “WithSharedSurfaceOrder(TextStudio2DSharedSurfaceOrder)”
public TextStudio2DLayer WithSharedSurfaceOrder(TextStudio2DSharedSurfaceOrder order)

Draws this decoration once before or after its scope’s characters.

Parameters

NameType
orderTextStudio.TextStudio2DSharedSurfaceOrder

Returns

TextStudio.TextStudio2DLayer

WithRelationships(TextStudioStackItemId, TextStudioStackItemId)

Section titled “WithRelationships(TextStudioStackItemId, TextStudioStackItemId)”
public TextStudio2DLayer WithRelationships(TextStudioStackItemId parentId, TextStudioStackItemId maskId = default)

Returns a layer copy with the supplied parent-group and mask references.

Parameters

NameType
parentIdTextStudio.TextStudioStackItemId
maskIdTextStudio.TextStudioStackItemId

Returns

TextStudio.TextStudio2DLayer

public TextStudio2DLayer WithAnimatedTint(bool participates)

Returns a layer copy with the supplied participation in animated tinting.

Parameters

NameType
participatesSystem.Boolean

Returns

TextStudio.TextStudio2DLayer

WithSourceApplicability(TextStudio2DSourceApplicability)

Section titled “WithSourceApplicability(TextStudio2DSourceApplicability)”
public TextStudio2DLayer WithSourceApplicability(TextStudio2DSourceApplicability sources)

Returns a layer copy targeting the supplied source-content categories.

Parameters

NameType
sourcesTextStudio.TextStudio2DSourceApplicability

Returns

TextStudio.TextStudio2DLayer

public TextStudio2DLayer WithPaint(TextStudio2DPaint paint)

Replaces this layer’s paint with an independently owned binding.

Parameters

NameType
paintTextStudio.TextStudio2DPaint

Returns

TextStudio.TextStudio2DLayer

WithAppearanceActivation(TextStudioAppearanceActivation)

Section titled “WithAppearanceActivation(TextStudioAppearanceActivation)”
public TextStudio2DLayer WithAppearanceActivation(TextStudioAppearanceActivation activation)

Returns a layer copy with an independently copied appearance-activation specification.

Parameters

NameType
activationTextStudio.TextStudioAppearanceActivation

Returns

TextStudio.TextStudio2DLayer

public TextStudioStackItemId ItemId { get; }

Returns

TextStudio.TextStudioStackItemId

public string DisplayName { get; }

Returns

System.String

public TextStudio2DLayerKind Kind { get; }

Returns

TextStudio.TextStudio2DLayerKind

public bool IsEnabled { get; }

Returns

System.Boolean

public bool IsSolo { get; }

Returns

System.Boolean

public bool ParticipatesInAnimatedTint { get; }

Returns

System.Boolean

public float Opacity { get; }

Returns

System.Single

public TextStudio2DBlendMode BlendMode { get; }

Returns

TextStudio.TextStudio2DBlendMode

public TextStudio2DExecutionPath ExecutionPath { get; }

Returns

TextStudio.TextStudio2DExecutionPath

public TextStudio2DQualityTier QualityTier { get; }

Returns

TextStudio.TextStudio2DQualityTier

public TextStudio2DGroupOrder GroupOrder { get; }

Returns

TextStudio.TextStudio2DGroupOrder

public TextStudio2DSharedSurfaceOrder SharedSurfaceOrder { get; }

Returns

TextStudio.TextStudio2DSharedSurfaceOrder

public TextStudio2DSourceApplicability SourceApplicability { get; }

Returns

TextStudio.TextStudio2DSourceApplicability

public TextStudioStackItemId ParentId { get; }

Returns

TextStudio.TextStudioStackItemId

public TextStudioStackItemId MaskId { get; }

Returns

TextStudio.TextStudioStackItemId

public TextStudioApplicationSelector Selector { get; }

Returns

TextStudio.TextStudioApplicationSelector

public TextStudio2DPaint Paint { get; }

Returns

TextStudio.TextStudio2DPaint

public TextStudio2DFillSpec Fill { get; }

Returns

TextStudio.TextStudio2DFillSpec

public TextStudio2DStrokeSpec Stroke { get; }

Returns

TextStudio.TextStudio2DStrokeSpec

public TextStudio2DShadowSpec Shadow { get; }

Returns

TextStudio.TextStudio2DShadowSpec

public TextStudio2DGlowSpec Glow { get; }

Returns

TextStudio.TextStudio2DGlowSpec

public TextStudio2DBevelSpec Bevel { get; }

Returns

TextStudio.TextStudio2DBevelSpec

public TextStudio2DFauxDepthSpec FauxDepth { get; }

Returns

TextStudio.TextStudio2DFauxDepthSpec

public TextStudio2DDecorationSpec Decoration { get; }

Returns

TextStudio.TextStudio2DDecorationSpec

public TextStudio2DMaskSpec Mask { get; }

Returns

TextStudio.TextStudio2DMaskSpec

public TextStudio2DMaterialResponseSpec MaterialResponse { get; }

Returns

TextStudio.TextStudio2DMaterialResponseSpec

public TextStudio2DGraphicEffectSpec GraphicEffect { get; }

Returns

TextStudio.TextStudio2DGraphicEffectSpec

public TextStudio2DAnimatedEffectSpec AnimatedEffect { get; }

Returns

TextStudio.TextStudio2DAnimatedEffectSpec

public TextStudio2DColorAdjustmentSpec ColorAdjustment { get; }

Returns

TextStudio.TextStudio2DColorAdjustmentSpec

public TextStudioAppearanceActivation AppearanceActivation { get; }

Returns

TextStudio.TextStudioAppearanceActivation