TextStudioRenderPropertyDescriptor
public readonly struct TextStudioRenderPropertyDescriptorImmutable registration contract for one namespaced renderer property.
Constructors
Section titled “Constructors”
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
| Name | Type |
|---|---|
id | System.String |
displayName | System.String |
category | System.String |
description | System.String |
valueType | TextStudio.TextStudioRenderPropertyValueType |
stage | TextStudio.TextStudioRenderPropertyStage |
performanceClass | TextStudio.TextStudioRenderPropertyPerformanceClass |
defaultValue | UnityEngine.Vector4 |
recommendedMinimum | UnityEngine.Vector4 |
recommendedMaximum | UnityEngine.Vector4 |
units | System.String |
blendModes | TextStudio.TextStudioRenderPropertyBlendModes |
supportsSurfaceMask | System.Boolean |
supportedRenderDomains | TextStudio.TextStudioRenderDomain |
defaultUnsigned | System.UInt32 |
recommendedMinimumUnsigned | System.UInt32 |
recommendedMaximumUnsigned | System.UInt32 |
reducedMotionBehavior | TextStudio.TextStudioReducedMotionBehavior |
boundsBehavior | TextStudio.TextStudioEffectBoundsBehavior |
Properties
Section titled “Properties”
public string Id { get; }Returns
System.String
PropertyId
Section titled “PropertyId”public TextStudioRenderPropertyId PropertyId { get; }Returns
TextStudio.TextStudioRenderPropertyId
DisplayName
Section titled “DisplayName”public string DisplayName { get; }Returns
System.String
Category
Section titled “Category”public string Category { get; }Returns
System.String
Description
Section titled “Description”public string Description { get; }Returns
System.String
public string Units { get; }Returns
System.String
ValueType
Section titled “ValueType”public TextStudioRenderPropertyValueType ValueType { get; }Returns
TextStudio.TextStudioRenderPropertyValueType
public TextStudioRenderPropertyStage Stage { get; }Returns
TextStudio.TextStudioRenderPropertyStage
PerformanceClass
Section titled “PerformanceClass”public TextStudioRenderPropertyPerformanceClass PerformanceClass { get; }Returns
TextStudio.TextStudioRenderPropertyPerformanceClass
BlendModes
Section titled “BlendModes”public TextStudioRenderPropertyBlendModes BlendModes { get; }Returns
TextStudio.TextStudioRenderPropertyBlendModes
Default
Section titled “Default”public TextStudioRenderPropertyValue Default { get; }Returns
TextStudio.TextStudioRenderPropertyValue
DefaultValue
Section titled “DefaultValue”public Vector4 DefaultValue { get; }Returns
UnityEngine.Vector4
DefaultUnsigned
Section titled “DefaultUnsigned”public uint DefaultUnsigned { get; }Returns
System.UInt32
RecommendedMinimum
Section titled “RecommendedMinimum”public Vector4 RecommendedMinimum { get; }Returns
UnityEngine.Vector4
RecommendedMaximum
Section titled “RecommendedMaximum”public Vector4 RecommendedMaximum { get; }Returns
UnityEngine.Vector4
RecommendedMinimumUnsigned
Section titled “RecommendedMinimumUnsigned”public uint RecommendedMinimumUnsigned { get; }Returns
System.UInt32
RecommendedMaximumUnsigned
Section titled “RecommendedMaximumUnsigned”public uint RecommendedMaximumUnsigned { get; }Returns
System.UInt32
SupportsSurfaceMask
Section titled “SupportsSurfaceMask”public bool SupportsSurfaceMask { get; }Returns
System.Boolean
SupportedRenderDomains
Section titled “SupportedRenderDomains”public TextStudioRenderDomain SupportedRenderDomains { get; }Returns
TextStudio.TextStudioRenderDomain
ReducedMotionBehavior
Section titled “ReducedMotionBehavior”public TextStudioReducedMotionBehavior ReducedMotionBehavior { get; }Returns
TextStudio.TextStudioReducedMotionBehavior
BoundsBehavior
Section titled “BoundsBehavior”public TextStudioEffectBoundsBehavior BoundsBehavior { get; }Returns
TextStudio.TextStudioEffectBoundsBehavior