Struct FrameSettings

Per renderer and per frame settings.

Namespace: UnityEngine.Rendering.HighDefinition

Syntax

[Serializable]
public struct FrameSettings

Fields

lodBias

if lodBiasMode == LODBiasMode.Fixed, then this value will overwrite QualitySettings.lodBias if lodBiasMode == LODBiasMode.ScaleQualitySettings, then this value will scale QualitySettings.lodBias

Declaration

public float lodBias

Field Value

Type	Description
Single

lodBiasMode

Define how the QualitySettings.lodBias value is set.

Declaration

public LODBiasMode lodBiasMode

Field Value

Type	Description
LODBiasMode

lodBiasQualityLevel

The quality level to use when fetching the quality setting value.

Declaration

public int lodBiasQualityLevel

Field Value

Type	Description
Int32

materialQuality

The material quality level to use for this rendering. if materialQuality == 0, then the material quality from the current quality settings (in HDRP Asset) will be used.

Declaration

public MaterialQuality materialQuality

Field Value

Type	Description
MaterialQuality

maximumLODLevel

if maximumLODLevelMode == MaximumLODLevelMode.FromQualitySettings, then this value will overwrite QualitySettings.maximumLODLevel if maximumLODLevelMode == MaximumLODLevelMode.OffsetQualitySettings, then this value will offset QualitySettings.maximumLODLevel

Declaration

public int maximumLODLevel

Field Value

Type	Description
Int32

maximumLODLevelMode

Define how the QualitySettings.maximumLODLevel value is set.

Declaration

public MaximumLODLevelMode maximumLODLevelMode

Field Value

Type	Description
MaximumLODLevelMode

maximumLODLevelQualityLevel

The quality level to use when fetching the quality setting value.

Declaration

public int maximumLODLevelQualityLevel

Field Value

Type	Description
Int32

Properties

litShaderMode

Helper to see binary saved data on LitShaderMode as a LitShaderMode enum.

Declaration

public LitShaderMode litShaderMode { get; set; }

Property Value

Type	Description
LitShaderMode

Methods

Equals(Object)

Equality operator.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj	Frame Settings to compare to.

Returns

Type	Description
Boolean	True if both settings are equal.

Overrides

ValueType.Equals(Object)

GetHashCode()

Returns the hash code of the frame settings.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32	Hash code of the frame settings.

Overrides

ValueType.GetHashCode()

GetResolvedLODBias(HDRenderPipelineAsset)

Compute the LOD bias value to use

Declaration

public float GetResolvedLODBias(HDRenderPipelineAsset hdrp)

Parameters

Type	Name	Description
HDRenderPipelineAsset	hdrp	The HDRP Assets to use

Returns

Type	Description
Single	The LOD Bias to use

GetResolvedMaximumLODLevel(HDRenderPipelineAsset)

Compute the Maximum LOD level to use

Declaration

public int GetResolvedMaximumLODLevel(HDRenderPipelineAsset hdrp)

Parameters

Type	Name	Description
HDRenderPipelineAsset	hdrp	The HDRP Asset to use

Returns

Type	Description
Int32	The Maximum LOD level to use.

IsEnabled(FrameSettingsField)

Get stored data for this field.

Declaration

public bool IsEnabled(FrameSettingsField field)

Parameters

Type	Name	Description
FrameSettingsField	field	Requested field.

Returns

Type	Description
Boolean	True if the field is enabled.

SetEnabled(FrameSettingsField, Boolean)

Set stored data for this field.

Declaration

public void SetEnabled(FrameSettingsField field, bool value)

Parameters

Type	Name	Description
FrameSettingsField	field	Requested field.
Boolean	value	State to set to the field.

Operators

Equality(FrameSettings, FrameSettings)

Equality operator.

Declaration

public static bool operator ==(FrameSettings a, FrameSettings b)

Parameters

Type	Name	Description
FrameSettings	a	First frame settings.
FrameSettings	b	Second frame settings.

Returns

Type	Description
Boolean	True if both settings are equal.

Inequality(FrameSettings, FrameSettings)

Inequality operator.

Declaration

public static bool operator !=(FrameSettings a, FrameSettings b)

Parameters

Type	Name	Description
FrameSettings	a	First frame settings.
FrameSettings	b	Second frame settings.

Returns

Type	Description
Boolean	True if settings are not equal.