Class ScriptableRenderer | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class ScriptableRenderer

    Inheritance
    System.Object
    ScriptableRenderer
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: UnityEngine.Experimental.Rendering.LightweightPipeline
    Syntax
    public sealed class ScriptableRenderer

    Constructors

    ScriptableRenderer(LightweightRenderPipelineAsset)

    Declaration
    public ScriptableRenderer(LightweightRenderPipelineAsset pipelineAsset)
    Parameters
    Type Name Description
    LightweightRenderPipelineAsset pipelineAsset

    Properties

    maxPerObjectAdditionalLights

    Declaration
    public int maxPerObjectAdditionalLights { get; }
    Property Value
    Type Description
    System.Int32

    maxVisibleAdditionalLights

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

    perObjectLightIndices

    Declaration
    public ComputeBuffer perObjectLightIndices { get; }
    Property Value
    Type Description
    ComputeBuffer

    postProcessingContext

    Declaration
    public PostProcessRenderContext postProcessingContext { get; }
    Property Value
    Type Description
    PostProcessRenderContext

    useStructuredBufferForLights

    Declaration
    public static bool useStructuredBufferForLights { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    Clear()

    Declaration
    public void Clear()

    CopyTexture(CommandBuffer, RenderTargetIdentifier, RenderTargetIdentifier, Material)

    Declaration
    public static void CopyTexture(CommandBuffer cmd, RenderTargetIdentifier source, RenderTargetIdentifier dest, Material material)
    Parameters
    Type Name Description
    CommandBuffer cmd
    RenderTargetIdentifier source
    RenderTargetIdentifier dest
    Material material

    CreateRenderTextureDescriptor(ref CameraData, Single)

    Declaration
    public static RenderTextureDescriptor CreateRenderTextureDescriptor(ref CameraData cameraData, float scaler = 1F)
    Parameters
    Type Name Description
    CameraData cameraData
    System.Single scaler
    Returns
    Type Description
    RenderTextureDescriptor

    Dispose()

    Declaration
    public void Dispose()

    EnqueuePass(ScriptableRenderPass)

    Declaration
    public void EnqueuePass(ScriptableRenderPass pass)
    Parameters
    Type Name Description
    ScriptableRenderPass pass

    Execute(ScriptableRenderContext, ref RenderingData)

    Declaration
    public void Execute(ScriptableRenderContext context, ref RenderingData renderingData)
    Parameters
    Type Name Description
    ScriptableRenderContext context
    RenderingData renderingData

    GetCameraClearFlag(Camera)

    Declaration
    public static ClearFlag GetCameraClearFlag(Camera camera)
    Parameters
    Type Name Description
    Camera camera
    Returns
    Type Description
    ClearFlag

    GetMaterial(MaterialHandle)

    Declaration
    public Material GetMaterial(MaterialHandle handle)
    Parameters
    Type Name Description
    MaterialHandle handle
    Returns
    Type Description
    Material

    GetRendererConfiguration(Int32)

    Declaration
    public static RendererConfiguration GetRendererConfiguration(int additionalLightsCount)
    Parameters
    Type Name Description
    System.Int32 additionalLightsCount
    Returns
    Type Description
    RendererConfiguration

    RenderFullscreenQuad(CommandBuffer, Material, MaterialPropertyBlock, Int32)

    Declaration
    public static void RenderFullscreenQuad(CommandBuffer cmd, Material material, MaterialPropertyBlock properties = null, int shaderPassId = 0)
    Parameters
    Type Name Description
    CommandBuffer cmd
    Material material
    MaterialPropertyBlock properties
    System.Int32 shaderPassId

    RenderObjectsWithError(ScriptableRenderContext, ref CullResults, Camera, FilterRenderersSettings, SortFlags)

    Declaration
    public void RenderObjectsWithError(ScriptableRenderContext context, ref CullResults cullResults, Camera camera, FilterRenderersSettings filterSettings, SortFlags sortFlags)
    Parameters
    Type Name Description
    ScriptableRenderContext context
    CullResults cullResults
    Camera camera
    FilterRenderersSettings filterSettings
    SortFlags sortFlags

    RenderPostProcess(CommandBuffer, ref CameraData, RenderTextureFormat, RenderTargetIdentifier, RenderTargetIdentifier, Boolean)

    Declaration
    public void RenderPostProcess(CommandBuffer cmd, ref CameraData cameraData, RenderTextureFormat colorFormat, RenderTargetIdentifier source, RenderTargetIdentifier dest, bool opaqueOnly)
    Parameters
    Type Name Description
    CommandBuffer cmd
    CameraData cameraData
    RenderTextureFormat colorFormat
    RenderTargetIdentifier source
    RenderTargetIdentifier dest
    System.Boolean opaqueOnly

    RequiresIntermediateColorTexture(ref CameraData, RenderTextureDescriptor)

    Declaration
    public static bool RequiresIntermediateColorTexture(ref CameraData cameraData, RenderTextureDescriptor baseDescriptor)
    Parameters
    Type Name Description
    CameraData cameraData
    RenderTextureDescriptor baseDescriptor
    Returns
    Type Description
    System.Boolean

    SetupPerObjectLightIndices(ref CullResults, ref LightData)

    Declaration
    public void SetupPerObjectLightIndices(ref CullResults cullResults, ref LightData lightData)
    Parameters
    Type Name Description
    CullResults cullResults
    LightData lightData
    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