docs.unity3d.com
    Show / Hide Table of Contents

    Class AOVRequestBuilder

    Utility to build frame passes.

    Inheritance
    Object
    AOVRequestBuilder
    Namespace: UnityEngine.Rendering.HighDefinition
    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()
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023