Struct FrameSettingsHistory

Namespace: UnityEngine.Experimental.Rendering.HDPipeline

Syntax

public struct FrameSettingsHistory : IDebugData

Fields

customMask

Declaration

public FrameSettingsOverrideMask customMask

Field Value

Type	Description
FrameSettingsOverrideMask

debug

Declaration

public FrameSettings debug

Field Value

Type	Description
FrameSettings

defaultType

Declaration

public FrameSettingsRenderType defaultType

Field Value

Type	Description
FrameSettingsRenderType

overridden

Declaration

public FrameSettings overridden

Field Value

Type	Description
FrameSettings

sanitazed

Declaration

public FrameSettings sanitazed

Field Value

Type	Description
FrameSettings

Properties

enabled

Declaration

public static bool enabled { get; }

Property Value

Type	Description
Boolean

Methods

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

Same than FrameSettings.AggregateFrameSettings but keep history of agregation in a collection for DebugMenu. Aggregation is default with override of the renderer then sanitazed depending on supported features of hdrpasset. Then the DebugMenu override occurs.

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)

Same than FrameSettings.AggregateFrameSettings but keep history of agregation in a collection for DebugMenu. Aggregation is default with override of the renderer then sanitazed depending on supported features of hdrpasset. Then the DebugMenu override occurs.

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.

GetPersistantDebugDataCopy(Camera)

Return a copy of the persistently stored data.

Declaration

public static IDebugData GetPersistantDebugDataCopy(Camera camera)

Parameters

Type	Name	Description
Camera	camera

Returns

Type	Description
IDebugData

RegisterDebug(Camera, HDAdditionalCameraData)

Register FrameSettingsHistory for DebugMenu

Declaration

public static IDebugData RegisterDebug(Camera camera, HDAdditionalCameraData additionalCameraData)

Parameters

Type	Name	Description
Camera	camera
HDAdditionalCameraData	additionalCameraData

Returns

Type	Description
IDebugData

UnRegisterDebug(Camera)

Unregister FrameSettingsHistory for DebugMenu

Declaration

public static void UnRegisterDebug(Camera camera)

Parameters

Type	Name	Description
Camera	camera

Explicit Interface Implementations

IDebugData.GetReset()

Declaration

Action IDebugData.GetReset()

Returns

Type	Description
Action

Implements

IDebugData.GetReset()