Struct FrameSettings

Per renderer and per frame settings.

Namespace: UnityEngine.Experimental.Rendering.HDPipeline

Syntax

[Serializable]
public struct FrameSettings

Fields

defaultCamera

Default FrameSettings for Camera renderer.

Declaration

public static readonly FrameSettings defaultCamera

Field Value

Type	Description
FrameSettings

defaultCustomOrBakeReflectionProbe

Default FrameSettings for baked or custom ReflectionProbe/PlanarReflectionProbe renderer.

Declaration

public static readonly FrameSettings defaultCustomOrBakeReflectionProbe

Field Value

Type	Description
FrameSettings

defaultRealtimeReflectionProbe

Default FrameSettings for realtime ReflectionProbe/PlanarReflectionProbe renderer.

Declaration

public static readonly FrameSettings defaultRealtimeReflectionProbe

Field Value

Type	Description
FrameSettings

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

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

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

AggregateFrameSettings(ref FrameSettings, Camera, HDAdditionalCameraData, ref FrameSettings, RenderPipelineSettings)

Aggregation is default with override of the renderer then sanitazed depending on supported features of hdrpasset.

Declaration

public static void AggregateFrameSettings(ref FrameSettings aggregatedFrameSettings, Camera camera, HDAdditionalCameraData additionalData, ref FrameSettings defaultFrameSettings, RenderPipelineSettings supportedFeatures)

Parameters

Type	Name	Description
FrameSettings	aggregatedFrameSettings	The aggregated FrameSettings result.
Camera	camera	The camera rendering.
HDAdditionalCameraData	additionalData	Additional data of the camera rendering.
FrameSettings	defaultFrameSettings	Base framesettings to copy prior any override.
RenderPipelineSettings	supportedFeatures	Currently supported feature for the sanitazation pass.

AggregateFrameSettings(ref FrameSettings, Camera, HDAdditionalCameraData, HDRenderPipelineAsset)

Aggregation is default with override of the renderer then sanitazed depending on supported features of hdrpasset.

Declaration

public static void AggregateFrameSettings(ref FrameSettings aggregatedFrameSettings, Camera camera, HDAdditionalCameraData additionalData, HDRenderPipelineAsset hdrpAsset)

Parameters

Type	Name	Description
FrameSettings	aggregatedFrameSettings	The aggregated FrameSettings result.
Camera	camera	The camera rendering.
HDAdditionalCameraData	additionalData	Additional data of the camera rendering.
HDRenderPipelineAsset	hdrpAsset	HDRenderPipelineAsset contening default FrameSettings.

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Overrides

ValueType.Equals(Object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

ValueType.GetHashCode()

IsEnabled(FrameSettingsField)

Get stored data for this field.

Declaration

public bool IsEnabled(FrameSettingsField field)

Parameters

Type	Name	Description
FrameSettingsField	field

Returns

Type	Description
Boolean

Override(ref FrameSettings, FrameSettings, FrameSettingsOverrideMask)

Override a frameSettings according to a mask.

Declaration

public static void Override(ref FrameSettings overriddenFrameSettings, FrameSettings overridingFrameSettings, FrameSettingsOverrideMask frameSettingsOverideMask)

Parameters

Type	Name	Description
FrameSettings	overriddenFrameSettings	Overrided FrameSettings. Must contains default data before attempting the override.
FrameSettings	overridingFrameSettings	The FrameSettings data we will use for overriding.
FrameSettingsOverrideMask	frameSettingsOverideMask	The mask to use for overriding (1 means override this field).

Sanitize(ref FrameSettings, Camera, RenderPipelineSettings)

Check FrameSettings with what is supported in RenderPipelineSettings and change value in order to be compatible.

Declaration

public static void Sanitize(ref FrameSettings sanitazedFrameSettings, Camera camera, RenderPipelineSettings renderPipelineSettings)

Parameters

Type	Name	Description
FrameSettings	sanitazedFrameSettings	The FrameSettings being cleaned.
Camera	camera	Camera contais some necessary information to check how to sanitize.
RenderPipelineSettings	renderPipelineSettings	Contains what is supported by the engine.

SetEnabled(FrameSettingsField, Boolean)

Set stored data for this field.

Declaration

public void SetEnabled(FrameSettingsField field, bool value)

Parameters

Type	Name	Description
FrameSettingsField	field
Boolean	value

Operators

Equality(FrameSettings, FrameSettings)

Declaration

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

Parameters

Type	Name	Description
FrameSettings	a
FrameSettings	b

Returns

Type	Description
Boolean

Inequality(FrameSettings, FrameSettings)

Declaration

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

Parameters

Type	Name	Description
FrameSettings	a
FrameSettings	b

Returns

Type	Description
Boolean