Class RawColorHistory

Raw render color history. The color snapshot is taken before post processing. Raw rendered geometry. No UI overlay. A matching depth is RawDepthHistory. Color space is linear RGB. No mips. MSAA is not supported and is resolved for the history. XR is supported.

Inheritance

object

ContextItem

CameraHistoryItem

RawColorHistory

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.Rendering.Universal

Assembly: Unity.RenderPipelines.Universal.Runtime.dll

Syntax

public sealed class RawColorHistory : CameraHistoryItem

Methods

GetCurrentTexture(int)

Get the current history texture. Current history might not be valid yet. It is valid only after executing the producing render pass.

Declaration

public RTHandle GetCurrentTexture(int eyeIndex = 0)

Parameters

Type	Name	Description
int	eyeIndex	Eye index, typically XRPass.multipassId.

Returns

Type	Description
RTHandle	The texture.

GetPreviousTexture(int)

Get the previous history texture. Previous history might not be valid yet. It is valid only after executing the producing render pass.

Declaration

public RTHandle GetPreviousTexture(int eyeIndex = 0)

Parameters

Type	Name	Description
int	eyeIndex	Eye index, typically XRPass.multipassId.

Returns

Type	Description
RTHandle	The texture.

OnCreate(BufferedRTHandleSystem, uint)

Called internally when a CameraHistoryItem type is created to initialize the RTHandle storage and type id.

User types can override to do additional initialization, such as creating the ids for multiple history RTHandles. Deriving type should call the base.OnCreate() to correctly initialize the CameraHistoryItem first.

Declaration

public override void OnCreate(BufferedRTHandleSystem owner, uint typeId)

Parameters

Type	Name	Description
BufferedRTHandleSystem	owner	BufferedRTHandleSystem of the owning camera.
uint	typeId	Unique id given to this class type by the owning camera.

Overrides

CameraHistoryItem.OnCreate(BufferedRTHandleSystem, uint)

Reset()

Release the history texture(s).

Declaration

public override void Reset()

Overrides

UnityEngine.Rendering.ContextItem.Reset()