Class AOVRequestBuilder

Utility to build frame passes.

Inheritance

object

AOVRequestBuilder

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.Rendering.HighDefinition

Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll

Syntax

public class AOVRequestBuilder : IDisposable

Methods

Add(AOVRequest, AOVRequestBufferAllocator, List<GameObject>, AOVBuffers[], CustomPassAOVBuffers[], AOVRequestCustomPassBufferAllocator, FramePassCallbackEx)

Add a AOV request.

Declaration

public AOVRequestBuilder Add(AOVRequest settings, AOVRequestBufferAllocator bufferAllocator, List<GameObject> includedLightList, AOVBuffers[] aovBuffers, CustomPassAOVBuffers[] customPassAovBuffers, AOVRequestCustomPassBufferAllocator customPassbufferAllocator, FramePassCallbackEx callback)

Parameters

Type	Name	Description
AOVRequest	settings	Settings to use for this frame pass.
AOVRequestBufferAllocator	bufferAllocator	An allocator for each buffer.
List<GameObject>	includedLightList	If non null, only these lights will be rendered, if none, all lights will be rendered.
AOVBuffers[]	aovBuffers	A list of buffers to use.
CustomPassAOVBuffers[]	customPassAovBuffers	A list of custom passes to captured.
AOVRequestCustomPassBufferAllocator	customPassbufferAllocator	An allocator for each custom pass buffer.
FramePassCallbackEx	callback	A callback that can use the requested buffers once the rendering has completed.

Returns

Type	Description
AOVRequestBuilder

Add(AOVRequest, AOVRequestBufferAllocator, List<GameObject>, AOVBuffers[], FramePassCallback)

Add a AOV request.

Declaration

public AOVRequestBuilder Add(AOVRequest settings, AOVRequestBufferAllocator bufferAllocator, List<GameObject> includedLightList, AOVBuffers[] aovBuffers, FramePassCallback callback)

Parameters

Type	Name	Description
AOVRequest	settings	Settings to use for this frame pass.
AOVRequestBufferAllocator	bufferAllocator	An allocator for each buffer.
List<GameObject>	includedLightList	If non null, only these lights will be rendered, if none, all lights will be rendered.
AOVBuffers[]	aovBuffers	A list of buffers to use.
FramePassCallback	callback	A callback that can use the requested buffers once the rendering has completed.

Returns

Type	Description
AOVRequestBuilder

Build()

Build the frame passes. Allocated resources will be transferred to the returned value.

Declaration

public AOVRequestDataCollection Build()

Returns

Type	Description
AOVRequestDataCollection	The built collection.

Dispose()

Dispose the builder.

This is required when you don't call Build().

Declaration

public void Dispose()

Implements

IDisposable