Struct CameraSettings.BufferClearing

Defines how color and depth buffers are cleared.

Namespace: UnityEngine.Rendering.HighDefinition

Syntax

[Serializable]
public struct BufferClearing

Fields

backgroundColorHDR

The color to use when clearColorMode == Color.

Declaration

[ColorUsage(true, true)]
public Color backgroundColorHDR

Field Value

Type	Description
Color

clearColorMode

Define the source for the clear color.

Declaration

public HDAdditionalCameraData.ClearColorMode clearColorMode

Field Value

Type	Description
HDAdditionalCameraData.ClearColorMode

clearDepth

True to clear the depth.

Declaration

public bool clearDepth

Field Value

Type	Description
Boolean

default

Default value.

Declaration

[Obsolete("Since 2019.3, use BufferClearing.NewDefault() instead.")]
public static readonly CameraSettings.BufferClearing default

Field Value

Type	Description
CameraSettings.BufferClearing

Methods

NewDefault()

Default value.

Declaration

public static CameraSettings.BufferClearing NewDefault()

Returns

Type	Description
CameraSettings.BufferClearing	The default value.