Skip to content

TextStudioRenderPropertyDescriptor

StructTextStudioTextStudio
public readonly struct TextStudioRenderPropertyDescriptor

Immutable registration contract for one namespaced renderer property.

TextStudioRenderPropertyDescriptor(string, string, string, string, TextStudioRenderPropertyValueType, TextStudioRenderPropertyStage, TextStudioRenderPropertyPerformanceClass, Vector4, Vector4, Vector4, string, TextStudioRenderPropertyBlendModes, bool, TextStudioRenderDomain, uint, uint, uint, TextStudioReducedMotionBehavior, TextStudioEffectBoundsBehavior)

Section titled “TextStudioRenderPropertyDescriptor(string, string, string, string, TextStudioRenderPropertyValueType, TextStudioRenderPropertyStage, TextStudioRenderPropertyPerformanceClass, Vector4, Vector4, Vector4, string, TextStudioRenderPropertyBlendModes, bool, TextStudioRenderDomain, uint, uint, uint, TextStudioReducedMotionBehavior, TextStudioEffectBoundsBehavior)”
public TextStudioRenderPropertyDescriptor(string id, string displayName, string category, string description, TextStudioRenderPropertyValueType valueType, TextStudioRenderPropertyStage stage, TextStudioRenderPropertyPerformanceClass performanceClass, Vector4 defaultValue, Vector4 recommendedMinimum, Vector4 recommendedMaximum, string units = "", TextStudioRenderPropertyBlendModes blendModes = TextStudioRenderPropertyBlendModes.All, bool supportsSurfaceMask = false, TextStudioRenderDomain supportedRenderDomains = TextStudioRenderDomain.All, uint defaultUnsigned = 0, uint recommendedMinimumUnsigned = 0, uint recommendedMaximumUnsigned = 1, TextStudioReducedMotionBehavior reducedMotionBehavior = TextStudioReducedMotionBehavior.Reduce, TextStudioEffectBoundsBehavior boundsBehavior = TextStudioEffectBoundsBehavior.Unchanged)

Creates a typed render-property contract with defaults, recommended ranges, blend modes, surface and domain support, motion policy, and bounds behavior.

Parameters

NameType
idSystem.String
displayNameSystem.String
categorySystem.String
descriptionSystem.String
valueTypeTextStudio.TextStudioRenderPropertyValueType
stageTextStudio.TextStudioRenderPropertyStage
performanceClassTextStudio.TextStudioRenderPropertyPerformanceClass
defaultValueUnityEngine.Vector4
recommendedMinimumUnityEngine.Vector4
recommendedMaximumUnityEngine.Vector4
unitsSystem.String
blendModesTextStudio.TextStudioRenderPropertyBlendModes
supportsSurfaceMaskSystem.Boolean
supportedRenderDomainsTextStudio.TextStudioRenderDomain
defaultUnsignedSystem.UInt32
recommendedMinimumUnsignedSystem.UInt32
recommendedMaximumUnsignedSystem.UInt32
reducedMotionBehaviorTextStudio.TextStudioReducedMotionBehavior
boundsBehaviorTextStudio.TextStudioEffectBoundsBehavior

public string Id { get; }

Returns

System.String

public TextStudioRenderPropertyId PropertyId { get; }

Returns

TextStudio.TextStudioRenderPropertyId

public string DisplayName { get; }

Returns

System.String

public string Category { get; }

Returns

System.String

public string Description { get; }

Returns

System.String

public string Units { get; }

Returns

System.String

public TextStudioRenderPropertyValueType ValueType { get; }

Returns

TextStudio.TextStudioRenderPropertyValueType

public TextStudioRenderPropertyStage Stage { get; }

Returns

TextStudio.TextStudioRenderPropertyStage

public TextStudioRenderPropertyPerformanceClass PerformanceClass { get; }

Returns

TextStudio.TextStudioRenderPropertyPerformanceClass

public TextStudioRenderPropertyBlendModes BlendModes { get; }

Returns

TextStudio.TextStudioRenderPropertyBlendModes

public TextStudioRenderPropertyValue Default { get; }

Returns

TextStudio.TextStudioRenderPropertyValue

public Vector4 DefaultValue { get; }

Returns

UnityEngine.Vector4

public uint DefaultUnsigned { get; }

Returns

System.UInt32

public Vector4 RecommendedMinimum { get; }

Returns

UnityEngine.Vector4

public Vector4 RecommendedMaximum { get; }

Returns

UnityEngine.Vector4

public uint RecommendedMinimumUnsigned { get; }

Returns

System.UInt32

public uint RecommendedMaximumUnsigned { get; }

Returns

System.UInt32

public bool SupportsSurfaceMask { get; }

Returns

System.Boolean

public TextStudioRenderDomain SupportedRenderDomains { get; }

Returns

TextStudio.TextStudioRenderDomain

public TextStudioReducedMotionBehavior ReducedMotionBehavior { get; }

Returns

TextStudio.TextStudioReducedMotionBehavior

public TextStudioEffectBoundsBehavior BoundsBehavior { get; }

Returns

TextStudio.TextStudioEffectBoundsBehavior