Class FrameSettingsFieldAttribute | High Definition RP | 6.7.1-preview
docs.unity.cn
    Show / Hide Table of Contents

    Class FrameSettingsFieldAttribute

    Should only be used on enum value of field to describe aspect in DebugMenu

    Inheritance
    Object
    Attribute
    FrameSettingsFieldAttribute
    Namespace: UnityEngine.Experimental.Rendering.HDPipeline
    Syntax
    [AttributeUsage(AttributeTargets.Field)]
    public class FrameSettingsFieldAttribute : Attribute, _Attribute

    Constructors

    FrameSettingsFieldAttribute(Int32, FrameSettingsField, String, String, FrameSettingsFieldAttribute.DisplayType, Type, FrameSettingsField[], FrameSettingsField[], Int32)

    Attribute contenaing generation info for inspector and DebugMenu

    Declaration
    public FrameSettingsFieldAttribute(int group, FrameSettingsField autoName = FrameSettingsField.None, string displayedName = null, string tooltip = null, FrameSettingsFieldAttribute.DisplayType type = FrameSettingsFieldAttribute.DisplayType.BoolAsCheckbox, Type targetType = null, FrameSettingsField[] positiveDependencies = null, FrameSettingsField[] negativeDependencies = null, int customOrderInGroup = -1)
    Parameters
    Type Name Description
    Int32 group

    Group index contening this element.

    FrameSettingsField autoName

    [Optional] Helper to name the label as the enum entry given. Alternatively, use displayedName.

    String displayedName

    [Optional] Displayed name to use as label. If given, it override autoname.

    String tooltip

    [Optional] tooltip to use in inspector.

    FrameSettingsFieldAttribute.DisplayType type

    [Optional] Requested display for this entry.

    Type targetType

    [Requested for Enum] Allow to map boolean value to named enum.

    FrameSettingsField[] positiveDependencies

    [Optional] Dependencies that must be activated in order to appear activable in Inspector. Indentation is deduced frm this information.

    FrameSettingsField[] negativeDependencies
    Int32 customOrderInGroup

    [Optional] If order is not the same than the order of value in the FrameSettingsField enum, you can ask to rewrite order from this element. Could be asked to use this on another element too to have correct ordering amongst everything. (Exemple if the 2nd element must be showed at position 10, add this property with value 10 to in and this parameter with value 3 to the following one (the 3rd).

    Fields

    dependencies

    Declaration
    public readonly FrameSettingsField[] dependencies
    Field Value
    Type Description
    FrameSettingsField[]

    displayedName

    Declaration
    public readonly string displayedName
    Field Value
    Type Description
    String

    group

    Declaration
    public readonly int group
    Field Value
    Type Description
    Int32

    indentLevel

    Declaration
    public readonly int indentLevel
    Field Value
    Type Description
    Int32

    orderInGroup

    Declaration
    public readonly int orderInGroup
    Field Value
    Type Description
    Int32

    targetType

    Declaration
    public readonly Type targetType
    Field Value
    Type Description
    Type

    tooltip

    Declaration
    public readonly string tooltip
    Field Value
    Type Description
    String

    type

    Declaration
    public readonly FrameSettingsFieldAttribute.DisplayType type
    Field Value
    Type Description
    FrameSettingsFieldAttribute.DisplayType

    Methods

    IsNegativeDependency(FrameSettingsField)

    Declaration
    public bool IsNegativeDependency(FrameSettingsField frameSettingsField)
    Parameters
    Type Name Description
    FrameSettingsField frameSettingsField
    Returns
    Type Description
    Boolean
    Back to top Copyright © 2020 Unity Technologies
    Generated by DocFX