Skip to content

TextStudio3DEffectCapability

StructTextStudio.ThreeDTextStudio.3D
public readonly struct TextStudio3DEffectCapability

Immutable preparation, scheduling, bounds, and capacity contract for a native 3D effect.

TextStudio3DEffectCapability(TextStudio3DEffectExecutionDomain, TextStudio3DEffectPreparedData, TextStudio3DEffectPreparationInvalidation, TextStudio3DEffectExecutionRoute, TextStudioEffectBoundsBehavior, int, TextStudio3DAuxiliaryCapacityScope, int)

Section titled “TextStudio3DEffectCapability(TextStudio3DEffectExecutionDomain, TextStudio3DEffectPreparedData, TextStudio3DEffectPreparationInvalidation, TextStudio3DEffectExecutionRoute, TextStudioEffectBoundsBehavior, int, TextStudio3DAuxiliaryCapacityScope, int)”
public TextStudio3DEffectCapability(TextStudio3DEffectExecutionDomain domains, TextStudio3DEffectPreparedData preparedData, TextStudio3DEffectPreparationInvalidation preparationInvalidation, TextStudio3DEffectExecutionRoute route, TextStudioEffectBoundsBehavior boundsBehavior, int maximumAuxiliaryVertices = 0, TextStudio3DAuxiliaryCapacityScope auxiliaryCapacityScope = TextStudio3DAuxiliaryCapacityScope.None, int maximumAdditionalPasses = 0)

Creates an effect capability description with nonnegative vertex and pass limits.

Parameters

NameType
domainsTextStudio.ThreeD.TextStudio3DEffectExecutionDomain
preparedDataTextStudio.ThreeD.TextStudio3DEffectPreparedData
preparationInvalidationTextStudio.ThreeD.TextStudio3DEffectPreparationInvalidation
routeTextStudio.ThreeD.TextStudio3DEffectExecutionRoute
boundsBehaviorTextStudio.TextStudioEffectBoundsBehavior
maximumAuxiliaryVerticesSystem.Int32
auxiliaryCapacityScopeTextStudio.ThreeD.TextStudio3DAuxiliaryCapacityScope
maximumAdditionalPassesSystem.Int32

public long GetMaximumAuxiliaryVertices(int glyphCount)

Returns the auxiliary vertex limit for the requested glyph count and configured capacity scope.

Parameters

NameType
glyphCountSystem.Int32

Returns

System.Int64

public bool Equals(TextStudio3DEffectCapability other)

Parameters

NameType
otherTextStudio.ThreeD.TextStudio3DEffectCapability

Returns

System.Boolean

public override bool Equals(object obj)

Parameters

NameType
objSystem.Object

Returns

System.Boolean

public override int GetHashCode()

Returns

System.Int32

public TextStudio3DEffectExecutionDomain Domains { get; }

Returns

TextStudio.ThreeD.TextStudio3DEffectExecutionDomain

public TextStudio3DEffectPreparedData PreparedData { get; }

Returns

TextStudio.ThreeD.TextStudio3DEffectPreparedData

public TextStudio3DEffectPreparationInvalidation PreparationInvalidation { get; }

Returns

TextStudio.ThreeD.TextStudio3DEffectPreparationInvalidation

public TextStudio3DEffectExecutionRoute Route { get; }

Returns

TextStudio.ThreeD.TextStudio3DEffectExecutionRoute

public TextStudioEffectBoundsBehavior BoundsBehavior { get; }

Returns

TextStudio.TextStudioEffectBoundsBehavior

public TextStudio3DAuxiliaryCapacityScope AuxiliaryCapacityScope { get; }

Returns

TextStudio.ThreeD.TextStudio3DAuxiliaryCapacityScope

public int MaximumAuxiliaryVertices { get; }

Returns

System.Int32

public int MaximumAdditionalPasses { get; }

Returns

System.Int32

public bool UsesPreparedPlayback { get; }

Returns

System.Boolean