TextStudioChannelDescriptor
public readonly struct TextStudioChannelDescriptorImmutable registration contract for one namespaced renderer-extension channel.
Constructors
Section titled “Constructors”
TextStudioChannelDescriptor(string, string, string, string, TextStudioChannelValueType, TextStudioChannelStage, TextStudioChannelPerformanceClass, Vector4, Vector4, Vector4, string, TextStudioChannelBlendModes, bool, TextStudioRenderDomain)
Section titled “TextStudioChannelDescriptor(string, string, string, string, TextStudioChannelValueType, TextStudioChannelStage, TextStudioChannelPerformanceClass, Vector4, Vector4, Vector4, string, TextStudioChannelBlendModes, bool, TextStudioRenderDomain)”public TextStudioChannelDescriptor(string id, string displayName, string category, string description, TextStudioChannelValueType valueType, TextStudioChannelStage stage, TextStudioChannelPerformanceClass performanceClass, Vector4 defaultValue, Vector4 recommendedMinimum, Vector4 recommendedMaximum, string units = "", TextStudioChannelBlendModes blendModes = TextStudioChannelBlendModes.All, bool supportsSurfaceMask = false, TextStudioRenderDomain supportedRenderDomains = TextStudioRenderDomain.All)Creates an immutable channel layout, authoring schema, blend policy, and render-domain contract.
Parameters
| Name | Type |
|---|---|
id |
System.String |
displayName |
System.String |
category |
System.String |
description |
System.String |
valueType |
TextStudio.TextStudioChannelValueType |
stage |
TextStudio.TextStudioChannelStage |
performanceClass |
TextStudio.TextStudioChannelPerformanceClass |
defaultValue |
UnityEngine.Vector4 |
recommendedMinimum |
UnityEngine.Vector4 |
recommendedMaximum |
UnityEngine.Vector4 |
units |
System.String |
blendModes |
TextStudio.TextStudioChannelBlendModes |
supportsSurfaceMask |
System.Boolean |
supportedRenderDomains |
TextStudio.TextStudioRenderDomain |
Properties
Section titled “Properties”
public string Id { get; }Returns
System.String
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 TextStudioChannelValueType ValueType { get; }Returns
TextStudio.TextStudioChannelValueType
public TextStudioChannelStage Stage { get; }Returns
TextStudio.TextStudioChannelStage
PerformanceClass
Section titled “PerformanceClass”public TextStudioChannelPerformanceClass PerformanceClass { get; }Returns
TextStudio.TextStudioChannelPerformanceClass
BlendModes
Section titled “BlendModes”public TextStudioChannelBlendModes BlendModes { get; }Returns
TextStudio.TextStudioChannelBlendModes
DefaultValue
Section titled “DefaultValue”public Vector4 DefaultValue { get; }Returns
UnityEngine.Vector4
RecommendedMinimum
Section titled “RecommendedMinimum”public Vector4 RecommendedMinimum { get; }Returns
UnityEngine.Vector4
RecommendedMaximum
Section titled “RecommendedMaximum”public Vector4 RecommendedMaximum { get; }Returns
UnityEngine.Vector4
SupportsSurfaceMask
Section titled “SupportsSurfaceMask”public bool SupportsSurfaceMask { get; }Returns
System.Boolean
SupportedRenderDomains
Section titled “SupportedRenderDomains”public TextStudioRenderDomain SupportedRenderDomains { get; }Returns
TextStudio.TextStudioRenderDomain