docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class UniversalRenderer

    Default renderer for Universal RP. This renderer is supported on all Universal RP supported platforms. It uses a classic forward rendering strategy with per-object light culling.

    Inheritance
    object
    ScriptableRenderer
    UniversalRenderer
    Implements
    IDisposable
    Inherited Members
    ScriptableRenderer.SupportsCameraStackingType(CameraRenderType)
    ScriptableRenderer.SetCameraMatrices(CommandBuffer, ref CameraData, bool)
    ScriptableRenderer.cameraColorTargetHandle
    ScriptableRenderer.cameraDepthTargetHandle
    ScriptableRenderer.supportedRenderingFeatures
    ScriptableRenderer.unsupportedGraphicsDeviceTypes
    ScriptableRenderer.Dispose()
    ScriptableRenderer.ConfigureCameraTarget(RTHandle, RTHandle)
    ScriptableRenderer.Execute(ScriptableRenderContext, ref RenderingData)
    ScriptableRenderer.EnqueuePass(ScriptableRenderPass)
    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 UniversalRenderer : ScriptableRenderer, IDisposable

    Constructors

    Name Description
    UniversalRenderer(UniversalRendererData)

    Constructor for the Universal Renderer.

    Properties

    Name Description
    activeColorTexture

    Returns the current active color target texture. To be referenced at RenderGraph pass recording time, not in passes render functions.

    activeDepthTexture

    Returns the current active depth target texture. To be referenced at RenderGraph pass recording time, not in passes render functions.

    depthPrimingMode

    Property to control the depth priming behavior of the forward rendering path.

    isActiveTargetBackBuffer

    True if the current active target is the backbuffer. To be referenced at RenderGraph pass recording time, not in passes render functions.

    Methods

    Name Description
    CreateRenderGraphTexture(RenderGraph, RenderTextureDescriptor, string, bool, FilterMode, TextureWrapMode)

    Utility method to convert RenderTextureDescriptor to TextureHandle and create a RenderGraph texture

    Dispose(bool)

    Called by Dispose(). Override this function to clean up resources in your renderer. Be sure to call this base dispose in your overridden function to free resources allocated by the base.

    FinishRendering(CommandBuffer)

    Called upon finishing rendering the camera stack. You can release any resources created by the renderer here.

    Setup(ScriptableRenderContext, ref RenderingData)

    Configures the render passes that will execute for this renderer. This method is called per-camera every frame.

    SetupCullingParameters(ref ScriptableCullingParameters, ref CameraData)

    Override this method to configure the culling parameters for the renderer. You can use this to configure if lights should be culled per-object or the maximum shadow distance for example.

    SetupLights(ScriptableRenderContext, ref RenderingData)

    Override this method to implement the lighting setup for the renderer. You can use this to compute and upload light CBUFFER for example.

    SupportedCameraStackingTypes()

    This setting controls if the camera editor should display the camera stack category. If your renderer is not supporting stacking this one should return 0. For the UI to show the Camera Stack widget this must support CameraRenderType.Base. CameraRenderType

    In This Article
    Back to top
    Copyright © 2023 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)