Class UniversalRenderPipeline | Universal RP | 8.2.0
docs.unity3d.com
    Show / Hide Table of Contents

    Class UniversalRenderPipeline

    Inheritance
    Object
    UniversalRenderPipeline
    Namespace: UnityEngine.Rendering.Universal
    Syntax
    public sealed class UniversalRenderPipeline : RenderPipeline

    Constructors

    UniversalRenderPipeline(UniversalRenderPipelineAsset)

    Declaration
    public UniversalRenderPipeline(UniversalRenderPipelineAsset asset)
    Parameters
    Type Name Description
    UniversalRenderPipelineAsset asset

    Fields

    k_ShaderTagName

    Declaration
    public const string k_ShaderTagName = "UniversalPipeline"
    Field Value
    Type Description
    String

    Properties

    asset

    Returns the current render pipeline asset for the current quality setting. If no render pipeline asset is assigned in QualitySettings, then returns the one assigned in GraphicsSettings.

    Declaration
    public static UniversalRenderPipelineAsset asset { get; }
    Property Value
    Type Description
    UniversalRenderPipelineAsset

    maxPerObjectLights

    Declaration
    public static int maxPerObjectLights { get; }
    Property Value
    Type Description
    Int32

    maxRenderScale

    Declaration
    public static float maxRenderScale { get; }
    Property Value
    Type Description
    Single

    maxShadowBias

    Declaration
    public static float maxShadowBias { get; }
    Property Value
    Type Description
    Single

    maxVisibleAdditionalLights

    Declaration
    public static int maxVisibleAdditionalLights { get; }
    Property Value
    Type Description
    Int32

    minRenderScale

    Declaration
    public static float minRenderScale { get; }
    Property Value
    Type Description
    Single

    Methods

    Dispose(Boolean)

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    Boolean disposing

    IsGameCamera(Camera)

    Checks if a camera is a game camera.

    Declaration
    public static bool IsGameCamera(Camera camera)
    Parameters
    Type Name Description
    Camera camera

    Camera to check state from.

    Returns
    Type Description
    Boolean

    true if given camera is a game camera, false otherwise.

    IsStereoEnabled(Camera)

    Checks if a camera is rendering in stereo mode.

    Declaration
    public static bool IsStereoEnabled(Camera camera)
    Parameters
    Type Name Description
    Camera camera

    Camera to check state from.

    Returns
    Type Description
    Boolean

    Returns true if the given camera is rendering in stereo mode, false otherwise.

    Render(ScriptableRenderContext, Camera[])

    Declaration
    protected override void Render(ScriptableRenderContext renderContext, Camera[] cameras)
    Parameters
    Type Name Description
    ScriptableRenderContext renderContext
    Camera[] cameras

    RenderSingleCamera(ScriptableRenderContext, Camera)

    Standalone camera rendering. Use this to render procedural cameras. This method doesn't call BeginCameraRendering and EndCameraRendering callbacks.

    Declaration
    public static void RenderSingleCamera(ScriptableRenderContext context, Camera camera)
    Parameters
    Type Name Description
    ScriptableRenderContext context

    Render context used to record commands during execution.

    Camera camera

    Camera to render.

    Back to top
    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