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

    Class ShadowmapBase

    Inheritance
    System.Object
    ShadowmapBase
    ShadowAtlas
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ToString()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: UnityEngine.Experimental.Rendering
    Syntax
    public abstract class ShadowmapBase

    Constructors

    ShadowmapBase(ref ShadowmapBase.BaseInit)

    Declaration
    protected ShadowmapBase(ref ShadowmapBase.BaseInit initializer)
    Parameters
    Type Name Description
    ShadowmapBase.BaseInit initializer

    Fields

    m_ClearColor

    Declaration
    protected readonly Vector4 m_ClearColor
    Field Value
    Type Description
    Vector4

    m_CompSamplerState

    Declaration
    protected readonly ComparisonSamplerState m_CompSamplerState
    Field Value
    Type Description
    ComparisonSamplerState

    m_CullResults

    Declaration
    protected CullResults m_CullResults
    Field Value
    Type Description
    CullResults

    m_Height

    Declaration
    protected readonly uint m_Height
    Field Value
    Type Description
    System.UInt32

    m_HeightRcp

    Declaration
    protected readonly float m_HeightRcp
    Field Value
    Type Description
    System.Single

    m_MaxPayloadCount

    Declaration
    protected readonly uint m_MaxPayloadCount
    Field Value
    Type Description
    System.UInt32

    m_SamplerState

    Declaration
    protected readonly SamplerState m_SamplerState
    Field Value
    Type Description
    SamplerState

    m_ShadowmapBits

    Declaration
    protected readonly uint m_ShadowmapBits
    Field Value
    Type Description
    System.UInt32

    m_ShadowmapFormat

    Declaration
    protected readonly RenderTextureFormat m_ShadowmapFormat
    Field Value
    Type Description
    RenderTextureFormat

    m_ShadowSupport

    Declaration
    protected readonly ShadowmapBase.ShadowSupport m_ShadowSupport
    Field Value
    Type Description
    ShadowmapBase.ShadowSupport

    m_Slices

    Declaration
    protected readonly uint m_Slices
    Field Value
    Type Description
    System.UInt32

    m_Width

    Declaration
    protected readonly uint m_Width
    Field Value
    Type Description
    System.UInt32

    m_WidthRcp

    Declaration
    protected readonly float m_WidthRcp
    Field Value
    Type Description
    System.Single

    Properties

    height

    Declaration
    public uint height { get; }
    Property Value
    Type Description
    System.UInt32

    slices

    Declaration
    public uint slices { get; }
    Property Value
    Type Description
    System.UInt32

    width

    Declaration
    public uint width { get; }
    Property Value
    Type Description
    System.UInt32

    Methods

    Assign(CullResults)

    Declaration
    public void Assign(CullResults cullResults)
    Parameters
    Type Name Description
    CullResults cullResults

    CreateShadowmap()

    Declaration
    public abstract void CreateShadowmap()

    DisplayShadowMap(CommandBuffer, Material, Vector4, UInt32, Single, Single, Single, Single, Single, Single)

    Declaration
    public abstract void DisplayShadowMap(CommandBuffer cmd, Material debugMaterial, Vector4 scaleBias, uint slice, float screenX, float screenY, float screenSizeX, float screenSizeY, float minValue, float maxValue)
    Parameters
    Type Name Description
    CommandBuffer cmd
    Material debugMaterial
    Vector4 scaleBias
    System.UInt32 slice
    System.Single screenX
    System.Single screenY
    System.Single screenSizeX
    System.Single screenSizeY
    System.Single minValue
    System.Single maxValue

    Fill(ShadowContextStorage)

    Declaration
    public abstract void Fill(ShadowContextStorage cs)
    Parameters
    Type Name Description
    ShadowContextStorage cs

    GetMaxPayload()

    Declaration
    public uint GetMaxPayload()
    Returns
    Type Description
    System.UInt32

    IsNativeDepth()

    Declaration
    protected bool IsNativeDepth()
    Returns
    Type Description
    System.Boolean

    QueryShadowSupport()

    Declaration
    public ShadowmapBase.ShadowSupport QueryShadowSupport()
    Returns
    Type Description
    ShadowmapBase.ShadowSupport

    Register(GPUShadowType, ShadowRegistry)

    Declaration
    protected abstract void Register(GPUShadowType type, ShadowRegistry registry)
    Parameters
    Type Name Description
    GPUShadowType type
    ShadowRegistry registry

    Register(ShadowRegistry)

    Declaration
    public void Register(ShadowRegistry registry)
    Parameters
    Type Name Description
    ShadowRegistry registry

    Reserve(FrameId, Camera, Boolean, ref ShadowData, ShadowmapBase.ShadowRequest, UInt32, UInt32, ref VectorArray<ShadowData>, ref VectorArray<ShadowPayload>, List<VisibleLight>)

    Declaration
    public abstract bool Reserve(FrameId frameId, Camera camera, bool cameraRelativeRendering, ref ShadowData shadowData, ShadowmapBase.ShadowRequest sr, uint width, uint height, ref VectorArray<ShadowData> entries, ref VectorArray<ShadowPayload> payloads, List<VisibleLight> lights)
    Parameters
    Type Name Description
    FrameId frameId
    Camera camera
    System.Boolean cameraRelativeRendering
    ShadowData shadowData
    ShadowmapBase.ShadowRequest sr
    System.UInt32 width
    System.UInt32 height
    VectorArray<ShadowData> entries
    VectorArray<ShadowPayload> payloads
    System.Collections.Generic.List<VisibleLight> lights
    Returns
    Type Description
    System.Boolean

    Reserve(FrameId, Camera, Boolean, ref ShadowData, ShadowmapBase.ShadowRequest, UInt32[], UInt32[], ref VectorArray<ShadowData>, ref VectorArray<ShadowPayload>, List<VisibleLight>)

    Declaration
    public abstract bool Reserve(FrameId frameId, Camera camera, bool cameraRelativeRendering, ref ShadowData shadowData, ShadowmapBase.ShadowRequest sr, uint[] widths, uint[] heights, ref VectorArray<ShadowData> entries, ref VectorArray<ShadowPayload> payloads, List<VisibleLight> lights)
    Parameters
    Type Name Description
    FrameId frameId
    Camera camera
    System.Boolean cameraRelativeRendering
    ShadowData shadowData
    ShadowmapBase.ShadowRequest sr
    System.UInt32[] widths
    System.UInt32[] heights
    VectorArray<ShadowData> entries
    VectorArray<ShadowPayload> payloads
    System.Collections.Generic.List<VisibleLight> lights
    Returns
    Type Description
    System.Boolean

    ReserveFinalize(FrameId, ref VectorArray<ShadowData>, ref VectorArray<ShadowPayload>)

    Declaration
    public abstract bool ReserveFinalize(FrameId frameId, ref VectorArray<ShadowData> entries, ref VectorArray<ShadowPayload> payloads)
    Parameters
    Type Name Description
    FrameId frameId
    VectorArray<ShadowData> entries
    VectorArray<ShadowPayload> payloads
    Returns
    Type Description
    System.Boolean

    ReserveSlots(ShadowContextStorage)

    Declaration
    public abstract void ReserveSlots(ShadowContextStorage sc)
    Parameters
    Type Name Description
    ShadowContextStorage sc

    Update(FrameId, ScriptableRenderContext, CommandBuffer, CullResults, List<VisibleLight>)

    Declaration
    public abstract void Update(FrameId frameId, ScriptableRenderContext renderContext, CommandBuffer cmd, CullResults cullResults, List<VisibleLight> lights)
    Parameters
    Type Name Description
    FrameId frameId
    ScriptableRenderContext renderContext
    CommandBuffer cmd
    CullResults cullResults
    System.Collections.Generic.List<VisibleLight> lights
    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