Class BoolParameter
A VolumeParameter that holds a bool
value.
Inherited Members
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
[Serializable]
public class BoolParameter : VolumeParameter<bool>, ICloneable, IEquatable<VolumeParameter<bool>>
Constructors
BoolParameter(bool, bool)
Creates a new BoolParameter instance.
Declaration
public BoolParameter(bool value, bool overrideState = false)
Parameters
Type | Name | Description |
---|---|---|
bool | value | The initial value to store in the parameter |
bool | overrideState | The initial override state for the parameter |
BoolParameter(bool, DisplayType, bool)
Creates a new BoolParameter instance.
Declaration
public BoolParameter(bool value, BoolParameter.DisplayType displayType, bool overrideState = false)
Parameters
Type | Name | Description |
---|---|---|
bool | value | The initial value to store in the parameter |
BoolParameter.DisplayType | displayType | The display type to use for the parameter |
bool | overrideState | The initial override state for the parameter |
Fields
displayType
Type of widget used to display the BoolParameter in the UI.
Declaration
[NonSerialized]
public BoolParameter.DisplayType displayType
Field Value
Type | Description |
---|---|
BoolParameter.DisplayType |